Skip to content

Get a list of all times that may be bookable via the web.

GET
/v1/WebBooking/AvailableTimes
curl --request GET \
  --url 'https://rms.dev.caspeco.net/api/booking/v1/WebBooking/AvailableTimes?includeUnavailability=false' \
  --header 'Authorization: Bearer <token>' \
  --header 'system: example'

A list of time rules, containing the times. Either parameters date or eventReference is required.

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
Array<string>
nullable

The dates to get webbooking times for. At least one date is required, unless eventReference is given. A separate permission is required in order to get more than one day at once, and this may be no more than 7 days in total.

eventReference
string
nullable

Get webbooking times for temporary rules (rules only valid a single day) with this event reference only. When using this parameter, date is optional.

unitId
Array<integer>
nullable

Get the times for these unit IDs only.

sectionId
Array<integer>
nullable

Get the times for these section IDs only.

tag
string
nullable

Only return times on rules that have this tag.

includeUnavailability
boolean

If to include unavailability reasons in the response

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
id
required
integer format: int64
name
required
string
>= 1 characters
sections
required
Array<object>
object
id
required
integer format: int64
name
required
string
>= 1 characters
hidden
required
boolean
sortOrder
required
integer format: int64
timeSets
required
Array<object>
object
id
required
integer format: int64
date
required
string format: date-time
>= 1 characters
title
required
string
>= 1 characters
conditions
required
string
>= 1 characters
paymentInformation
required
string
>= 1 characters
maximumConcurrentBookings
required
integer format: int32
maximumConcurrentSeats
required
integer format: int32
recoupTime
required
integer format: int32
isClosed
required
boolean
eventReference
string
nullable
tag
string
nullable
payment
required
integer
Allowed values: 0 1 2 3 4
paymentModifier
required
integer
Allowed values: 0 1 2 3
paymentAmount
required
number format: decimal
paymentVAT
required
number format: decimal
paymentCurrency
required
string
>= 1 characters
times
required
Array<object>
object
start
required
string format: date-time
>= 1 characters
end
required
string format: date-time
>= 1 characters
availableUntil
required
string format: date-time
>= 1 characters
availableSeats
required
Array<integer>
waitListSeats
Array<integer>
nullable
unavailability
Array<object>
nullable
object
from
integer format: int32
nullable
to
integer format: int32
nullable
reason
integer
Allowed values: 0 1 2 3 4 5 6 7
userType
required
integer
Allowed values: 0 1 2
minGroupSize
integer format: int32
nullable
maxGroupSize
integer format: int32
nullable
menuGuid
string
nullable
requireMenuSelection
required
boolean
requireMenuPayment
required
boolean
isTextRow
required
boolean
comment
required
string
>= 1 characters
bookingType
integer
Allowed values: 0 1 2 3
forceDeliveryInfo
boolean
lockTime
integer format: int32
lockPerTime
boolean
startTime
number format: double
sectionId
integer format: int64
description
required
string
>= 1 characters
image
required
string
>= 1 characters
timeZone
required
string
>= 1 characters
Example
{
  "application/json": [
    {
      "id": 827,
      "name": "Burger Prince",
      "sections": [
        {
          "id": 625,
          "name": "Outdoor",
          "hidden": false,
          "sortOrder": 0,
          "timeSets": [
            {
              "id": 926,
              "date": "0001-01-01T00:00:00",
              "title": "À La carte",
              "conditions": "A suprise band will be playing.",
              "maximumConcurrentBookings": 18,
              "maximumConcurrentSeats": 50,
              "recoupTime": 15,
              "isClosed": false,
              "eventReference": "AP75JDD9",
              "tag": "Club",
              "payment": 1,
              "paymentModifier": 2,
              "paymentAmount": 100,
              "paymentVAT": 0.12,
              "paymentCurrency": "SEK",
              "times": [
                {
                  "start": "2015-06-15T18:00:00",
                  "end": "2015-06-15T20:00:00",
                  "availableUntil": "2015-06-15T17:00:00",
                  "availableSeats": [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8
                  ]
                },
                {
                  "start": "2015-06-15T18:15:00",
                  "end": "2015-06-15T20:15:00",
                  "availableUntil": "2015-06-15T17:15:00",
                  "availableSeats": [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9,
                    10
                  ]
                },
                {
                  "start": "2015-06-15T18:30:00",
                  "end": "2015-06-15T20:30:00",
                  "availableUntil": "2015-06-15T17:15:00",
                  "availableSeats": [
                    1,
                    2
                  ]
                }
              ],
              "userType": 0,
              "requireMenuSelection": false,
              "requireMenuPayment": false,
              "isTextRow": false,
              "bookingType": 0,
              "forceDeliveryInfo": false,
              "lockTime": 0,
              "lockPerTime": false,
              "startTime": 0,
              "sectionId": 0
            }
          ],
          "description": "",
          "image": ""
        }
      ]
    }
  ]
}