List addresses

post

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

Returns a list of addresses, 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

address

string

Use this field to filter on street address (using a contain operator)

addressType

string

enum

Use this field to filter on address type (exact match). Allowed values: DELIVERY, PICKUP, BOTH. An invalid value returns an INVALID_REQUEST error.

Allowed:

agencyId

string

Use this field to filter on agency (usefull if contractor feature is not enabled)

aroundPosition

boolean

Set it to true if you want to search around a specific position. In this case, you must also provide maxDistance, lat and lon.

building

string

Use this field to filter on building (using a contain operator)

city

string

Use this field to filter on city (using a contain operator)

company

string

Use this field to filter on company (using a contain operator)

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 restrict the result to the addresses of the specified contractor

designation

string

Use this field to filter on designation (using a contain operator)

district

string

Use this field to filter on district (using a contain operator)

string

Use this field to filter on email (using a contain operator)

externIds

array of strings

length between 0 and 1000

List of addresses' extern identifiers. If provided, all other filtering parameters are ignored. These identifier may not be unique: several contractors may have use the same identifier.

externIds

firstName

string

Use this field to filter on first name (using a contain operator)

floor

string

Use this field to filter on floor (using a contain operator)

lat

double

Latitude of the search center position

lon

double

Longitude of the search center position

maxDistance

int64

Maximum distance around lat and lon in meters

name

string

Use this field to filter on both last name and designation (using a contain operator)

office

string

Use this field to filter on office (using a contain operator)

pageSize

int32

1 to 10000

Defaults to 100

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

postCode

string

Use this field to filter on post code (using a contain operator)

Headers

CustomFieldRepresentation

string

enum

Allowed:

UseHTTPCodeOnError

boolean

Defaults to false

Response

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