Get zones definitions with criterias

post

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

Returns the list of zones and additionnal informations.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

agenciesIds

array of strings

Use this field to filter result on agencies. Only zones belonging to the specified agencies will be returned.

agenciesIds

assignedPersonId

string

Use this field to filter result on assigned person. Only zones assigned to the specified person will be returned.

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.

modificationEndDate

date-time

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

modificationStartDate

date-time

Use this field to filter result on modification date. Only zones 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 zones 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.

returnAssignmentInfo

boolean

Defaults to false

If true, the result will contain assignment information.

returnStudyInfo

boolean

Defaults to false

If true, the result will contain study information.

studyId

string

Use this field to filter result on a specific study.

subContractorId

string

Use this field to filter result on sub-contractor. Only zones belonging to the specified sub-contractor will be returned.

zoneIds

array of strings

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

zoneIds

Headers

UseHTTPCodeOnError

boolean

Defaults to false

Response

defaultResponse containing a list of zones