Articles in this section

Get Devices

Avatar
John Twomey
  • Updated
Follow

Retrieve all registered devices associated with the App/Partner

GET ~/devices

Headers

Field Type Description
Accept-Encodingoptional String

Using compression on the response may improve the response times of this endpoint. Using this header will indicate to Doshii that the JSON response should be compressed (e.g. Accept-Encoding: gzip)

Response

Field Type Description
doshiiId String

Unique hashed id for this device. See Hashed Device IDs
name String

The name of the device
ref String

The reference name or number associated with the device
events String[]

A list of Doshii events that the device is interested in.
terminals String[]

A list of POS terminals that the device is interested in. The list should contain the unique hashed ID of the relevant POS terminals. See Hashed Terminals IDs
channels String[]

A list of Doshii service channels that the device is interested in. The current channels supported are: 'Pay@Table', 'Order ahead', 'Reservations', 'Loyalty', 'PIP', 'MAR', 'Resources', 'GiftCards'
locationIds String[]

A list of hashed location IDs that the device is interested in. See Hashed Location IDs
version String

An obfuscated string representation of the version
updatedAt Date

Date when the device was last updated
createdAt Date

Date when the device was created

Example

Response

[
    {
        "locationIds": [
            "M1GBZYme"
        ],
        "name": "Reservations Device",
        "updatedAt": "2019-02-08T04:58:30.155Z",
        "channels": [
            "Reservations"
        ],
        "ref": "123-456-7",
        "terminals": [],
        "version": "MQgLbmROmqhL2axJbG40IorpzkJo6KHlGrxd4Q91",
        "events": [
            "booking_created",
            "booking_updated"
        ],
        "createdAt": "2019-02-08T04:58:30.155Z",
        "doshiiId": "rj7DnGBL"
    },
    {
        "locationIds": [
            "M1GBZYme"
        ],
        "name": "PIP Device",
        "updatedAt": "2019-02-08T03:00:53.578Z",
        "channels": [
            "PIP",
            "Order ahead"
        ],
        "ref": "123-456-7",
        "terminals": [],
        "version": "MQgLbmROmqhL2axJbG40IoLwoqNqybtKqQg7WwpO",
        "events": [],
        "createdAt": "2019-02-08T03:00:53.578Z",
        "doshiiId": "L8PdMRML"
    }
] 

Related articles

Comments

0 comments

Please sign in to leave a comment.