Booking API: Registrations

Retrieves one specific registration

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

registrationstring · uuidRequired

Responses

200

OK

application/jsontext/json

attemptIdentifierstring · uuid · nullableOptional

candidateIdentifierstring · uuidOptional

customerIdentifierstring · uuid · nullableOptional

employerIdentifierstring · uuid · nullableOptional

eventIdentifierstring · uuidOptional

examFormIdentifierstring · uuid · nullableOptional

organizationIdentifierstring · uuidOptional

paymentIdentifierstring · uuid · nullableOptional

registrationIdentifierstring · uuidOptional

registrationRequestedBystring · uuid · nullableOptional

schoolIdentifierstring · uuid · nullableOptional

seatIdentifierstring · uuid · nullableOptional

includeInT2202booleanOptional

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

get

/api/booking/registrations/{registration}

HTTPcURLJavaScriptPython

GET /v2/e01/api/booking/registrations/{registration} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "attemptIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "candidateIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "customerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "employerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "eventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "examFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "paymentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "registrationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "registrationRequestedBy": "123e4567-e89b-12d3-a456-426614174000",
  "schoolIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "seatIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "includeInT2202": true,
  "materialsIncludeDiagramBook": true,
  "approvalProcess": "text",
  "approvalReason": "text",
  "approvalStatus": "text",
  "attendanceStatus": "text",
  "billingCode": "text",
  "billingCustomer": "text",
  "candidateType": "text",
  "eligibilityProcess": "text",
  "eligibilityStatus": "text",
  "eventPotentialConflicts": "text",
  "grade": "text",
  "gradeWithheldReason": "text",
  "gradingProcess": "text",
  "gradingStatus": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "materialsPackagedForDistribution": "text",
  "materialsPermittedToCandidates": "text",
  "registrationComment": "text",
  "registrationPassword": "text",
  "registrationSource": "text",
  "synchronizationProcess": "text",
  "synchronizationStatus": "text",
  "examTimeLimit": 1,
  "registrationSequence": 1,
  "workBasedHoursToDate": 1,
  "registrationFee": 1,
  "score": 1,
  "attendanceTaken": "2026-03-13T14:37:49.267Z",
  "distributionExpected": "2026-03-13T14:37:49.267Z",
  "eligibilityUpdated": "2026-03-13T14:37:49.267Z",
  "gradeAssigned": "2026-03-13T14:37:49.267Z",
  "gradePublished": "2026-03-13T14:37:49.267Z",
  "gradeReleased": "2026-03-13T14:37:49.267Z",
  "gradeWithheld": "2026-03-13T14:37:49.267Z",
  "lastChangeTime": "2026-03-13T14:37:49.267Z",
  "registrationRequestedOn": "2026-03-13T14:37:49.267Z"
}

Checks for the existence of one specific registration

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

registrationstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/booking/registrations/{registration}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/booking/registrations/{registration} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of registrations that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

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

200

OK

application/jsontext/json

attemptIdentifierstring · uuid · nullableOptional

candidateIdentifierstring · uuidOptional

customerIdentifierstring · uuid · nullableOptional

employerIdentifierstring · uuid · nullableOptional

eventIdentifierstring · uuidOptional

examFormIdentifierstring · uuid · nullableOptional

organizationIdentifierstring · uuidOptional

paymentIdentifierstring · uuid · nullableOptional

registrationIdentifierstring · uuidOptional

registrationRequestedBystring · uuid · nullableOptional

schoolIdentifierstring · uuid · nullableOptional

seatIdentifierstring · uuid · nullableOptional

includeInT2202booleanOptional

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

post

/api/booking/registrations/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:37:49.267Z",
    "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"
  },
  "attemptIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "candidateIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "customerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "employerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "eventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "examFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "registrationRequestedBy": "123e4567-e89b-12d3-a456-426614174000",
  "schoolIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "seatIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "includeInT2202": true,
  "materialsIncludeDiagramBook": true,
  "approvalProcess": "text",
  "approvalReason": "text",
  "approvalStatus": "text",
  "attendanceStatus": "text",
  "billingCode": "text",
  "billingCustomer": "text",
  "candidateType": "text",
  "eligibilityProcess": "text",
  "eligibilityStatus": "text",
  "eventPotentialConflicts": "text",
  "grade": "text",
  "gradeWithheldReason": "text",
  "gradingProcess": "text",
  "gradingStatus": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "materialsPackagedForDistribution": "text",
  "materialsPermittedToCandidates": "text",
  "registrationComment": "text",
  "registrationPassword": "text",
  "registrationSource": "text",
  "synchronizationProcess": "text",
  "synchronizationStatus": "text",
  "examTimeLimit": 1,
  "registrationSequence": 1,
  "workBasedHoursToDate": 1,
  "registrationFee": 1,
  "score": 1,
  "attendanceTaken": "2026-03-13T14:37:49.267Z",
  "distributionExpected": "2026-03-13T14:37:49.267Z",
  "eligibilityUpdated": "2026-03-13T14:37:49.267Z",
  "gradeAssigned": "2026-03-13T14:37:49.267Z",
  "gradePublished": "2026-03-13T14:37:49.267Z",
  "gradeReleased": "2026-03-13T14:37:49.267Z",
  "gradeWithheld": "2026-03-13T14:37:49.267Z",
  "lastChangeTime": "2026-03-13T14:37:49.267Z",
  "registrationRequestedOn": "2026-03-13T14:37:49.267Z"
}

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

200

OK

[
  {
    "attemptIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "candidateIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "customerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "employerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "eventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "examFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "paymentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "registrationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "registrationRequestedBy": "123e4567-e89b-12d3-a456-426614174000",
    "schoolIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "seatIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "includeInT2202": true,
    "materialsIncludeDiagramBook": true,
    "approvalProcess": "text",
    "approvalReason": "text",
    "approvalStatus": "text",
    "attendanceStatus": "text",
    "billingCode": "text",
    "billingCustomer": "text",
    "candidateType": "text",
    "eligibilityProcess": "text",
    "eligibilityStatus": "text",
    "eventPotentialConflicts": "text",
    "grade": "text",
    "gradeWithheldReason": "text",
    "gradingProcess": "text",
    "gradingStatus": "text",
    "lastChangeType": "text",
    "lastChangeUser": "text",
    "materialsPackagedForDistribution": "text",
    "materialsPermittedToCandidates": "text",
    "registrationComment": "text",
    "registrationPassword": "text",
    "registrationSource": "text",
    "synchronizationProcess": "text",
    "synchronizationStatus": "text",
    "examTimeLimit": 1,
    "registrationSequence": 1,
    "workBasedHoursToDate": 1,
    "registrationFee": 1,
    "score": 1,
    "attendanceTaken": "2026-03-13T14:37:49.267Z",
    "distributionExpected": "2026-03-13T14:37:49.267Z",
    "eligibilityUpdated": "2026-03-13T14:37:49.267Z",
    "gradeAssigned": "2026-03-13T14:37:49.267Z",
    "gradePublished": "2026-03-13T14:37:49.267Z",
    "gradeReleased": "2026-03-13T14:37:49.267Z",
    "gradeWithheld": "2026-03-13T14:37:49.267Z",
    "lastChangeTime": "2026-03-13T14:37:49.267Z",
    "registrationRequestedOn": "2026-03-13T14:37:49.267Z"
  }
]

Counts the registrations that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

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

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/booking/registrations/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:37:49.267Z",
    "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"
  },
  "attemptIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "candidateIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "customerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "employerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "eventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "examFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "registrationRequestedBy": "123e4567-e89b-12d3-a456-426614174000",
  "schoolIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "seatIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "includeInT2202": true,
  "materialsIncludeDiagramBook": true,
  "approvalProcess": "text",
  "approvalReason": "text",
  "approvalStatus": "text",
  "attendanceStatus": "text",
  "billingCode": "text",
  "billingCustomer": "text",
  "candidateType": "text",
  "eligibilityProcess": "text",
  "eligibilityStatus": "text",
  "eventPotentialConflicts": "text",
  "grade": "text",
  "gradeWithheldReason": "text",
  "gradingProcess": "text",
  "gradingStatus": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "materialsPackagedForDistribution": "text",
  "materialsPermittedToCandidates": "text",
  "registrationComment": "text",
  "registrationPassword": "text",
  "registrationSource": "text",
  "synchronizationProcess": "text",
  "synchronizationStatus": "text",
  "examTimeLimit": 1,
  "registrationSequence": 1,
  "workBasedHoursToDate": 1,
  "registrationFee": 1,
  "score": 1,
  "attendanceTaken": "2026-03-13T14:37:49.267Z",
  "distributionExpected": "2026-03-13T14:37:49.267Z",
  "eligibilityUpdated": "2026-03-13T14:37:49.267Z",
  "gradeAssigned": "2026-03-13T14:37:49.267Z",
  "gradePublished": "2026-03-13T14:37:49.267Z",
  "gradeReleased": "2026-03-13T14:37:49.267Z",
  "gradeWithheld": "2026-03-13T14:37:49.267Z",
  "lastChangeTime": "2026-03-13T14:37:49.267Z",
  "registrationRequestedOn": "2026-03-13T14:37:49.267Z"
}

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

200

OK

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

Downloads the list of registrations that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

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

200

OK

No content

post

/api/booking/registrations/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:37:49.267Z",
    "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"
  },
  "attemptIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "candidateIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "customerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "employerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "eventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "examFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "registrationRequestedBy": "123e4567-e89b-12d3-a456-426614174000",
  "schoolIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "seatIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "includeInT2202": true,
  "materialsIncludeDiagramBook": true,
  "approvalProcess": "text",
  "approvalReason": "text",
  "approvalStatus": "text",
  "attendanceStatus": "text",
  "billingCode": "text",
  "billingCustomer": "text",
  "candidateType": "text",
  "eligibilityProcess": "text",
  "eligibilityStatus": "text",
  "eventPotentialConflicts": "text",
  "grade": "text",
  "gradeWithheldReason": "text",
  "gradingProcess": "text",
  "gradingStatus": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "materialsPackagedForDistribution": "text",
  "materialsPermittedToCandidates": "text",
  "registrationComment": "text",
  "registrationPassword": "text",
  "registrationSource": "text",
  "synchronizationProcess": "text",
  "synchronizationStatus": "text",
  "examTimeLimit": 1,
  "registrationSequence": 1,
  "workBasedHoursToDate": 1,
  "registrationFee": 1,
  "score": 1,
  "attendanceTaken": "2026-03-13T14:37:49.267Z",
  "distributionExpected": "2026-03-13T14:37:49.267Z",
  "eligibilityUpdated": "2026-03-13T14:37:49.267Z",
  "gradeAssigned": "2026-03-13T14:37:49.267Z",
  "gradePublished": "2026-03-13T14:37:49.267Z",
  "gradeReleased": "2026-03-13T14:37:49.267Z",
  "gradeWithheld": "2026-03-13T14:37:49.267Z",
  "lastChangeTime": "2026-03-13T14:37:49.267Z",
  "registrationRequestedOn": "2026-03-13T14:37:49.267Z"
}

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

200

OK

No content

Searches for the list of registrations that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

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

200

OK

application/jsontext/json

registrationIdentifierstring · uuidOptional

post

/api/booking/registrations/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T14:37:49.267Z",
    "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"
  },
  "attemptIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "candidateIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "customerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "employerIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "eventIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "examFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "registrationRequestedBy": "123e4567-e89b-12d3-a456-426614174000",
  "schoolIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "seatIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "includeInT2202": true,
  "materialsIncludeDiagramBook": true,
  "approvalProcess": "text",
  "approvalReason": "text",
  "approvalStatus": "text",
  "attendanceStatus": "text",
  "billingCode": "text",
  "billingCustomer": "text",
  "candidateType": "text",
  "eligibilityProcess": "text",
  "eligibilityStatus": "text",
  "eventPotentialConflicts": "text",
  "grade": "text",
  "gradeWithheldReason": "text",
  "gradingProcess": "text",
  "gradingStatus": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "materialsPackagedForDistribution": "text",
  "materialsPermittedToCandidates": "text",
  "registrationComment": "text",
  "registrationPassword": "text",
  "registrationSource": "text",
  "synchronizationProcess": "text",
  "synchronizationStatus": "text",
  "examTimeLimit": 1,
  "registrationSequence": 1,
  "workBasedHoursToDate": 1,
  "registrationFee": 1,
  "score": 1,
  "attendanceTaken": "2026-03-13T14:37:49.267Z",
  "distributionExpected": "2026-03-13T14:37:49.267Z",
  "eligibilityUpdated": "2026-03-13T14:37:49.267Z",
  "gradeAssigned": "2026-03-13T14:37:49.267Z",
  "gradePublished": "2026-03-13T14:37:49.267Z",
  "gradeReleased": "2026-03-13T14:37:49.267Z",
  "gradeWithheld": "2026-03-13T14:37:49.267Z",
  "lastChangeTime": "2026-03-13T14:37:49.267Z",
  "registrationRequestedOn": "2026-03-13T14:37:49.267Z"
}

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

200

OK

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