Locations

Returns a list of Locations filtered by one or more {codes} ('m49', 'iso2' or 'iso3') separated by semi-column (;) or comma (,). This is MORE STRICT (all or none) version of the 2 versions of same endpoint

<br>Filtering options:

<br>* To filter Locations by ISO3 codes: in place of {codes} parameter, pass in comma (,) or semi-column (;) delimited list of ISO 3166-1 (alpha-3) codes
<br>* To filter Locations by ISO2 codes: in place of {codes} parameter, pass in comma (,) or semi-column (;) delimited list of ISO 3166-1 (alpha-2) codes
<br>* To filter Locations by numberical M49 codes: in place of {codes} parameter, pass in comma (,) or semi-column (;) delimited list of ISO 3166-1 (numerical M49) codes

<br>Note:

<br>* If one or more Location 'codes' do not exist in database, this version (more strict) of endpoint returns HTTP Status Code 404 - NotFound while it lists wrong codes in the Response body.
<br>Please use Version 2 of this endpoint (more relaxed) that returns data for all 'codes' that the macth is found for, while lists in 'X-DP-Validation' Response Header those that didn't match

get/api/v1/locations/{codes}

Request

Path parameters

codesstring required

'Codes' filter that must be either semi-column (;) or comma (,) delimited list of (1) ISO 3166-1 (alpha-3), (2) ISO 3166-1 (alpha-2) or (3) ISO 3166-1 (numerical M49). Delimiters and codes must not be mixed.

Query parameters

sortstring

Optional query string parameter - property name to sort by. If omitted parameter defaults to 'id' field sorted ASC. Use hyphen ('-') prefix (i.e. '-id') for DESC sort.

formatstring

Defines respose return format. Possible values are 'json' (default), 'xml' and 'csv'

Response

Returns a list of all Locations filtered by (1) ISO 3166-1 (alpha-3), (2) ISO 3166-1 (alpha-2) or (3) ISO 3166-1 (numerical M49) codes.

idinteger
namestring nullable
iso3string nullable
iso2string nullable
longitudenumber double nullable
latitudenumber double nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.