Booking: Events

get
Path parameters
eventstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/e01/booking/events/{event} HTTP/1.1
Host: 
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,
  "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-07-16T20:33:54.177Z",
  "DistributionOrdered": "2025-07-16T20:33:54.177Z",
  "DistributionShipped": "2025-07-16T20:33:54.177Z",
  "DistributionTracked": "2025-07-16T20:33:54.177Z",
  "EventScheduledEnd": "2025-07-16T20:33:54.177Z",
  "EventScheduledStart": "2025-07-16T20:33:54.177Z",
  "ExamMaterialReturnShipmentReceived": "2025-07-16T20:33:54.177Z",
  "ExamStarted": "2025-07-16T20:33:54.177Z",
  "LastChangeTime": "2025-07-16T20:33:54.177Z",
  "RegistrationDeadline": "2025-07-16T20:33:54.177Z",
  "RegistrationLocked": "2025-07-16T20:33:54.177Z",
  "RegistrationStart": "2025-07-16T20:33:54.177Z"
}
head
Path parameters
eventstring · uuidRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/e01/booking/events/{event} HTTP/1.1
Host: 
Accept: */*
200

OK

true
get
Query parameters
AchievementIdentifierstring · uuidOptional
LearnerRegistrationGroupIdentifierstring · uuidOptional
MandatorySurveyFormIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
VenueCoordinatorIdentifierstring · uuidOptional
VenueLocationIdentifierstring · uuidOptional
VenueOfficeIdentifierstring · uuidOptional
AllowMultipleRegistrationsbooleanOptional
AllowRegistrationWithLinkbooleanOptional
IntegrationWithholdDistributionbooleanOptional
IntegrationWithholdGradesbooleanOptional
PersonCodeIsRequiredbooleanOptional
WaitlistEnabledbooleanOptional
AppointmentTypestringOptional
ContentstringOptional
DistributionCodestringOptional
DistributionErrorsstringOptional
DistributionProcessstringOptional
DistributionStatusstringOptional
DurationUnitstringOptional
EventBillingTypestringOptional
EventCalendarColorstringOptional
EventClassCodestringOptional
EventDescriptionstringOptional
EventFormatstringOptional
EventPublicationStatusstringOptional
EventRequisitionStatusstringOptional
EventSchedulingStatusstringOptional
EventSourcestringOptional
EventSummarystringOptional
EventTitlestringOptional
EventTypestringOptional
ExamMaterialReturnShipmentCodestringOptional
ExamMaterialReturnShipmentConditionstringOptional
ExamScoreWarningsstringOptional
ExamTypestringOptional
LastChangeTypestringOptional
LastChangeUserstringOptional
PublicationErrorsstringOptional
RegistrationFieldsstringOptional
VenueRoomstringOptional
CapacityMaximuminteger · int32Optional
CapacityMinimuminteger · int32Optional
DurationQuantityinteger · int32Optional
EventNumberinteger · int32Optional
ExamDurationInMinutesinteger · int32Optional
InvigilatorMinimuminteger · int32Optional
CreditHoursnumber · doubleOptional
DistributionExpectedstring · date-timeOptional
DistributionOrderedstring · date-timeOptional
DistributionShippedstring · date-timeOptional
DistributionTrackedstring · date-timeOptional
EventScheduledEndstring · date-timeOptional
EventScheduledStartstring · date-timeOptional
ExamMaterialReturnShipmentReceivedstring · date-timeOptional
ExamStartedstring · date-timeOptional
LastChangeTimestring · date-timeOptional
RegistrationDeadlinestring · date-timeOptional
RegistrationLockedstring · date-timeOptional
RegistrationStartstring · date-timeOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
Responseinteger · int32
get
GET /v2/e01/booking/events/count HTTP/1.1
Host: 
Accept: */*
200

OK

1
get
Query parameters
AchievementIdentifierstring · uuidOptional
LearnerRegistrationGroupIdentifierstring · uuidOptional
MandatorySurveyFormIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
VenueCoordinatorIdentifierstring · uuidOptional
VenueLocationIdentifierstring · uuidOptional
VenueOfficeIdentifierstring · uuidOptional
AllowMultipleRegistrationsbooleanOptional
AllowRegistrationWithLinkbooleanOptional
IntegrationWithholdDistributionbooleanOptional
IntegrationWithholdGradesbooleanOptional
PersonCodeIsRequiredbooleanOptional
WaitlistEnabledbooleanOptional
AppointmentTypestringOptional
ContentstringOptional
DistributionCodestringOptional
DistributionErrorsstringOptional
DistributionProcessstringOptional
DistributionStatusstringOptional
DurationUnitstringOptional
EventBillingTypestringOptional
EventCalendarColorstringOptional
EventClassCodestringOptional
EventDescriptionstringOptional
EventFormatstringOptional
EventPublicationStatusstringOptional
EventRequisitionStatusstringOptional
EventSchedulingStatusstringOptional
EventSourcestringOptional
EventSummarystringOptional
EventTitlestringOptional
EventTypestringOptional
ExamMaterialReturnShipmentCodestringOptional
ExamMaterialReturnShipmentConditionstringOptional
ExamScoreWarningsstringOptional
ExamTypestringOptional
LastChangeTypestringOptional
LastChangeUserstringOptional
PublicationErrorsstringOptional
RegistrationFieldsstringOptional
VenueRoomstringOptional
CapacityMaximuminteger · int32Optional
CapacityMinimuminteger · int32Optional
DurationQuantityinteger · int32Optional
EventNumberinteger · int32Optional
ExamDurationInMinutesinteger · int32Optional
InvigilatorMinimuminteger · int32Optional
CreditHoursnumber · doubleOptional
DistributionExpectedstring · date-timeOptional
DistributionOrderedstring · date-timeOptional
DistributionShippedstring · date-timeOptional
DistributionTrackedstring · date-timeOptional
EventScheduledEndstring · date-timeOptional
EventScheduledStartstring · date-timeOptional
ExamMaterialReturnShipmentReceivedstring · date-timeOptional
ExamStartedstring · date-timeOptional
LastChangeTimestring · date-timeOptional
RegistrationDeadlinestring · date-timeOptional
RegistrationLockedstring · date-timeOptional
RegistrationStartstring · date-timeOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/booking/events HTTP/1.1
Host: 
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,
    "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-07-16T20:33:54.177Z",
    "DistributionOrdered": "2025-07-16T20:33:54.177Z",
    "DistributionShipped": "2025-07-16T20:33:54.177Z",
    "DistributionTracked": "2025-07-16T20:33:54.177Z",
    "EventScheduledEnd": "2025-07-16T20:33:54.177Z",
    "EventScheduledStart": "2025-07-16T20:33:54.177Z",
    "ExamMaterialReturnShipmentReceived": "2025-07-16T20:33:54.177Z",
    "ExamStarted": "2025-07-16T20:33:54.177Z",
    "LastChangeTime": "2025-07-16T20:33:54.177Z",
    "RegistrationDeadline": "2025-07-16T20:33:54.177Z",
    "RegistrationLocked": "2025-07-16T20:33:54.177Z",
    "RegistrationStart": "2025-07-16T20:33:54.177Z"
  }
]
Query parameters
AchievementIdentifierstring · uuidOptional
LearnerRegistrationGroupIdentifierstring · uuidOptional
MandatorySurveyFormIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
VenueCoordinatorIdentifierstring · uuidOptional
VenueLocationIdentifierstring · uuidOptional
VenueOfficeIdentifierstring · uuidOptional
AllowMultipleRegistrationsbooleanOptional
AllowRegistrationWithLinkbooleanOptional
IntegrationWithholdDistributionbooleanOptional
IntegrationWithholdGradesbooleanOptional
PersonCodeIsRequiredbooleanOptional
WaitlistEnabledbooleanOptional
AppointmentTypestringOptional
ContentstringOptional
DistributionCodestringOptional
DistributionErrorsstringOptional
DistributionProcessstringOptional
DistributionStatusstringOptional
DurationUnitstringOptional
EventBillingTypestringOptional
EventCalendarColorstringOptional
EventClassCodestringOptional
EventDescriptionstringOptional
EventFormatstringOptional
EventPublicationStatusstringOptional
EventRequisitionStatusstringOptional
EventSchedulingStatusstringOptional
EventSourcestringOptional
EventSummarystringOptional
EventTitlestringOptional
EventTypestringOptional
ExamMaterialReturnShipmentCodestringOptional
ExamMaterialReturnShipmentConditionstringOptional
ExamScoreWarningsstringOptional
ExamTypestringOptional
LastChangeTypestringOptional
LastChangeUserstringOptional
PublicationErrorsstringOptional
RegistrationFieldsstringOptional
VenueRoomstringOptional
CapacityMaximuminteger · int32Optional
CapacityMinimuminteger · int32Optional
DurationQuantityinteger · int32Optional
EventNumberinteger · int32Optional
ExamDurationInMinutesinteger · int32Optional
InvigilatorMinimuminteger · int32Optional
CreditHoursnumber · doubleOptional
DistributionExpectedstring · date-timeOptional
DistributionOrderedstring · date-timeOptional
DistributionShippedstring · date-timeOptional
DistributionTrackedstring · date-timeOptional
EventScheduledEndstring · date-timeOptional
EventScheduledStartstring · date-timeOptional
ExamMaterialReturnShipmentReceivedstring · date-timeOptional
ExamStartedstring · date-timeOptional
LastChangeTimestring · date-timeOptional
RegistrationDeadlinestring · date-timeOptional
RegistrationLockedstring · date-timeOptional
RegistrationStartstring · date-timeOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/booking/events/search HTTP/1.1
Host: 
Accept: */*
200

OK

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

Was this helpful?