Booking: Events

Retrieve one specific event

get

Authorizations

BearerCookie

Path parameters

eventstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/booking/events/{event} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "EventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "LearnerRegistrationGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MandatorySurveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueCoordinatorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueLocationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueOfficeIdentifier": "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",
  "ExamScoreWarnings": "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": "2025-08-29T22:13:52.542Z",
  "DistributionOrdered": "2025-08-29T22:13:52.542Z",
  "DistributionShipped": "2025-08-29T22:13:52.542Z",
  "DistributionTracked": "2025-08-29T22:13:52.542Z",
  "EventScheduledEnd": "2025-08-29T22:13:52.542Z",
  "EventScheduledStart": "2025-08-29T22:13:52.542Z",
  "ExamMaterialReturnShipmentReceived": "2025-08-29T22:13:52.542Z",
  "ExamStarted": "2025-08-29T22:13:52.542Z",
  "LastChangeTime": "2025-08-29T22:13:52.542Z",
  "RegistrationDeadline": "2025-08-29T22:13:52.542Z",
  "RegistrationLocked": "2025-08-29T22:13:52.542Z",
  "RegistrationStart": "2025-08-29T22:13:52.542Z"
}

Check for the existence of one specific event

head

Authorizations

BearerCookie

Path parameters

eventstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/booking/events/{event} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collect the list of events that match specific criteria

post

Authorizations

BearerCookie

Body

application/jsontext/jsonapplication/*+json

Identifierstring · uuid | nullableOptional

AchievementIdentifierstring · uuid | nullableOptional

LearnerRegistrationGroupIdentifierstring · uuid | nullableOptional

MandatorySurveyFormIdentifierstring · uuid | nullableOptional

OrganizationIdentifierstring · uuid | nullableOptional

VenueCoordinatorIdentifierstring · uuid | nullableOptional

VenueLocationIdentifierstring · uuid | nullableOptional

VenueOfficeIdentifierstring · 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

ExamScoreWarningsstring | 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/json

post

HTTPcURLJavaScriptPython

POST /v2/E01/booking/events/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2558

{
  "Identifier": "123e4567-e89b-12d3-a456-426614174000",
  "Origin": {
    "When": "2025-08-29T22:13:52.542Z",
    "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"
  },
  "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "LearnerRegistrationGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MandatorySurveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueCoordinatorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueLocationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueOfficeIdentifier": "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",
  "ExamScoreWarnings": "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": "2025-08-29T22:13:52.542Z",
  "DistributionOrdered": "2025-08-29T22:13:52.542Z",
  "DistributionShipped": "2025-08-29T22:13:52.542Z",
  "DistributionTracked": "2025-08-29T22:13:52.542Z",
  "EventScheduledEnd": "2025-08-29T22:13:52.542Z",
  "EventScheduledStart": "2025-08-29T22:13:52.542Z",
  "ExamMaterialReturnShipmentReceived": "2025-08-29T22:13:52.542Z",
  "ExamStarted": "2025-08-29T22:13:52.542Z",
  "LastChangeTime": "2025-08-29T22:13:52.542Z",
  "RegistrationDeadline": "2025-08-29T22:13:52.542Z",
  "RegistrationLocked": "2025-08-29T22:13:52.542Z",
  "RegistrationStart": "2025-08-29T22:13:52.542Z"
}

application/jsontext/jsonapplication/*+json

200

OK

[
  {
    "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "EventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "LearnerRegistrationGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "MandatorySurveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "VenueCoordinatorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "VenueLocationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "VenueOfficeIdentifier": "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",
    "ExamScoreWarnings": "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": "2025-08-29T22:13:52.542Z",
    "DistributionOrdered": "2025-08-29T22:13:52.542Z",
    "DistributionShipped": "2025-08-29T22:13:52.542Z",
    "DistributionTracked": "2025-08-29T22:13:52.542Z",
    "EventScheduledEnd": "2025-08-29T22:13:52.542Z",
    "EventScheduledStart": "2025-08-29T22:13:52.542Z",
    "ExamMaterialReturnShipmentReceived": "2025-08-29T22:13:52.542Z",
    "ExamStarted": "2025-08-29T22:13:52.542Z",
    "LastChangeTime": "2025-08-29T22:13:52.542Z",
    "RegistrationDeadline": "2025-08-29T22:13:52.542Z",
    "RegistrationLocked": "2025-08-29T22:13:52.542Z",
    "RegistrationStart": "2025-08-29T22:13:52.542Z"
  }
]

Count the events that match specific criteria

post

Authorizations

BearerCookie

Body

application/jsontext/jsonapplication/*+json

Identifierstring · uuid | nullableOptional

AchievementIdentifierstring · uuid | nullableOptional

LearnerRegistrationGroupIdentifierstring · uuid | nullableOptional

MandatorySurveyFormIdentifierstring · uuid | nullableOptional

OrganizationIdentifierstring · uuid | nullableOptional

VenueCoordinatorIdentifierstring · uuid | nullableOptional

VenueLocationIdentifierstring · uuid | nullableOptional

VenueOfficeIdentifierstring · 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

ExamScoreWarningsstring | 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/json

post

HTTPcURLJavaScriptPython

POST /v2/E01/booking/events/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2558

{
  "Identifier": "123e4567-e89b-12d3-a456-426614174000",
  "Origin": {
    "When": "2025-08-29T22:13:52.542Z",
    "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"
  },
  "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "LearnerRegistrationGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MandatorySurveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueCoordinatorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueLocationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueOfficeIdentifier": "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",
  "ExamScoreWarnings": "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": "2025-08-29T22:13:52.542Z",
  "DistributionOrdered": "2025-08-29T22:13:52.542Z",
  "DistributionShipped": "2025-08-29T22:13:52.542Z",
  "DistributionTracked": "2025-08-29T22:13:52.542Z",
  "EventScheduledEnd": "2025-08-29T22:13:52.542Z",
  "EventScheduledStart": "2025-08-29T22:13:52.542Z",
  "ExamMaterialReturnShipmentReceived": "2025-08-29T22:13:52.542Z",
  "ExamStarted": "2025-08-29T22:13:52.542Z",
  "LastChangeTime": "2025-08-29T22:13:52.542Z",
  "RegistrationDeadline": "2025-08-29T22:13:52.542Z",
  "RegistrationLocked": "2025-08-29T22:13:52.542Z",
  "RegistrationStart": "2025-08-29T22:13:52.542Z"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1
}

Download the list of events that match specific criteria

post

Authorizations

BearerCookie

Body

application/jsontext/jsonapplication/*+json

Identifierstring · uuid | nullableOptional

AchievementIdentifierstring · uuid | nullableOptional

LearnerRegistrationGroupIdentifierstring · uuid | nullableOptional

MandatorySurveyFormIdentifierstring · uuid | nullableOptional

OrganizationIdentifierstring · uuid | nullableOptional

VenueCoordinatorIdentifierstring · uuid | nullableOptional

VenueLocationIdentifierstring · uuid | nullableOptional

VenueOfficeIdentifierstring · 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

ExamScoreWarningsstring | 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/octet-stream

Responsestring · binary

post

HTTPcURLJavaScriptPython

POST /v2/E01/booking/events/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2558

{
  "Identifier": "123e4567-e89b-12d3-a456-426614174000",
  "Origin": {
    "When": "2025-08-29T22:13:52.542Z",
    "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"
  },
  "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "LearnerRegistrationGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MandatorySurveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueCoordinatorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueLocationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueOfficeIdentifier": "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",
  "ExamScoreWarnings": "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": "2025-08-29T22:13:52.542Z",
  "DistributionOrdered": "2025-08-29T22:13:52.542Z",
  "DistributionShipped": "2025-08-29T22:13:52.542Z",
  "DistributionTracked": "2025-08-29T22:13:52.542Z",
  "EventScheduledEnd": "2025-08-29T22:13:52.542Z",
  "EventScheduledStart": "2025-08-29T22:13:52.542Z",
  "ExamMaterialReturnShipmentReceived": "2025-08-29T22:13:52.542Z",
  "ExamStarted": "2025-08-29T22:13:52.542Z",
  "LastChangeTime": "2025-08-29T22:13:52.542Z",
  "RegistrationDeadline": "2025-08-29T22:13:52.542Z",
  "RegistrationLocked": "2025-08-29T22:13:52.542Z",
  "RegistrationStart": "2025-08-29T22:13:52.542Z"
}

application/jsontext/jsonapplication/*+json

200

OK

binary

Search for the list of events that match specific criteria

post

Authorizations

BearerCookie

Body

application/jsontext/jsonapplication/*+json

Identifierstring · uuid | nullableOptional

AchievementIdentifierstring · uuid | nullableOptional

LearnerRegistrationGroupIdentifierstring · uuid | nullableOptional

MandatorySurveyFormIdentifierstring · uuid | nullableOptional

OrganizationIdentifierstring · uuid | nullableOptional

VenueCoordinatorIdentifierstring · uuid | nullableOptional

VenueLocationIdentifierstring · uuid | nullableOptional

VenueOfficeIdentifierstring · 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

ExamScoreWarningsstring | 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/json

post

HTTPcURLJavaScriptPython

POST /v2/E01/booking/events/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2558

{
  "Identifier": "123e4567-e89b-12d3-a456-426614174000",
  "Origin": {
    "When": "2025-08-29T22:13:52.542Z",
    "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"
  },
  "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "LearnerRegistrationGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MandatorySurveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueCoordinatorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueLocationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "VenueOfficeIdentifier": "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",
  "ExamScoreWarnings": "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": "2025-08-29T22:13:52.542Z",
  "DistributionOrdered": "2025-08-29T22:13:52.542Z",
  "DistributionShipped": "2025-08-29T22:13:52.542Z",
  "DistributionTracked": "2025-08-29T22:13:52.542Z",
  "EventScheduledEnd": "2025-08-29T22:13:52.542Z",
  "EventScheduledStart": "2025-08-29T22:13:52.542Z",
  "ExamMaterialReturnShipmentReceived": "2025-08-29T22:13:52.542Z",
  "ExamStarted": "2025-08-29T22:13:52.542Z",
  "LastChangeTime": "2025-08-29T22:13:52.542Z",
  "RegistrationDeadline": "2025-08-29T22:13:52.542Z",
  "RegistrationLocked": "2025-08-29T22:13:52.542Z",
  "RegistrationStart": "2025-08-29T22:13:52.542Z"
}

application/jsontext/jsonapplication/*+json

200

OK

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