Update an existing registered device with the App/Partner.
PUT ~/devices/:device-id
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. |
Parameters
Field | Type | Description |
---|---|---|
:device-id | String |
The hashed ID of the device you'd like to update. See Hashed Device IDs |
version | String |
The device version hash. See Device Version Hash |
nameoptional | String |
The name of the device |
refoptional | String |
The reference name or number associated with the device |
eventsoptional | String[] |
A list of Doshii events that the device is interested in. |
terminalsoptional | 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 |
channelsoptional | 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' |
locationIdsoptional | String[] |
A list of hashed location IDs that the device is interested in. See Hashed Location IDs |
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
Request
{
"locationIds": [
"M1GBZYme"
],
"name": "Reservations Device",
"channels": [
"Reservations"
],
"ref": "123-456-7",
"terminals": [],
"events": [
"booking_created",
"booking_updated"
],
"version": "n9dgjVZbV4SBn0Vj2Gz1C7jB83BeNAC8Ebnom3En"
}
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"
}
Comments
0 comments
Please sign in to leave a comment.