Get a booking

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/bookings/{booking_id}

Get information about a specific booking.

Responses

Response body

object

data

object

Booking structure.

booking_id

string

The unique ID of the booking.

customer_id

string

The unique ID of the customer that created the booking.

booking_items

array of objects

required

List of the booking items. Included in response of GET API call only if query parameter add_booking_items is true.

booking_items*

object

booking_item_id

string

The unique ID of the booking item.

customer_id

string

The unique ID of the customer.

time_slot_id

string

required

The unique ID of the booking time slot.

booking_ticket

object

Ticket of the booking item. Structure is filled only when query parameter add_booking_items has value full or items-only.

valid_from

string

Date and time when time slot starts. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Date and time when time slot ends. (YYYY-MM-DD HH:MM:SS)

capacity_taken

integer

Defaults to 1

How much capacity is taken by the booking item. If not set, value is 1.

booking_item_status

string

Current status of the booking item from resource booking-statuses. If not set, CareCloud uses default booking status.

additional_properties

array of objects

List of additional property records.

additional_properties

object

property_record_id

string

The unique ID of the property record.

property_id

string

required

The unique ID of the property.

property_name

string

Name of the property.

property_value

Value of the property.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

created_at

string

required

Date and time of the booking item. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the booking item record.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

booking_status

string

Current status of the booking from resource booking-statuses. If not set, CareCloud uses default booking status.

utm

object

UTM structure for data from email campaign.

data

Additional data of the booking. Serialized data in JSON.

created_at

string

required

Date and time of the booking. (YYYY-MM-DD HH:MM:SS)

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the booking record.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/bookings/booking_id \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
48
}
1
{
2
  "data": {
3
    "booking_id": "83d0ce2b5a1bc0dc8da01b13e7",
4
    "customer_id": "85bc5819e09dab95437552ce79",
5
    "booking_items": [
6
      {
7
        "booking_item_id": "8fd73167342d0689c4c015320",
8
        "customer_id": "8ea6abece4cd0a4ded0a29f093",
9
        "time_slot_id": "88bb88399cc74d81edbe19d684",
10
        "booking_ticket": {
11
          "ticket_id": "89d88719b8b442de2d11b401a2",
12
          "name": "Prophecy",
13
          "created_at": "2022-07-26 11:38:22",
14
          "valid_from": null,
15
          "valid_to": null,
16
          "state": 1,
17
          "last_change": "2022-09-16 16:14:41"
18
        },
19
        "valid_from": "2022-01-09 22:00:00",
20
        "valid_to": "2022-01-09 22:30:00",
21
        "capacity_taken": 2,
22
        "booking_item_status": "86e05affc7a7abefcd513ab400",
23
        "additional_properties": [
24
          {
25
            "property_record_id": "docasna_blokace_darce_do:8ea2591121e636086a4a9c0992",

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.