Get Locations Health

Retrieves health information for all subscribed locations. It is recommended that this endpoint is accessed using the read-only endpoint.

GET ~/health/locations?since=,inverse=,sort=

Parameters

Field	Type	Description
sinceoptional	Integer	The date and time (seconds since Epoch) <= Location's last heartbeat. Eg. `1481979234`
inverseoptional	Boolean	Inverse the results to only show locations that haven't sent heartbeats, e.g. `true/false`. Default: false
sortoptional	String	Sort locations ascending: `asc` or descending: `desc` based on last heartbeat date. Default is `desc`.

Response

Field	Type	Description
locationId	String	Unique hashed id for the Location. See Hashed Location IDs
name	String	The name of the Location
heartbeat	String	The date and time in UTC of when Doshii last received a heartbeat from this location.
status	String	The current status of the location.
trading	Boolean	Indicates whether or not the location is currently trading, based on the defined operating hours. This property is omitted if no operating hours have been configured for the location.
locationTime	String	The local location date and time based on the location's timezone. This property is omitted if no timezone has been configured for the location.
locationUri	Uri	The uri to retrieve additional location details.

Examples

Response

HTTP/1.1 200 OK
[
  {
    "locationId":"xyDhd32v",
    "name":"Chicken's R Us",
    "heartbeat":"2019-07-25T00:57:43Z",
    "status": "active",
    "trading": true,
    "locationTime": "2019-07-25T10:57:43+10:00",
    "locationUri": "https://sandbox.doshii.co/partner/v3/locations/xyDhd32v"
  },
  {
    "locationId":"abc123YZ",
    "name":"Burger Time",
    "heartbeat":"2019-07-25T00:50:43Z",
    "status": "inactive",
    "trading": false,
    "locationUri": "https://sandbox.doshii.co/partner/v3/locations/abc123YZ"
  },
  {
    "locationId":"fr45H23l",
    "name":"Shop Around",
    "heartbeat":null,
    "status": "unregistered"
    "locationUri": "https://sandbox.doshii.co/partner/v3/locations/fr45H23l"
  }
]

Articles in this section

Parameters

Response

Examples

Response

Comments