API Reference

Endpoint

POST /v1/trial-offers/appointments/booking/validate

Request Body application/json

required

Represents appointment booking request

customerId integer(int64) required

Unique ID of the customer

Example: 203

bookableAppointmentId integer(int64) required

Unique ID of the bookable appointment

Example: 20334

startDateTime string(date-time) required

Start date time of the bookable appointment slot

Example: "2022-06-22T08:00:00.000+02:00[Europe/Berlin]"

endDateTime string(date-time) required

End date time of the bookable appointment slot

Example: "2022-06-22T10:00:00.000+02:00[Europe/Berlin]"

instructorIds array[integer(int64)]

Instructor ID list of the bookable appointment slot

Responses

Response Body application/json

Appointment booking validation result

validationStatus required

Status of the booking validation

Allowed values:

`PAST_START_DATE_TIME`	The start date and time is in the past
`END_DATE_TIME_NOT_AFTER_START_DATE_TIME`	The end date and time is not after the start date and time
`PERIOD_DOES_NOT_MATCH`	The period from start date and time to end date and time does not match the main time of the bookable appointment
`CUSTOMER_IN_OTHER_BOOKING`	Customer has other bookings in this period
`CUSTOMER_IDLE`	Customer has an idle period during the time of the bookable appointment slot
`NO_CONTINGENT`	Customer doesn't have required contingent
`BOOKABLE_APPOINTMENT_RESTRICTIONS_NOT_FULFILLED`	The restriction(s) of the bookable appointment is/are not fulfilled
`BOOKING_LIMIT_REACHED`	Booking limit reached
`DATE_TIME_BEFORE_EARLIEST_BOOKING_DATE_TIME`	Date and time are before earliest possible booking date
`DATE_TIME_AFTER_LATEST_BOOKING_DATE_TIME`	Date and time are after latest possible booking date
`STUDIO_CLOSED`	Studio is closed during period
`RESOURCE_NOT_AVAILABLE`	(A) resource(s) is/are not available
`NOT_AVAILABLE`	Booking is not possible for other reasons
`AVAILABLE`	Booking is possible

Example: "RESOURCE_NOT_AVAILABLE"

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"