API Reference

Endpoint

GET /v1/appointments/booking/{bookingId}

Path Parameters

bookingId required integer (int64)

Id of the appointment booking

Responses

Response Body application/json

Represents successful booking, which contains an additional customer id

bookingId integer(int64) required

Unique ID of the appointment booking

Example: 2033

bookingStatus required

Status of the appointment booking

Allowed values:

`BOOKED`	Customer is successfully booked
`BOOKED_WITH_CONFIRMATION_REQUIRED`	Customer booking is successful, but confirmation is required
`CANCELED`	Customer booking is canceled

Example: "BOOKED"

startDateTime string(date-time) required

Start date and time of the appointment booking

endDateTime string(date-time) required

End date and time of the appointment booking

title

Title of the appointment booking

Example: "Mission Beach body"

duration integer(int32)

Duration of the appointment booking in minutes

Example: 45

category

Category of the appointment booking

Example: "Fitness"

description

Description of the appointment booking

Example: "Get your body ready for beaches"

imgUrl

Image URL assigned to display this appointment booking

instructors array[object]

Instructors list of the appointment booking

id integer(int64) required

Unique ID of the instructor

Example: 101

firstName required

Instructor's first name

Example: "Anna"

lastName required

Instructor's last name

Example: "Chodakowska"

publicName

Public name that should be shown to customers

Example: "Peter2000"

appointmentStatus required

The status of an appointment

Allowed values:

`PLANNED`	The appointment is planned.
`CANCELED`	The appointment is canceled.
`COMPLETED`	The appointment is completed.

Example: "COMPLETED"

participantStatus required

The status of a participant

Allowed values:

`PARTICIPATING`	The customer is participating.
`NOT_PARTICIPATING`	The customer is not participating.
`UNSET`	The participation status is not set.

Example: "PARTICIPATING"

customerId integer(int64) required

Unique ID of the customer

Example: 1234

Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST

reference

Reference to validation error

Example: "parent.child"

Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"