Get table details and associated checkins if any
GET ~/tables/:table-name
Headers
| Field | Type | Description |
|---|---|---|
| doshii-location-id | String |
The hashed ID of the location you're targeting. See Hashed Location IDs |
Parameters
| Field | Type | Description |
|---|---|---|
| :table-name | String |
The name of the table you'd like to retrieve |
Response
| Field | Type | Description |
|---|---|---|
| name | String |
The name of the Table |
| maxCovers | Integer |
Seating capacity |
| isActive | Boolean |
Table status if it is on or off service |
| criteria | Object |
Table properties if any |
| isCommunal | Boolean |
Unrelated checkins can simultaneously be seated at this table |
| canMerge | Boolean |
Can be be combined with other tables for larger seating capacity |
| isSmoking | Boolean |
Is in smoking area |
| isOutdoor | Boolean |
Exists in an outdoor setting (terrace, balcony, etc...) |
| updatedAt | String |
Date when the record is last updated |
| createdAt | String |
Date when the record is created |
| uri | String |
The object details url |
Examples
Response
{
"name": "table1",
"maxCovers": 4,
"isActive": true,
"criteria":{
"canMerge": true,
"isCommunal": true,
"isSmoking": false,
"isOutdoor": false
},
"updatedAt": "2016-08-18T04:58:38.485Z",
"createdAt": "2016-08-18T04:58:38.485Z",
"uri": "https://sandbox.doshii.co/partner/v3/tables/table1"
}
Comments
0 comments
Please sign in to leave a comment.