Skip to content

List tables grouped by units and sections along with their bookings that overlaps the specified date

GET
/v1/booking/checkout/units
curl --request GET \
  --url https://rms.dev.caspeco.net/api/booking/v1/booking/checkout/units \
  --header 'Authorization: Bearer <token>' \
  --header 'system: example'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
system
required
string

The system name / database to query

Query Parameters

Section titled “Query Parameters”
date
string format: date-time

Include bookings overlaping this date. Also used to find correct tableLayoutRule

unitIds
Array<integer>
nullable

Filter tables by unit

sectionIds
Array<integer>
nullable

Filter tables by section

tableLayoutTemplateName
string
nullable

Specify name of TableLayoutTemplate, overrides the date match of tableLayoutRule

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<object>
object
name
string
nullable
number
string
nullable
id
integer format: int64
checkoutSections
Array
nullable
object
name
string
nullable
unitId
integer format: int64
hidden
boolean
id
integer format: int64
sortOrder
integer format: int64
image
string
nullable
description
string
nullable
uploadImage
One of:
object
tags
Array<string>
nullable
cropRatios
Array<object>
nullable
object
id
integer format: int64
nullable
imageId
integer format: int64
nullable
left
number format: double
top
number format: double
width
number format: double
height
number format: double
aspectRatio
string
image
string
imageUrl
string
imageFilename
string
imageUploadData
string
changeStatus
integer
Allowed values: 0 1 2 3
checkoutTables
Array<object>
nullable
object
id
integer format: int64
tableName
string
nullable
tableNumber
integer format: int32
tableChairs
integer format: int32
unitId
integer format: int32
sectionId
integer format: int32
tables
string
nullable
itemType
integer format: int32
guestsMin
integer format: int32
templateId
integer format: int64
validFrom
string format: date-time
positionX
integer format: int32
positionY
integer format: int32
sizeX
integer format: int32
sizeY
integer format: int32
articleId
integer format: int64
articleName
string
nullable
articleGroupId
integer format: int64
sortOrder
integer format: int32
departmentId
string
nullable
sectionName
string
nullable
articleGroupName
string
nullable
articleGroupSortOrder
integer format: int64
articleGroupType
integer
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
nonTableLayouts
Array<object>
nullable
object
id
integer format: int64
tableName
string
nullable
tableNumber
integer format: int32
tableChairs
integer format: int32
unitId
integer format: int32
sectionId
integer format: int32
tables
string
nullable
itemType
integer format: int32
guestsMin
integer format: int32
templateId
integer format: int64
validFrom
string format: date-time
positionX
integer format: int32
positionY
integer format: int32
sizeX
integer format: int32
sizeY
integer format: int32
articleId
integer format: int64
articleName
string
nullable
articleGroupId
integer format: int64
sortOrder
integer format: int32
departmentId
string
nullable
sectionName
string
nullable
articleGroupName
string
nullable
articleGroupSortOrder
integer format: int64
articleGroupType
integer
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Example
[
  {
    "checkoutSections": [
      {
        "changeStatus": 0,
        "checkoutTables": [
          {
            "articleGroupType": 0
          }
        ]
      }
    ],
    "nonTableLayouts": [
      {
        "articleGroupType": 0
      }
    ]
  }
]