Booking API: Events

Retrieve one specific event

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

eventstring · uuidRequired

Responses

200

OK

application/jsontext/json

achievementIdstring · uuid · nullableOptional

eventIdstring · uuidOptional

learnerRegistrationGroupIdstring · uuid · nullableOptional

mandatorySurveyFormIdstring · uuid · nullableOptional

organizationIdstring · uuidOptional

venueCoordinatorIdstring · uuid · nullableOptional

venueLocationIdstring · uuid · nullableOptional

venueOfficeIdstring · uuid · nullableOptional

allowMultipleRegistrationsbooleanOptional

allowRegistrationWithLinkboolean · nullableOptional

billingCodeEnabledbooleanOptional

integrationWithholdDistributionbooleanOptional

integrationWithholdGradesbooleanOptional

personCodeIsRequiredbooleanOptional

waitlistEnabledbooleanOptional

appointmentTypestring · nullableOptional

contentstring · nullableOptional

distributionCodestring · nullableOptional

distributionErrorsstring · nullableOptional

distributionProcessstring · nullableOptional

distributionStatusstring · nullableOptional

durationUnitstring · nullableOptional

eventBillingTypestring · nullableOptional

eventCalendarColorstring · nullableOptional

eventClassCodestring · nullableOptional

eventDescriptionstring · nullableOptional

eventFormatstring · nullableOptional

eventPublicationStatusstring · nullableOptional

eventRequisitionStatusstring · nullableOptional

eventSchedulingStatusstring · nullableOptional

eventSourcestring · nullableOptional

eventSummarystring · nullableOptional

eventTitlestring · nullableOptional

eventTypestring · nullableOptional

examMaterialReturnShipmentCodestring · nullableOptional

examMaterialReturnShipmentConditionstring · nullableOptional

examTypestring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

publicationErrorsstring · nullableOptional

registrationFieldsstring · nullableOptional

venueRoomstring · nullableOptional

capacityMaximuminteger · int32 · nullableOptional

capacityMinimuminteger · int32 · nullableOptional

durationQuantityinteger · int32 · nullableOptional

eventNumberinteger · int32Optional

examDurationInMinutesinteger · int32 · nullableOptional

invigilatorMinimuminteger · int32 · nullableOptional

creditHoursnumber · double · nullableOptional

distributionExpectedstring · date-time · nullableOptional

distributionOrderedstring · date-time · nullableOptional

distributionShippedstring · date-time · nullableOptional

distributionTrackedstring · date-time · nullableOptional

eventScheduledEndstring · date-time · nullableOptional

eventScheduledStartstring · date-timeOptional

examMaterialReturnShipmentReceivedstring · date-time · nullableOptional

examStartedstring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

registrationDeadlinestring · date-time · nullableOptional

registrationLockedstring · date-time · nullableOptional

registrationStartstring · date-time · nullableOptional

get

/api/booking/events/{event}

HTTPcURLJavaScriptPython

GET /v2/e01/api/booking/events/{event} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "eventId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerRegistrationGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "mandatorySurveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueCoordinatorId": "123e4567-e89b-12d3-a456-426614174000",
  "venueLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueOfficeId": "123e4567-e89b-12d3-a456-426614174000",
  "allowMultipleRegistrations": true,
  "allowRegistrationWithLink": true,
  "billingCodeEnabled": true,
  "integrationWithholdDistribution": true,
  "integrationWithholdGrades": true,
  "personCodeIsRequired": true,
  "waitlistEnabled": true,
  "appointmentType": "text",
  "content": "text",
  "distributionCode": "text",
  "distributionErrors": "text",
  "distributionProcess": "text",
  "distributionStatus": "text",
  "durationUnit": "text",
  "eventBillingType": "text",
  "eventCalendarColor": "text",
  "eventClassCode": "text",
  "eventDescription": "text",
  "eventFormat": "text",
  "eventPublicationStatus": "text",
  "eventRequisitionStatus": "text",
  "eventSchedulingStatus": "text",
  "eventSource": "text",
  "eventSummary": "text",
  "eventTitle": "text",
  "eventType": "text",
  "examMaterialReturnShipmentCode": "text",
  "examMaterialReturnShipmentCondition": "text",
  "examType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "publicationErrors": "text",
  "registrationFields": "text",
  "venueRoom": "text",
  "capacityMaximum": 1,
  "capacityMinimum": 1,
  "durationQuantity": 1,
  "eventNumber": 1,
  "examDurationInMinutes": 1,
  "invigilatorMinimum": 1,
  "creditHours": 1,
  "distributionExpected": "2026-03-16T00:57:57.217Z",
  "distributionOrdered": "2026-03-16T00:57:57.217Z",
  "distributionShipped": "2026-03-16T00:57:57.217Z",
  "distributionTracked": "2026-03-16T00:57:57.217Z",
  "eventScheduledEnd": "2026-03-16T00:57:57.217Z",
  "eventScheduledStart": "2026-03-16T00:57:57.217Z",
  "examMaterialReturnShipmentReceived": "2026-03-16T00:57:57.217Z",
  "examStarted": "2026-03-16T00:57:57.217Z",
  "lastChangeTime": "2026-03-16T00:57:57.217Z",
  "registrationDeadline": "2026-03-16T00:57:57.217Z",
  "registrationLocked": "2026-03-16T00:57:57.217Z",
  "registrationStart": "2026-03-16T00:57:57.217Z"
}

Check for the existence of one specific event

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

eventstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/booking/events/{event}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/booking/events/{event} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collect the list of events that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

learnerRegistrationGroupIdstring · uuid · nullableOptional

mandatorySurveyFormIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

venueCoordinatorIdstring · uuid · nullableOptional

venueLocationIdstring · uuid · nullableOptional

venueOfficeIdstring · uuid · nullableOptional

allowMultipleRegistrationsboolean · nullableOptional

allowRegistrationWithLinkboolean · nullableOptional

integrationWithholdDistributionboolean · nullableOptional

integrationWithholdGradesboolean · nullableOptional

personCodeIsRequiredboolean · nullableOptional

waitlistEnabledboolean · nullableOptional

appointmentTypestring · nullableOptional

contentstring · nullableOptional

distributionCodestring · nullableOptional

distributionErrorsstring · nullableOptional

distributionProcessstring · nullableOptional

distributionStatusstring · nullableOptional

durationUnitstring · nullableOptional

eventBillingTypestring · nullableOptional

eventCalendarColorstring · nullableOptional

eventClassCodestring · nullableOptional

eventDescriptionstring · nullableOptional

eventFormatstring · nullableOptional

eventPublicationStatusstring · nullableOptional

eventRequisitionStatusstring · nullableOptional

eventSchedulingStatusstring · nullableOptional

eventSourcestring · nullableOptional

eventSummarystring · nullableOptional

eventTitlestring · nullableOptional

eventTypestring · nullableOptional

examMaterialReturnShipmentCodestring · nullableOptional

examMaterialReturnShipmentConditionstring · nullableOptional

examTypestring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

publicationErrorsstring · nullableOptional

registrationFieldsstring · nullableOptional

venueRoomstring · nullableOptional

capacityMaximuminteger · int32 · nullableOptional

capacityMinimuminteger · int32 · nullableOptional

durationQuantityinteger · int32 · nullableOptional

eventNumberinteger · int32 · nullableOptional

examDurationInMinutesinteger · int32 · nullableOptional

invigilatorMinimuminteger · int32 · nullableOptional

creditHoursnumber · double · nullableOptional

distributionExpectedstring · date-time · nullableOptional

distributionOrderedstring · date-time · nullableOptional

distributionShippedstring · date-time · nullableOptional

distributionTrackedstring · date-time · nullableOptional

eventScheduledEndstring · date-time · nullableOptional

eventScheduledStartstring · date-time · nullableOptional

examMaterialReturnShipmentReceivedstring · date-time · nullableOptional

examStartedstring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

registrationDeadlinestring · date-time · nullableOptional

registrationLockedstring · date-time · nullableOptional

registrationStartstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

achievementIdstring · uuid · nullableOptional

eventIdstring · uuidOptional

learnerRegistrationGroupIdstring · uuid · nullableOptional

mandatorySurveyFormIdstring · uuid · nullableOptional

organizationIdstring · uuidOptional

venueCoordinatorIdstring · uuid · nullableOptional

venueLocationIdstring · uuid · nullableOptional

venueOfficeIdstring · uuid · nullableOptional

allowMultipleRegistrationsbooleanOptional

allowRegistrationWithLinkboolean · nullableOptional

billingCodeEnabledbooleanOptional

integrationWithholdDistributionbooleanOptional

integrationWithholdGradesbooleanOptional

personCodeIsRequiredbooleanOptional

waitlistEnabledbooleanOptional

appointmentTypestring · nullableOptional

contentstring · nullableOptional

distributionCodestring · nullableOptional

distributionErrorsstring · nullableOptional

distributionProcessstring · nullableOptional

distributionStatusstring · nullableOptional

durationUnitstring · nullableOptional

eventBillingTypestring · nullableOptional

eventCalendarColorstring · nullableOptional

eventClassCodestring · nullableOptional

eventDescriptionstring · nullableOptional

eventFormatstring · nullableOptional

eventPublicationStatusstring · nullableOptional

eventRequisitionStatusstring · nullableOptional

eventSchedulingStatusstring · nullableOptional

eventSourcestring · nullableOptional

eventSummarystring · nullableOptional

eventTitlestring · nullableOptional

eventTypestring · nullableOptional

examMaterialReturnShipmentCodestring · nullableOptional

examMaterialReturnShipmentConditionstring · nullableOptional

examTypestring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

publicationErrorsstring · nullableOptional

registrationFieldsstring · nullableOptional

venueRoomstring · nullableOptional

capacityMaximuminteger · int32 · nullableOptional

capacityMinimuminteger · int32 · nullableOptional

durationQuantityinteger · int32 · nullableOptional

eventNumberinteger · int32Optional

examDurationInMinutesinteger · int32 · nullableOptional

invigilatorMinimuminteger · int32 · nullableOptional

creditHoursnumber · double · nullableOptional

distributionExpectedstring · date-time · nullableOptional

distributionOrderedstring · date-time · nullableOptional

distributionShippedstring · date-time · nullableOptional

distributionTrackedstring · date-time · nullableOptional

eventScheduledEndstring · date-time · nullableOptional

eventScheduledStartstring · date-timeOptional

examMaterialReturnShipmentReceivedstring · date-time · nullableOptional

examStartedstring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

registrationDeadlinestring · date-time · nullableOptional

registrationLockedstring · date-time · nullableOptional

registrationStartstring · date-time · nullableOptional

post

/api/booking/events/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/booking/events/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 2475

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-16T00:57:57.217Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerRegistrationGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "mandatorySurveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueCoordinatorId": "123e4567-e89b-12d3-a456-426614174000",
  "venueLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueOfficeId": "123e4567-e89b-12d3-a456-426614174000",
  "allowMultipleRegistrations": true,
  "allowRegistrationWithLink": true,
  "integrationWithholdDistribution": true,
  "integrationWithholdGrades": true,
  "personCodeIsRequired": true,
  "waitlistEnabled": true,
  "appointmentType": "text",
  "content": "text",
  "distributionCode": "text",
  "distributionErrors": "text",
  "distributionProcess": "text",
  "distributionStatus": "text",
  "durationUnit": "text",
  "eventBillingType": "text",
  "eventCalendarColor": "text",
  "eventClassCode": "text",
  "eventDescription": "text",
  "eventFormat": "text",
  "eventPublicationStatus": "text",
  "eventRequisitionStatus": "text",
  "eventSchedulingStatus": "text",
  "eventSource": "text",
  "eventSummary": "text",
  "eventTitle": "text",
  "eventType": "text",
  "examMaterialReturnShipmentCode": "text",
  "examMaterialReturnShipmentCondition": "text",
  "examType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "publicationErrors": "text",
  "registrationFields": "text",
  "venueRoom": "text",
  "capacityMaximum": 1,
  "capacityMinimum": 1,
  "durationQuantity": 1,
  "eventNumber": 1,
  "examDurationInMinutes": 1,
  "invigilatorMinimum": 1,
  "creditHours": 1,
  "distributionExpected": "2026-03-16T00:57:57.217Z",
  "distributionOrdered": "2026-03-16T00:57:57.217Z",
  "distributionShipped": "2026-03-16T00:57:57.217Z",
  "distributionTracked": "2026-03-16T00:57:57.217Z",
  "eventScheduledEnd": "2026-03-16T00:57:57.217Z",
  "eventScheduledStart": "2026-03-16T00:57:57.217Z",
  "examMaterialReturnShipmentReceived": "2026-03-16T00:57:57.217Z",
  "examStarted": "2026-03-16T00:57:57.217Z",
  "lastChangeTime": "2026-03-16T00:57:57.217Z",
  "registrationDeadline": "2026-03-16T00:57:57.217Z",
  "registrationLocked": "2026-03-16T00:57:57.217Z",
  "registrationStart": "2026-03-16T00:57:57.217Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "achievementId": "123e4567-e89b-12d3-a456-426614174000",
    "eventId": "123e4567-e89b-12d3-a456-426614174000",
    "learnerRegistrationGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "mandatorySurveyFormId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "venueCoordinatorId": "123e4567-e89b-12d3-a456-426614174000",
    "venueLocationId": "123e4567-e89b-12d3-a456-426614174000",
    "venueOfficeId": "123e4567-e89b-12d3-a456-426614174000",
    "allowMultipleRegistrations": true,
    "allowRegistrationWithLink": true,
    "billingCodeEnabled": true,
    "integrationWithholdDistribution": true,
    "integrationWithholdGrades": true,
    "personCodeIsRequired": true,
    "waitlistEnabled": true,
    "appointmentType": "text",
    "content": "text",
    "distributionCode": "text",
    "distributionErrors": "text",
    "distributionProcess": "text",
    "distributionStatus": "text",
    "durationUnit": "text",
    "eventBillingType": "text",
    "eventCalendarColor": "text",
    "eventClassCode": "text",
    "eventDescription": "text",
    "eventFormat": "text",
    "eventPublicationStatus": "text",
    "eventRequisitionStatus": "text",
    "eventSchedulingStatus": "text",
    "eventSource": "text",
    "eventSummary": "text",
    "eventTitle": "text",
    "eventType": "text",
    "examMaterialReturnShipmentCode": "text",
    "examMaterialReturnShipmentCondition": "text",
    "examType": "text",
    "lastChangeType": "text",
    "lastChangeUser": "text",
    "publicationErrors": "text",
    "registrationFields": "text",
    "venueRoom": "text",
    "capacityMaximum": 1,
    "capacityMinimum": 1,
    "durationQuantity": 1,
    "eventNumber": 1,
    "examDurationInMinutes": 1,
    "invigilatorMinimum": 1,
    "creditHours": 1,
    "distributionExpected": "2026-03-16T00:57:57.217Z",
    "distributionOrdered": "2026-03-16T00:57:57.217Z",
    "distributionShipped": "2026-03-16T00:57:57.217Z",
    "distributionTracked": "2026-03-16T00:57:57.217Z",
    "eventScheduledEnd": "2026-03-16T00:57:57.217Z",
    "eventScheduledStart": "2026-03-16T00:57:57.217Z",
    "examMaterialReturnShipmentReceived": "2026-03-16T00:57:57.217Z",
    "examStarted": "2026-03-16T00:57:57.217Z",
    "lastChangeTime": "2026-03-16T00:57:57.217Z",
    "registrationDeadline": "2026-03-16T00:57:57.217Z",
    "registrationLocked": "2026-03-16T00:57:57.217Z",
    "registrationStart": "2026-03-16T00:57:57.217Z"
  }
]

Count the events that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

learnerRegistrationGroupIdstring · uuid · nullableOptional

mandatorySurveyFormIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

venueCoordinatorIdstring · uuid · nullableOptional

venueLocationIdstring · uuid · nullableOptional

venueOfficeIdstring · uuid · nullableOptional

allowMultipleRegistrationsboolean · nullableOptional

allowRegistrationWithLinkboolean · nullableOptional

integrationWithholdDistributionboolean · nullableOptional

integrationWithholdGradesboolean · nullableOptional

personCodeIsRequiredboolean · nullableOptional

waitlistEnabledboolean · nullableOptional

appointmentTypestring · nullableOptional

contentstring · nullableOptional

distributionCodestring · nullableOptional

distributionErrorsstring · nullableOptional

distributionProcessstring · nullableOptional

distributionStatusstring · nullableOptional

durationUnitstring · nullableOptional

eventBillingTypestring · nullableOptional

eventCalendarColorstring · nullableOptional

eventClassCodestring · nullableOptional

eventDescriptionstring · nullableOptional

eventFormatstring · nullableOptional

eventPublicationStatusstring · nullableOptional

eventRequisitionStatusstring · nullableOptional

eventSchedulingStatusstring · nullableOptional

eventSourcestring · nullableOptional

eventSummarystring · nullableOptional

eventTitlestring · nullableOptional

eventTypestring · nullableOptional

examMaterialReturnShipmentCodestring · nullableOptional

examMaterialReturnShipmentConditionstring · nullableOptional

examTypestring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

publicationErrorsstring · nullableOptional

registrationFieldsstring · nullableOptional

venueRoomstring · nullableOptional

capacityMaximuminteger · int32 · nullableOptional

capacityMinimuminteger · int32 · nullableOptional

durationQuantityinteger · int32 · nullableOptional

eventNumberinteger · int32 · nullableOptional

examDurationInMinutesinteger · int32 · nullableOptional

invigilatorMinimuminteger · int32 · nullableOptional

creditHoursnumber · double · nullableOptional

distributionExpectedstring · date-time · nullableOptional

distributionOrderedstring · date-time · nullableOptional

distributionShippedstring · date-time · nullableOptional

distributionTrackedstring · date-time · nullableOptional

eventScheduledEndstring · date-time · nullableOptional

eventScheduledStartstring · date-time · nullableOptional

examMaterialReturnShipmentReceivedstring · date-time · nullableOptional

examStartedstring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

registrationDeadlinestring · date-time · nullableOptional

registrationLockedstring · date-time · nullableOptional

registrationStartstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/booking/events/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/booking/events/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 2475

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-16T00:57:57.217Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerRegistrationGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "mandatorySurveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueCoordinatorId": "123e4567-e89b-12d3-a456-426614174000",
  "venueLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueOfficeId": "123e4567-e89b-12d3-a456-426614174000",
  "allowMultipleRegistrations": true,
  "allowRegistrationWithLink": true,
  "integrationWithholdDistribution": true,
  "integrationWithholdGrades": true,
  "personCodeIsRequired": true,
  "waitlistEnabled": true,
  "appointmentType": "text",
  "content": "text",
  "distributionCode": "text",
  "distributionErrors": "text",
  "distributionProcess": "text",
  "distributionStatus": "text",
  "durationUnit": "text",
  "eventBillingType": "text",
  "eventCalendarColor": "text",
  "eventClassCode": "text",
  "eventDescription": "text",
  "eventFormat": "text",
  "eventPublicationStatus": "text",
  "eventRequisitionStatus": "text",
  "eventSchedulingStatus": "text",
  "eventSource": "text",
  "eventSummary": "text",
  "eventTitle": "text",
  "eventType": "text",
  "examMaterialReturnShipmentCode": "text",
  "examMaterialReturnShipmentCondition": "text",
  "examType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "publicationErrors": "text",
  "registrationFields": "text",
  "venueRoom": "text",
  "capacityMaximum": 1,
  "capacityMinimum": 1,
  "durationQuantity": 1,
  "eventNumber": 1,
  "examDurationInMinutes": 1,
  "invigilatorMinimum": 1,
  "creditHours": 1,
  "distributionExpected": "2026-03-16T00:57:57.217Z",
  "distributionOrdered": "2026-03-16T00:57:57.217Z",
  "distributionShipped": "2026-03-16T00:57:57.217Z",
  "distributionTracked": "2026-03-16T00:57:57.217Z",
  "eventScheduledEnd": "2026-03-16T00:57:57.217Z",
  "eventScheduledStart": "2026-03-16T00:57:57.217Z",
  "examMaterialReturnShipmentReceived": "2026-03-16T00:57:57.217Z",
  "examStarted": "2026-03-16T00:57:57.217Z",
  "lastChangeTime": "2026-03-16T00:57:57.217Z",
  "registrationDeadline": "2026-03-16T00:57:57.217Z",
  "registrationLocked": "2026-03-16T00:57:57.217Z",
  "registrationStart": "2026-03-16T00:57:57.217Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Download the list of events that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

learnerRegistrationGroupIdstring · uuid · nullableOptional

mandatorySurveyFormIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

venueCoordinatorIdstring · uuid · nullableOptional

venueLocationIdstring · uuid · nullableOptional

venueOfficeIdstring · uuid · nullableOptional

allowMultipleRegistrationsboolean · nullableOptional

allowRegistrationWithLinkboolean · nullableOptional

integrationWithholdDistributionboolean · nullableOptional

integrationWithholdGradesboolean · nullableOptional

personCodeIsRequiredboolean · nullableOptional

waitlistEnabledboolean · nullableOptional

appointmentTypestring · nullableOptional

contentstring · nullableOptional

distributionCodestring · nullableOptional

distributionErrorsstring · nullableOptional

distributionProcessstring · nullableOptional

distributionStatusstring · nullableOptional

durationUnitstring · nullableOptional

eventBillingTypestring · nullableOptional

eventCalendarColorstring · nullableOptional

eventClassCodestring · nullableOptional

eventDescriptionstring · nullableOptional

eventFormatstring · nullableOptional

eventPublicationStatusstring · nullableOptional

eventRequisitionStatusstring · nullableOptional

eventSchedulingStatusstring · nullableOptional

eventSourcestring · nullableOptional

eventSummarystring · nullableOptional

eventTitlestring · nullableOptional

eventTypestring · nullableOptional

examMaterialReturnShipmentCodestring · nullableOptional

examMaterialReturnShipmentConditionstring · nullableOptional

examTypestring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

publicationErrorsstring · nullableOptional

registrationFieldsstring · nullableOptional

venueRoomstring · nullableOptional

capacityMaximuminteger · int32 · nullableOptional

capacityMinimuminteger · int32 · nullableOptional

durationQuantityinteger · int32 · nullableOptional

eventNumberinteger · int32 · nullableOptional

examDurationInMinutesinteger · int32 · nullableOptional

invigilatorMinimuminteger · int32 · nullableOptional

creditHoursnumber · double · nullableOptional

distributionExpectedstring · date-time · nullableOptional

distributionOrderedstring · date-time · nullableOptional

distributionShippedstring · date-time · nullableOptional

distributionTrackedstring · date-time · nullableOptional

eventScheduledEndstring · date-time · nullableOptional

eventScheduledStartstring · date-time · nullableOptional

examMaterialReturnShipmentReceivedstring · date-time · nullableOptional

examStartedstring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

registrationDeadlinestring · date-time · nullableOptional

registrationLockedstring · date-time · nullableOptional

registrationStartstring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/booking/events/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/booking/events/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 2475

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-16T00:57:57.217Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerRegistrationGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "mandatorySurveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueCoordinatorId": "123e4567-e89b-12d3-a456-426614174000",
  "venueLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueOfficeId": "123e4567-e89b-12d3-a456-426614174000",
  "allowMultipleRegistrations": true,
  "allowRegistrationWithLink": true,
  "integrationWithholdDistribution": true,
  "integrationWithholdGrades": true,
  "personCodeIsRequired": true,
  "waitlistEnabled": true,
  "appointmentType": "text",
  "content": "text",
  "distributionCode": "text",
  "distributionErrors": "text",
  "distributionProcess": "text",
  "distributionStatus": "text",
  "durationUnit": "text",
  "eventBillingType": "text",
  "eventCalendarColor": "text",
  "eventClassCode": "text",
  "eventDescription": "text",
  "eventFormat": "text",
  "eventPublicationStatus": "text",
  "eventRequisitionStatus": "text",
  "eventSchedulingStatus": "text",
  "eventSource": "text",
  "eventSummary": "text",
  "eventTitle": "text",
  "eventType": "text",
  "examMaterialReturnShipmentCode": "text",
  "examMaterialReturnShipmentCondition": "text",
  "examType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "publicationErrors": "text",
  "registrationFields": "text",
  "venueRoom": "text",
  "capacityMaximum": 1,
  "capacityMinimum": 1,
  "durationQuantity": 1,
  "eventNumber": 1,
  "examDurationInMinutes": 1,
  "invigilatorMinimum": 1,
  "creditHours": 1,
  "distributionExpected": "2026-03-16T00:57:57.217Z",
  "distributionOrdered": "2026-03-16T00:57:57.217Z",
  "distributionShipped": "2026-03-16T00:57:57.217Z",
  "distributionTracked": "2026-03-16T00:57:57.217Z",
  "eventScheduledEnd": "2026-03-16T00:57:57.217Z",
  "eventScheduledStart": "2026-03-16T00:57:57.217Z",
  "examMaterialReturnShipmentReceived": "2026-03-16T00:57:57.217Z",
  "examStarted": "2026-03-16T00:57:57.217Z",
  "lastChangeTime": "2026-03-16T00:57:57.217Z",
  "registrationDeadline": "2026-03-16T00:57:57.217Z",
  "registrationLocked": "2026-03-16T00:57:57.217Z",
  "registrationStart": "2026-03-16T00:57:57.217Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Search for the list of events that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

learnerRegistrationGroupIdstring · uuid · nullableOptional

mandatorySurveyFormIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

venueCoordinatorIdstring · uuid · nullableOptional

venueLocationIdstring · uuid · nullableOptional

venueOfficeIdstring · uuid · nullableOptional

allowMultipleRegistrationsboolean · nullableOptional

allowRegistrationWithLinkboolean · nullableOptional

integrationWithholdDistributionboolean · nullableOptional

integrationWithholdGradesboolean · nullableOptional

personCodeIsRequiredboolean · nullableOptional

waitlistEnabledboolean · nullableOptional

appointmentTypestring · nullableOptional

contentstring · nullableOptional

distributionCodestring · nullableOptional

distributionErrorsstring · nullableOptional

distributionProcessstring · nullableOptional

distributionStatusstring · nullableOptional

durationUnitstring · nullableOptional

eventBillingTypestring · nullableOptional

eventCalendarColorstring · nullableOptional

eventClassCodestring · nullableOptional

eventDescriptionstring · nullableOptional

eventFormatstring · nullableOptional

eventPublicationStatusstring · nullableOptional

eventRequisitionStatusstring · nullableOptional

eventSchedulingStatusstring · nullableOptional

eventSourcestring · nullableOptional

eventSummarystring · nullableOptional

eventTitlestring · nullableOptional

eventTypestring · nullableOptional

examMaterialReturnShipmentCodestring · nullableOptional

examMaterialReturnShipmentConditionstring · nullableOptional

examTypestring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

publicationErrorsstring · nullableOptional

registrationFieldsstring · nullableOptional

venueRoomstring · nullableOptional

capacityMaximuminteger · int32 · nullableOptional

capacityMinimuminteger · int32 · nullableOptional

durationQuantityinteger · int32 · nullableOptional

eventNumberinteger · int32 · nullableOptional

examDurationInMinutesinteger · int32 · nullableOptional

invigilatorMinimuminteger · int32 · nullableOptional

creditHoursnumber · double · nullableOptional

distributionExpectedstring · date-time · nullableOptional

distributionOrderedstring · date-time · nullableOptional

distributionShippedstring · date-time · nullableOptional

distributionTrackedstring · date-time · nullableOptional

eventScheduledEndstring · date-time · nullableOptional

eventScheduledStartstring · date-time · nullableOptional

examMaterialReturnShipmentReceivedstring · date-time · nullableOptional

examStartedstring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

registrationDeadlinestring · date-time · nullableOptional

registrationLockedstring · date-time · nullableOptional

registrationStartstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

eventIdstring · uuidOptional

post

/api/booking/events/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/booking/events/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 2475

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-16T00:57:57.217Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerRegistrationGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "mandatorySurveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueCoordinatorId": "123e4567-e89b-12d3-a456-426614174000",
  "venueLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "venueOfficeId": "123e4567-e89b-12d3-a456-426614174000",
  "allowMultipleRegistrations": true,
  "allowRegistrationWithLink": true,
  "integrationWithholdDistribution": true,
  "integrationWithholdGrades": true,
  "personCodeIsRequired": true,
  "waitlistEnabled": true,
  "appointmentType": "text",
  "content": "text",
  "distributionCode": "text",
  "distributionErrors": "text",
  "distributionProcess": "text",
  "distributionStatus": "text",
  "durationUnit": "text",
  "eventBillingType": "text",
  "eventCalendarColor": "text",
  "eventClassCode": "text",
  "eventDescription": "text",
  "eventFormat": "text",
  "eventPublicationStatus": "text",
  "eventRequisitionStatus": "text",
  "eventSchedulingStatus": "text",
  "eventSource": "text",
  "eventSummary": "text",
  "eventTitle": "text",
  "eventType": "text",
  "examMaterialReturnShipmentCode": "text",
  "examMaterialReturnShipmentCondition": "text",
  "examType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "publicationErrors": "text",
  "registrationFields": "text",
  "venueRoom": "text",
  "capacityMaximum": 1,
  "capacityMinimum": 1,
  "durationQuantity": 1,
  "eventNumber": 1,
  "examDurationInMinutes": 1,
  "invigilatorMinimum": 1,
  "creditHours": 1,
  "distributionExpected": "2026-03-16T00:57:57.217Z",
  "distributionOrdered": "2026-03-16T00:57:57.217Z",
  "distributionShipped": "2026-03-16T00:57:57.217Z",
  "distributionTracked": "2026-03-16T00:57:57.217Z",
  "eventScheduledEnd": "2026-03-16T00:57:57.217Z",
  "eventScheduledStart": "2026-03-16T00:57:57.217Z",
  "examMaterialReturnShipmentReceived": "2026-03-16T00:57:57.217Z",
  "examStarted": "2026-03-16T00:57:57.217Z",
  "lastChangeTime": "2026-03-16T00:57:57.217Z",
  "registrationDeadline": "2026-03-16T00:57:57.217Z",
  "registrationLocked": "2026-03-16T00:57:57.217Z",
  "registrationStart": "2026-03-16T00:57:57.217Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "eventId": "123e4567-e89b-12d3-a456-426614174000"
  }
]