List contractors

post

https://api.geoconcept.com/delivery/api/nd/missions/listContractors

Returns a list of contractors, depending on the filtering conditions specified, with a pagination process.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload used to specify the filtering informations

agenciesIds

array of strings

length ≥ 0

Use this field to filter results on agencies. Only contractors attached to the specified agencies will be returned.

agenciesIds

city

string

Use this field to filer results on city. Case sensitive.

continuationToken

string

If filtered elements number is greater than specified page size, use this field to get the next page of data. The continuation token is returned by the previous request. Filtering parameters must be the same between two requests so that the continuation token can be used.

contractorIds

array of strings

length between 0 and 1000

List of contractor identifiers. If provided, all other filtering parameters are ignored.

contractorIds

pageSize

int32

1 to 10000

Defaults to 100

Use this field limit the number of elements returned. The number of contractors actually returned can be greater than specified page size due to underlying database paging process. To get all the data corresponding to your filters, you should keep calling the request while response contains a continuation token.

postalCode

string

Use this field to filer results on postal code.

Headers

CustomFieldRepresentation

string

enum

Allowed:

UseHTTPCodeOnError

boolean

Defaults to false

Response

defaultResponse containing a list of contractors and a continuation token if needed