Skip to content

List web bookings.

GET
/v1/WebBooking/WebBookings
curl --request GET \
  --url 'https://rms.dev.caspeco.net/api/booking/v1/WebBooking/WebBookings?includeContact=false&includeInternalContact=false&includeTableArticles=false&includeNonTableArticles=false&includePayMethod=false&includeCustomer=false&includeMarkings=false' \
  --header 'Authorization: Bearer <token>' \
  --header 'system: example'

Returns a list of web bookings. It is required to either set both startTime and endTime, or changedFrom.

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”
startTime
string format: date-time
nullable

Return bookings that end after this time.

endTime
string format: date-time
nullable

Return bookings that start before this time.

changedFrom
string format: date-time
nullable

Return bookings that have been created or changed after this time.

unitId
Array<integer>
nullable

Get bookings for these units only.

articleCategoryId
Array<integer>
nullable

Get only bookings that contains articles with these articleCategory IDs. Requires that we include articles in the bookings.

includeContact
boolean

If the associated contact should be included for each booking, not included by default.

includeInternalContact
boolean
includeTableArticles
boolean

If the table articles should be included for each booking, not included by default.

includeNonTableArticles
boolean

If the non-table articles should be included for each booking, not included by default.

includePayMethod
boolean

If the payMethod should be included for each booking, not included by default.

includeCustomer
boolean

If the associated customer should be included for each booking, not included by default.

includeMarkings
boolean

If set booking markings should be included for each booking, not included by default.

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
guid
string
globalBookingNumber
string
unitId
integer format: int64
start
string format: date-time
end
string format: date-time
status
integer
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 9999 -1
subStatus
integer
Allowed values: 0 1 2 3 4 5 6 7
history
Array<object>
nullable
object
changeDate
string format: date-time
nullable
status
integer
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 9999 -1
statusName
string
guests
integer format: int32
guestsChildren
integer format: int32
message
string
createdDate
string format: date-time
nullable
changeDate
string format: date-time
nullable
recoupTime
integer format: int32
articles
Array<object>
object
articleId
integer format: int64
bookedArticleId
integer format: int64
bookedArticleParentId
integer format: int64
sectionId
integer format: int64
articleGroupId
integer format: int64
articleGroupName
string
nullable
articleGroupType
integer
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
unitId
integer format: int64
departmentId
string
nullable
start
string format: date-time
end
string format: date-time
name
string
nullable
tableName
string
nullable
tableNumber
string
nullable
tableChairs
integer format: int32
message
string
nullable
quantity
number format: decimal
isTable
boolean
outPriceIncVat
number format: decimal
vat
number format: decimal
menuGuid
string
nullable
webFlags
integer
Allowed values: 0 1 2 3
priceModel
integer format: int32
outAmountExVat
number format: decimal
outAmountInclVat
number format: decimal
ruleId
integer format: int64
nullable
nonTableArticles
Array<object>
object
articleId
integer format: int64
bookedArticleId
integer format: int64
bookedArticleParentId
integer format: int64
sectionId
integer format: int64
articleGroupId
integer format: int64
articleGroupName
string
nullable
articleGroupType
integer
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
unitId
integer format: int64
departmentId
string
nullable
start
string format: date-time
end
string format: date-time
name
string
nullable
tableName
string
nullable
tableNumber
string
nullable
tableChairs
integer format: int32
message
string
nullable
quantity
number format: decimal
isTable
boolean
outPriceIncVat
number format: decimal
vat
number format: decimal
menuGuid
string
nullable
webFlags
integer
Allowed values: 0 1 2 3
priceModel
integer format: int32
outAmountExVat
number format: decimal
outAmountInclVat
number format: decimal
ruleId
integer format: int64
nullable
chargeType
integer
Allowed values: 0 1 2 3 4 5
chargeId
string
nullable
chargeShouldPayAmount
number format: decimal
chargeShouldPayVat
number format: decimal
chargeStatus
integer
Allowed values: 0 102 103 113 114 115 116
chargeShouldPayAmountVat
number format: decimal
chargeAuthorizedAmount
number format: decimal
chargePayedAmount
number format: decimal
chargeRefundedAmount
number format: decimal
customerFriendlyId
string
nullable
contact
One of:
object
returning
boolean
id
integer format: int64
fname
string
lname
string
phone
string
mobile
string
fax
string
email
string
streetaddress
string
zipcode
string
city
string
newsletter
boolean
lastGrab
boolean
allowStoringForever
boolean
deliveryInfo
string
customer
One of:
object
id
integer format: int64
name
string
streetaddress
string
zipcode
string
city
string
orgNr
string
phone
string
fax
string
email
string
information
string
invoiceStreetaddress
string
invoiceZipCode
string
invoiceCity
string
invoiceCode1
string
invoiceCode2
string
invoiceCode3
string
customerNumber
string
accountManager
string
webpage
string
lastChangedUtc
string format: date-time
lastChangedBy
string
agreementLevel
integer format: int32
payMethod
One of:
object
id
integer format: int64
name
string
nullable
hidden
boolean
changeStatus
integer
Allowed values: 0 1 2 3
arrangementName
string
nullable
eventTag
string
nullable
menus
Array<object>
nullable
object
name
string
nullable
publicId
string
nullable
groups
Array<object>
nullable
object
groupType
integer
Allowed values: 0 1 2 3 4 5 6 7 8
name
string
nullable
choices
integer format: int32
items
Array<object>
nullable
object
name
string
nullable
description
string
nullable
articleID
integer format: int32
quantity
integer format: int32
price
number format: decimal
vatPercent
number format: decimal
nullable
time
string format: date-time
nullable
webFlags
integer
Allowed values: 0 1 2
inactivatedUntil
string format: date-time
sortOrder
integer format: int32
optional
boolean
isCollapsed
boolean
status
integer
Allowed values: 0 1 2
message
string
nullable
chargeType
integer
Allowed values: 0 1 2 3 4 5
elevatedRespond
boolean
disableAllConfirmationMessages
boolean
markings
Array<object>
nullable
object
text
string
nullable
prefix
string
nullable
hidden
boolean
longBookingNumber
string
nullable
terminalReturnUrl
string
nullable
language
string
nullable
cancelAllowedBeforeUtc
string format: date-time
nullable
bookingFlags
integer
Allowed values: 0 1 2 4 8 16 32 64
chargePaymentLinkExpirationDate
string format: date-time
nullable
internalContactName
string
nullable
feedbackDate
string format: date-time
nullable
validUntil
string format: date-time
nullable
webBookingRules
Array<object>
nullable
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
waitListOffers
Array<object>
nullable
object
startTime
string format: date-time
offerStatus
integer
Allowed values: 0 1
paymentEvents
Array<object>
object
id
integer format: int64
paymentEventRootId
integer format: int64
nullable
bookingRootId
integer format: int64
bookingVersionId
integer format: int64
type
integer
Allowed values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
requestedAmount
number format: decimal
payedAmount
number format: decimal
message
string
nullable
invoiceInformationId
integer format: int64
nullable
chargeRootId
integer format: int64
nullable
payMethodId
integer format: int64
nullable
isCredit
boolean
creditAffectsId
integer format: int64
nullable
createdDate
string format: date-time
createdBy
string
nullable
changedDate
string format: date-time
changedBy
string
nullable
changeMessage
string
nullable
transactionDate
string format: date-time
nullable
subPaymentEvents
Array<object> recursive
inquiryValues
One of:
object
originalStart
string format: date-time
proposedStart
string format: date-time
originalActivities
Array<object>
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
proposedActivities
Array<object>
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
Example
{
  "application/json": [
    {
      "guid": "900A1595-354F-4F3C-BCA6-797EB90796BF",
      "globalBookingNumber": "X7GW",
      "unitId": 827,
      "start": "2015-06-15T18:00:00",
      "end": "2015-06-15T20:00:00",
      "status": 102,
      "subStatus": 0,
      "statusName": "confirmed",
      "guests": 4,
      "guestsChildren": 2,
      "message": "The children will use normal chairs",
      "createdDate": "2015-05-24T16:34:29",
      "changeDate": "2015-05-24T16:34:29",
      "recoupTime": 15,
      "articles": [
        {
          "articleId": 82735,
          "bookedArticleId": 0,
          "bookedArticleParentId": 0,
          "sectionId": 0,
          "articleGroupId": 726,
          "articleGroupName": "Outside",
          "articleGroupType": 0,
          "unitId": 827,
          "departmentId": "1,2,3",
          "start": "2015-06-15T18:00:00",
          "end": "2015-06-15T20:00:00",
          "name": "Table 10",
          "tableName": "10",
          "tableNumber": "10",
          "tableChairs": 2,
          "message": "",
          "quantity": 0,
          "isTable": true,
          "outPriceIncVat": 0,
          "vat": 0,
          "webFlags": 0,
          "priceModel": 0,
          "outAmountExVat": 0,
          "outAmountInclVat": 0
        },
        {
          "articleId": 82736,
          "bookedArticleId": 0,
          "bookedArticleParentId": 0,
          "sectionId": 0,
          "articleGroupId": 726,
          "articleGroupName": "Outside",
          "articleGroupType": 0,
          "unitId": 827,
          "departmentId": "1,2,3",
          "start": "2015-06-15T18:00:00",
          "end": "2015-06-15T20:00:00",
          "name": "Table 11",
          "tableName": "11",
          "tableNumber": "11",
          "tableChairs": 2,
          "message": "",
          "quantity": 0,
          "isTable": true,
          "outPriceIncVat": 0,
          "vat": 0,
          "webFlags": 0,
          "priceModel": 0,
          "outAmountExVat": 0,
          "outAmountInclVat": 0
        }
      ],
      "nonTableArticles": [
        {
          "articleId": 82735,
          "bookedArticleId": 0,
          "bookedArticleParentId": 0,
          "sectionId": 0,
          "articleGroupId": 726,
          "articleGroupName": "À la carte",
          "articleGroupType": 0,
          "unitId": 827,
          "departmentId": "1,2,3",
          "start": "2015-06-15T18:00:00",
          "end": "2015-06-15T20:00:00",
          "name": "Pasta Carbonara",
          "tableChairs": 0,
          "message": "Contains milk",
          "quantity": 4,
          "isTable": false,
          "outPriceIncVat": 0,
          "vat": 0,
          "webFlags": 0,
          "priceModel": 0,
          "outAmountExVat": 0,
          "outAmountInclVat": 0
        }
      ],
      "chargeType": 0,
      "chargeId": "7263523",
      "chargeShouldPayAmount": 120,
      "chargeShouldPayVat": 0.2,
      "chargeStatus": 0,
      "chargeShouldPayAmountVat": 100,
      "chargeAuthorizedAmount": 120,
      "chargePayedAmount": 120,
      "chargeRefundedAmount": 0,
      "contact": {
        "returning": false,
        "id": 0,
        "fname": "John",
        "lname": "Doe",
        "phone": "",
        "mobile": "+46731234567",
        "fax": "",
        "email": "john.doe@mail.com",
        "streetaddress": "Main Street 1",
        "zipcode": "12345",
        "city": "Uppsala",
        "newsletter": false,
        "lastGrab": false,
        "allowStoringForever": true,
        "deliveryInfo": ""
      },
      "customer": {
        "id": 0,
        "name": "John Doe Heavy Industries",
        "streetaddress": "Main Street 1",
        "zipcode": "12345",
        "city": "Uppsala",
        "orgNr": "556994-9927",
        "phone": "+46731234567",
        "fax": "",
        "email": "john.doe@mail.com",
        "information": "Always wants to pay double",
        "invoiceStreetaddress": "Main Street 1",
        "invoiceZipCode": "56789",
        "invoiceCity": "Uppsala",
        "invoiceCode1": "",
        "invoiceCode2": "",
        "invoiceCode3": "",
        "customerNumber": "",
        "accountManager": "",
        "webpage": "",
        "lastChangedUtc": "1753-01-01T00:00:00",
        "lastChangedBy": "",
        "agreementLevel": 0
      },
      "payMethod": {
        "id": 2,
        "name": "Invoice",
        "hidden": false,
        "changeStatus": 0
      },
      "arrangementName": "Bachelor Party for Steve",
      "markings": [
        {
          "text": "VIP",
          "prefix": "V",
          "hidden": false
        }
      ],
      "bookingFlags": 0,
      "paymentEvents": []
    }
  ]
}