List missions

post

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

Returns a list of missions, 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 result on agencies. Only missions of the specified agencies will be returned.

agenciesIds

assignedPersonId

string

Use this field to filter result on assigned person id (email).

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.

contractorId

string

Use this field to filter result on a specific contractor id.

missionIds

array of strings

length between 0 and 1000

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

missionIds

modificationEndDate

date-time

Use this field to filter result on modification date. Only mission with modification date lesser or equal will be returned.

modificationStartDate

date-time

Use this field to filter result on modification date. Only mission with modification date greater or equal will be returned

pageSize

int32

1 to 10000

Defaults to 100

Use this field limit the number of elements returned. The number of missions 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.

statuses

array of strings

length ≥ 0

Use this field to filter result status.

statuses

subContractorId

string

Use this field to filter result on sub-contractor identifier. Only routes assigned to this sub-contractor will be returned

Headers

CustomFieldRepresentation

string

enum

Allowed:

UseHTTPCodeOnError

boolean

Defaults to false

Response

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