Fleet Management API Beta

Sections

Theme switcher

Get site by ID

Header Parameters

Authorizationstring

Path Parameters

site-idstring Required

The unique identifier for a site record. Varies by source.

Min length
1

Response

200
Object

200 (Ok)

Response Attributes

_linksobject

HATEOAS links related to the site.

Show child attributes

account_idstring

The ID of the account (customer) that owns, and has provided, the depot location record. Null on non-depot locations.

brandstring
charging_when_closedboolean
directionsarray

Human readable instructions on how to reach the charging location.

Show child attributes

distancenumber

(Optional) The distance from the search coordinates to the site (if provided)

energy_mixobject

Show child attributes

evsesarray

The list of Electric Vehicle Supply Equipment (EVSE) units, colloquially chargers, available at this charging location.

Show child attributes

facilitiesarray

An optional list of facilities available at this charging location.

Enum values:
AIRPORTBUS_STOPCAFECARPOOL_PARKINGFUEL_STATIONHOTELMALLMUSEUMNATURERECREATION_AREA
... 10 other enums

Show child attributes

featuresarray

Show child attributes

fuel_typesarray

Show child attributes

hotlineobject

Show child attributes

hoursarray

Show child attributes

imagesarray

Images related to the charging location, such as brand logos or charger pictures.

Show child attributes

last_updatedstring
locationobject

Location object for sites

Show child attributes

merchant_namestring
namestring

The display name of the charging location.

opening_timesobject

Show child attributes

operatorobject

Show child attributes

ownerobject

Show child attributes

party_idstring
phone_numberstring
related_locationsarray

Locations that may be somehow related or pertinent to this charging location.

Show child attributes

site_idstring

The unique identifier for the site

site_namestring
site_typestring
statusstring
Enum values:
ACTIVEINACTIVE
suboperatorobject

Show child attributes

typestring
Enum values:
ON_STREETOTHERPARKING_GARAGEPARKING_LOTUNDERGROUND_GARAGEUNKNOWN
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
404
Object

404 (Not Found)

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?