Locations

Returns a list of all Locations with Aggregates sorted by 'sort' query string parameter in a format defined by 'format' parameter ('json' | 'xml' | 'csv').

Changed on

<br>Returns a list of all Locations with Aggregates sorted by 'sort' query string parameter in a format defined by 'format' parameter ('json' | 'xml' | 'csv').

get/api/v1/locationsWithAggregates

Request

Query parameters

pageNumberinteger

Current response page number

pageSizeinteger

Page size of the request (defaults to 100, maximum 100)

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.

pagingInHeaderboolean
formatstring

Optional query string parameter - allowed response format. If omitted parameter defaults to 'json'. Supported values for this endpoint are 'json', 'xml' and 'csv'.

Response

Returns list of all Locations.

unknown required

Changes