API explorer
Fleet Management API Beta

Sections

Theme switcher

Find sites by ODATA

Authentication

Bearer Token

Standard HTTP Bearer token. Enter the 'access_token' value.

TokenstringRequired

Header Parameters

Authorizationstring

This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.

Access Tokens have a lifespan of 15 minutes.

Requesting an access token

Parameters:

  • client_id = my-client-id
  • client_secret = my-client-secret
  • [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...

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:
MIKM
account_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

anyOfanyof

Wrapper for a custom JSON representation of a site. The complete set of site fields is defined in SiteListResponse. The actual response uses ListResponse, which contains a JSON with fields determined by the ODATA $select query parameter.

Any Of:

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?

GET

/

Select
1

Response

Was this section helpful?