Booking API: Registrations

Retrieves one specific registration accommodation

get
Authorizations
BearerstringRequired
Path parameters
accommodationstring · uuidRequired
Responses
chevron-right
200

OK

get
/api/booking/registrations-accommodations/{accommodation}
200

OK

Checks for the existence of one specific registration accommodation

head
Authorizations
BearerstringRequired
Path parameters
accommodationstring · uuidRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/booking/registrations-accommodations/{accommodation}
200

OK

Collects the list of registration accommodations that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
registrationIdstring · uuid · nullableOptional
accommodationNamestring · nullableOptional
accommodationTypestring · nullableOptional
timeExtensioninteger · int32 · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-accommodations/collect
200

OK

Counts the registration accommodations that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
registrationIdstring · uuid · nullableOptional
accommodationNamestring · nullableOptional
accommodationTypestring · nullableOptional
timeExtensioninteger · int32 · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-accommodations/count
200

OK

Downloads the list of registration accommodations that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
registrationIdstring · uuid · nullableOptional
accommodationNamestring · nullableOptional
accommodationTypestring · nullableOptional
timeExtensioninteger · int32 · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/booking/registrations-accommodations/download
200

OK

No content

Searches for the list of registration accommodations that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
registrationIdstring · uuid · nullableOptional
accommodationNamestring · nullableOptional
accommodationTypestring · nullableOptional
timeExtensioninteger · int32 · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-accommodations/search
200

OK

Retrieves one specific registration

get
Authorizations
BearerstringRequired
Path parameters
registrationstring · uuidRequired
Responses
chevron-right
200

OK

get
/api/booking/registrations/{registration}
200

OK

Checks for the existence of one specific registration

head
Authorizations
BearerstringRequired
Path parameters
registrationstring · uuidRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/booking/registrations/{registration}
200

OK

Collects the list of registrations that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
attemptIdentifierstring · uuid · nullableOptional
candidateIdentifierstring · uuid · nullableOptional
customerIdentifierstring · uuid · nullableOptional
employerIdentifierstring · uuid · nullableOptional
eventIdentifierstring · uuid · nullableOptional
examFormIdentifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
paymentIdentifierstring · uuid · nullableOptional
registrationRequestedBystring · uuid · nullableOptional
schoolIdentifierstring · uuid · nullableOptional
seatIdentifierstring · uuid · nullableOptional
includeInT2202boolean · nullableOptional
materialsIncludeDiagramBookboolean · nullableOptional
approvalProcessstring · nullableOptional
approvalReasonstring · nullableOptional
approvalStatusstring · nullableOptional
attendanceStatusstring · nullableOptional
billingCodestring · nullableOptional
billingCustomerstring · nullableOptional
candidateTypestring · nullableOptional
eligibilityProcessstring · nullableOptional
eligibilityStatusstring · nullableOptional
eventPotentialConflictsstring · nullableOptional
gradestring · nullableOptional
gradeWithheldReasonstring · nullableOptional
gradingProcessstring · nullableOptional
gradingStatusstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
materialsPackagedForDistributionstring · nullableOptional
materialsPermittedToCandidatesstring · nullableOptional
registrationCommentstring · nullableOptional
registrationPasswordstring · nullableOptional
registrationSourcestring · nullableOptional
synchronizationProcessstring · nullableOptional
synchronizationStatusstring · nullableOptional
examTimeLimitinteger · int32 · nullableOptional
registrationSequenceinteger · int32 · nullableOptional
workBasedHoursToDateinteger · int32 · nullableOptional
registrationFeenumber · double · nullableOptional
scorenumber · double · nullableOptional
attendanceTakenstring · date-time · nullableOptional
distributionExpectedstring · date-time · nullableOptional
eligibilityUpdatedstring · date-time · nullableOptional
gradeAssignedstring · date-time · nullableOptional
gradePublishedstring · date-time · nullableOptional
gradeReleasedstring · date-time · nullableOptional
gradeWithheldstring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
registrationRequestedOnstring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations/collect
200

OK

Counts the registrations that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
attemptIdentifierstring · uuid · nullableOptional
candidateIdentifierstring · uuid · nullableOptional
customerIdentifierstring · uuid · nullableOptional
employerIdentifierstring · uuid · nullableOptional
eventIdentifierstring · uuid · nullableOptional
examFormIdentifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
paymentIdentifierstring · uuid · nullableOptional
registrationRequestedBystring · uuid · nullableOptional
schoolIdentifierstring · uuid · nullableOptional
seatIdentifierstring · uuid · nullableOptional
includeInT2202boolean · nullableOptional
materialsIncludeDiagramBookboolean · nullableOptional
approvalProcessstring · nullableOptional
approvalReasonstring · nullableOptional
approvalStatusstring · nullableOptional
attendanceStatusstring · nullableOptional
billingCodestring · nullableOptional
billingCustomerstring · nullableOptional
candidateTypestring · nullableOptional
eligibilityProcessstring · nullableOptional
eligibilityStatusstring · nullableOptional
eventPotentialConflictsstring · nullableOptional
gradestring · nullableOptional
gradeWithheldReasonstring · nullableOptional
gradingProcessstring · nullableOptional
gradingStatusstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
materialsPackagedForDistributionstring · nullableOptional
materialsPermittedToCandidatesstring · nullableOptional
registrationCommentstring · nullableOptional
registrationPasswordstring · nullableOptional
registrationSourcestring · nullableOptional
synchronizationProcessstring · nullableOptional
synchronizationStatusstring · nullableOptional
examTimeLimitinteger · int32 · nullableOptional
registrationSequenceinteger · int32 · nullableOptional
workBasedHoursToDateinteger · int32 · nullableOptional
registrationFeenumber · double · nullableOptional
scorenumber · double · nullableOptional
attendanceTakenstring · date-time · nullableOptional
distributionExpectedstring · date-time · nullableOptional
eligibilityUpdatedstring · date-time · nullableOptional
gradeAssignedstring · date-time · nullableOptional
gradePublishedstring · date-time · nullableOptional
gradeReleasedstring · date-time · nullableOptional
gradeWithheldstring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
registrationRequestedOnstring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations/count
200

OK

Downloads the list of registrations that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
attemptIdentifierstring · uuid · nullableOptional
candidateIdentifierstring · uuid · nullableOptional
customerIdentifierstring · uuid · nullableOptional
employerIdentifierstring · uuid · nullableOptional
eventIdentifierstring · uuid · nullableOptional
examFormIdentifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
paymentIdentifierstring · uuid · nullableOptional
registrationRequestedBystring · uuid · nullableOptional
schoolIdentifierstring · uuid · nullableOptional
seatIdentifierstring · uuid · nullableOptional
includeInT2202boolean · nullableOptional
materialsIncludeDiagramBookboolean · nullableOptional
approvalProcessstring · nullableOptional
approvalReasonstring · nullableOptional
approvalStatusstring · nullableOptional
attendanceStatusstring · nullableOptional
billingCodestring · nullableOptional
billingCustomerstring · nullableOptional
candidateTypestring · nullableOptional
eligibilityProcessstring · nullableOptional
eligibilityStatusstring · nullableOptional
eventPotentialConflictsstring · nullableOptional
gradestring · nullableOptional
gradeWithheldReasonstring · nullableOptional
gradingProcessstring · nullableOptional
gradingStatusstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
materialsPackagedForDistributionstring · nullableOptional
materialsPermittedToCandidatesstring · nullableOptional
registrationCommentstring · nullableOptional
registrationPasswordstring · nullableOptional
registrationSourcestring · nullableOptional
synchronizationProcessstring · nullableOptional
synchronizationStatusstring · nullableOptional
examTimeLimitinteger · int32 · nullableOptional
registrationSequenceinteger · int32 · nullableOptional
workBasedHoursToDateinteger · int32 · nullableOptional
registrationFeenumber · double · nullableOptional
scorenumber · double · nullableOptional
attendanceTakenstring · date-time · nullableOptional
distributionExpectedstring · date-time · nullableOptional
eligibilityUpdatedstring · date-time · nullableOptional
gradeAssignedstring · date-time · nullableOptional
gradePublishedstring · date-time · nullableOptional
gradeReleasedstring · date-time · nullableOptional
gradeWithheldstring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
registrationRequestedOnstring · date-time · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/booking/registrations/download
200

OK

No content

Searches for the list of registrations that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
attemptIdentifierstring · uuid · nullableOptional
candidateIdentifierstring · uuid · nullableOptional
customerIdentifierstring · uuid · nullableOptional
employerIdentifierstring · uuid · nullableOptional
eventIdentifierstring · uuid · nullableOptional
examFormIdentifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
paymentIdentifierstring · uuid · nullableOptional
registrationRequestedBystring · uuid · nullableOptional
schoolIdentifierstring · uuid · nullableOptional
seatIdentifierstring · uuid · nullableOptional
includeInT2202boolean · nullableOptional
materialsIncludeDiagramBookboolean · nullableOptional
approvalProcessstring · nullableOptional
approvalReasonstring · nullableOptional
approvalStatusstring · nullableOptional
attendanceStatusstring · nullableOptional
billingCodestring · nullableOptional
billingCustomerstring · nullableOptional
candidateTypestring · nullableOptional
eligibilityProcessstring · nullableOptional
eligibilityStatusstring · nullableOptional
eventPotentialConflictsstring · nullableOptional
gradestring · nullableOptional
gradeWithheldReasonstring · nullableOptional
gradingProcessstring · nullableOptional
gradingStatusstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
materialsPackagedForDistributionstring · nullableOptional
materialsPermittedToCandidatesstring · nullableOptional
registrationCommentstring · nullableOptional
registrationPasswordstring · nullableOptional
registrationSourcestring · nullableOptional
synchronizationProcessstring · nullableOptional
synchronizationStatusstring · nullableOptional
examTimeLimitinteger · int32 · nullableOptional
registrationSequenceinteger · int32 · nullableOptional
workBasedHoursToDateinteger · int32 · nullableOptional
registrationFeenumber · double · nullableOptional
scorenumber · double · nullableOptional
attendanceTakenstring · date-time · nullableOptional
distributionExpectedstring · date-time · nullableOptional
eligibilityUpdatedstring · date-time · nullableOptional
gradeAssignedstring · date-time · nullableOptional
gradePublishedstring · date-time · nullableOptional
gradeReleasedstring · date-time · nullableOptional
gradeWithheldstring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
registrationRequestedOnstring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations/search
200

OK

Retrieves one specific registration instructor

get
Authorizations
BearerstringRequired
Path parameters
instructorstring · uuidRequired
registrationstring · uuidRequired
Responses
chevron-right
200

OK

get
/api/booking/registrations-instructors/{registration}/{instructor}
200

OK

Checks for the existence of one specific registration instructor

head
Authorizations
BearerstringRequired
Path parameters
instructorstring · uuidRequired
registrationstring · uuidRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/booking/registrations-instructors/{registration}/{instructor}
200

OK

Collects the list of registration instructors that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-instructors/collect
200

OK

Counts the registration instructors that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-instructors/count
200

OK

Downloads the list of registration instructors that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/booking/registrations-instructors/download
200

OK

No content

Searches for the list of registration instructors that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-instructors/search
200

OK

Retrieves one specific registration timer

get
Authorizations
BearerstringRequired
Path parameters
triggerCommandstring · uuidRequired
timerstringRequired
Responses
chevron-right
200

OK

get
/api/booking/registrations-timers/{timer}
200

OK

Checks for the existence of one specific registration timer

head
Authorizations
BearerstringRequired
Path parameters
triggerCommandstring · uuidRequired
timerstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/booking/registrations-timers/{timer}
200

OK

Collects the list of registration timers that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
registrationIdstring · uuid · nullableOptional
timerDescriptionstring · nullableOptional
timerStatusstring · nullableOptional
triggerTimestring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-timers/collect
200

OK

Counts the registration timers that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
registrationIdstring · uuid · nullableOptional
timerDescriptionstring · nullableOptional
timerStatusstring · nullableOptional
triggerTimestring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-timers/count
200

OK

Downloads the list of registration timers that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
registrationIdstring · uuid · nullableOptional
timerDescriptionstring · nullableOptional
timerStatusstring · nullableOptional
triggerTimestring · date-time · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/booking/registrations-timers/download
200

OK

No content

Searches for the list of registration timers that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
registrationIdstring · uuid · nullableOptional
timerDescriptionstring · nullableOptional
timerStatusstring · nullableOptional
triggerTimestring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/booking/registrations-timers/search
200

OK

Last updated

Was this helpful?