Find sites by ODATA
Header Parameters
Authorizationstring
Query Parameters
distance_unit_of_measurestring
The unit of measure to use when calculating the distance parameter. Accepted values are mi or km. Defaults to mi (miles).
Default value
KM
Enum values:
MIKMaccount_idstring
allows depot sites to be included for a specific account
$filterstring
An OData-formatted $filter query string
$orderbystring
An OData-formatted $orderby string (the sort order)
$skipstring
An OData-formatted $skip string (the page offset)
Default value
0
$topstring
An OData formatted $top string (number of records to return per page)
Default value
25
$selectstring
An OData-formatted $select string (the fields to return)
Response
200
Object
A list of sites
Response Attributes
itemsarray
Show child attributes
nextobject
Show child attributes
notestring
Warning or informational note about the response if any.
prevobject
Show child attributes
total_countinteger
Total number of items.
400
Object
400 (Bad Request)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object
401 (Unauthorized)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object
403 (Forbidden)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object
500 (Internal Server Error)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?
Response
Was this section helpful?