Events API: Registrations

Retrieves one specific registration

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

registrationstring · uuidRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/events/registrations/{registration}

HTTPcURLJavaScriptPython

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

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific registration

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

registrationstring · uuidRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/events/registrations/{registration}

HTTPcURLJavaScriptPython

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

No content

Collects the list of registrations that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

AttendanceTakenSincestring · date-time · nullableOptional

AttendanceTakenBeforestring · date-time · nullableOptional

DistributionExpectedSincestring · date-time · nullableOptional

DistributionExpectedBeforestring · date-time · nullableOptional

EligibilityUpdatedSincestring · date-time · nullableOptional

EligibilityUpdatedBeforestring · date-time · nullableOptional

GradeAssignedSincestring · date-time · nullableOptional

GradeAssignedBeforestring · date-time · nullableOptional

GradePublishedSincestring · date-time · nullableOptional

GradePublishedBeforestring · date-time · nullableOptional

GradeReleasedSincestring · date-time · nullableOptional

GradeReleasedBeforestring · date-time · nullableOptional

GradeWithheldSincestring · date-time · nullableOptional

GradeWithheldBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

RegistrationRequestedOnSincestring · date-time · nullableOptional

RegistrationRequestedOnBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/events/registrations/collect

HTTPcURLJavaScriptPython

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

{
  "AttendanceTakenSince": "2026-05-08T21:39:01.620Z",
  "AttendanceTakenBefore": "2026-05-08T21:39:01.620Z",
  "DistributionExpectedSince": "2026-05-08T21:39:01.620Z",
  "DistributionExpectedBefore": "2026-05-08T21:39:01.620Z",
  "EligibilityUpdatedSince": "2026-05-08T21:39:01.620Z",
  "EligibilityUpdatedBefore": "2026-05-08T21:39:01.620Z",
  "GradeAssignedSince": "2026-05-08T21:39:01.620Z",
  "GradeAssignedBefore": "2026-05-08T21:39:01.620Z",
  "GradePublishedSince": "2026-05-08T21:39:01.620Z",
  "GradePublishedBefore": "2026-05-08T21:39:01.620Z",
  "GradeReleasedSince": "2026-05-08T21:39:01.620Z",
  "GradeReleasedBefore": "2026-05-08T21:39:01.620Z",
  "GradeWithheldSince": "2026-05-08T21:39:01.620Z",
  "GradeWithheldBefore": "2026-05-08T21:39:01.620Z",
  "LastChangeTimeSince": "2026-05-08T21:39:01.620Z",
  "LastChangeTimeBefore": "2026-05-08T21:39:01.620Z",
  "RegistrationRequestedOnSince": "2026-05-08T21:39:01.620Z",
  "RegistrationRequestedOnBefore": "2026-05-08T21:39:01.620Z"
}

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-05-08T21:39:01.620Z",
    "DistributionExpected": "2026-05-08T21:39:01.620Z",
    "EligibilityUpdated": "2026-05-08T21:39:01.620Z",
    "GradeAssigned": "2026-05-08T21:39:01.620Z",
    "GradePublished": "2026-05-08T21:39:01.620Z",
    "GradeReleased": "2026-05-08T21:39:01.620Z",
    "GradeWithheld": "2026-05-08T21:39:01.620Z",
    "LastChangeTime": "2026-05-08T21:39:01.620Z",
    "RegistrationRequestedOn": "2026-05-08T21:39:01.620Z"
  }
]

Counts the registrations that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

AttendanceTakenSincestring · date-time · nullableOptional

AttendanceTakenBeforestring · date-time · nullableOptional

DistributionExpectedSincestring · date-time · nullableOptional

DistributionExpectedBeforestring · date-time · nullableOptional

EligibilityUpdatedSincestring · date-time · nullableOptional

EligibilityUpdatedBeforestring · date-time · nullableOptional

GradeAssignedSincestring · date-time · nullableOptional

GradeAssignedBeforestring · date-time · nullableOptional

GradePublishedSincestring · date-time · nullableOptional

GradePublishedBeforestring · date-time · nullableOptional

GradeReleasedSincestring · date-time · nullableOptional

GradeReleasedBeforestring · date-time · nullableOptional

GradeWithheldSincestring · date-time · nullableOptional

GradeWithheldBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

RegistrationRequestedOnSincestring · date-time · nullableOptional

RegistrationRequestedOnBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/events/registrations/count

HTTPcURLJavaScriptPython

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

{
  "AttendanceTakenSince": "2026-05-08T21:39:01.620Z",
  "AttendanceTakenBefore": "2026-05-08T21:39:01.620Z",
  "DistributionExpectedSince": "2026-05-08T21:39:01.620Z",
  "DistributionExpectedBefore": "2026-05-08T21:39:01.620Z",
  "EligibilityUpdatedSince": "2026-05-08T21:39:01.620Z",
  "EligibilityUpdatedBefore": "2026-05-08T21:39:01.620Z",
  "GradeAssignedSince": "2026-05-08T21:39:01.620Z",
  "GradeAssignedBefore": "2026-05-08T21:39:01.620Z",
  "GradePublishedSince": "2026-05-08T21:39:01.620Z",
  "GradePublishedBefore": "2026-05-08T21:39:01.620Z",
  "GradeReleasedSince": "2026-05-08T21:39:01.620Z",
  "GradeReleasedBefore": "2026-05-08T21:39:01.620Z",
  "GradeWithheldSince": "2026-05-08T21:39:01.620Z",
  "GradeWithheldBefore": "2026-05-08T21:39:01.620Z",
  "LastChangeTimeSince": "2026-05-08T21:39:01.620Z",
  "LastChangeTimeBefore": "2026-05-08T21:39:01.620Z",
  "RegistrationRequestedOnSince": "2026-05-08T21:39:01.620Z",
  "RegistrationRequestedOnBefore": "2026-05-08T21:39:01.620Z"
}

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

AttendanceTakenSincestring · date-time · nullableOptional

AttendanceTakenBeforestring · date-time · nullableOptional

DistributionExpectedSincestring · date-time · nullableOptional

DistributionExpectedBeforestring · date-time · nullableOptional

EligibilityUpdatedSincestring · date-time · nullableOptional

EligibilityUpdatedBeforestring · date-time · nullableOptional

GradeAssignedSincestring · date-time · nullableOptional

GradeAssignedBeforestring · date-time · nullableOptional

GradePublishedSincestring · date-time · nullableOptional

GradePublishedBeforestring · date-time · nullableOptional

GradeReleasedSincestring · date-time · nullableOptional

GradeReleasedBeforestring · date-time · nullableOptional

GradeWithheldSincestring · date-time · nullableOptional

GradeWithheldBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

RegistrationRequestedOnSincestring · date-time · nullableOptional

RegistrationRequestedOnBeforestring · date-time · nullableOptional

Responses

200

OK

post

/api/events/registrations/download

HTTPcURLJavaScriptPython

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

{
  "AttendanceTakenSince": "2026-05-08T21:39:01.620Z",
  "AttendanceTakenBefore": "2026-05-08T21:39:01.620Z",
  "DistributionExpectedSince": "2026-05-08T21:39:01.620Z",
  "DistributionExpectedBefore": "2026-05-08T21:39:01.620Z",
  "EligibilityUpdatedSince": "2026-05-08T21:39:01.620Z",
  "EligibilityUpdatedBefore": "2026-05-08T21:39:01.620Z",
  "GradeAssignedSince": "2026-05-08T21:39:01.620Z",
  "GradeAssignedBefore": "2026-05-08T21:39:01.620Z",
  "GradePublishedSince": "2026-05-08T21:39:01.620Z",
  "GradePublishedBefore": "2026-05-08T21:39:01.620Z",
  "GradeReleasedSince": "2026-05-08T21:39:01.620Z",
  "GradeReleasedBefore": "2026-05-08T21:39:01.620Z",
  "GradeWithheldSince": "2026-05-08T21:39:01.620Z",
  "GradeWithheldBefore": "2026-05-08T21:39:01.620Z",
  "LastChangeTimeSince": "2026-05-08T21:39:01.620Z",
  "LastChangeTimeBefore": "2026-05-08T21:39:01.620Z",
  "RegistrationRequestedOnSince": "2026-05-08T21:39:01.620Z",
  "RegistrationRequestedOnBefore": "2026-05-08T21:39:01.620Z"
}

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

AttendanceTakenSincestring · date-time · nullableOptional

AttendanceTakenBeforestring · date-time · nullableOptional

DistributionExpectedSincestring · date-time · nullableOptional

DistributionExpectedBeforestring · date-time · nullableOptional

EligibilityUpdatedSincestring · date-time · nullableOptional

EligibilityUpdatedBeforestring · date-time · nullableOptional

GradeAssignedSincestring · date-time · nullableOptional

GradeAssignedBeforestring · date-time · nullableOptional

GradePublishedSincestring · date-time · nullableOptional

GradePublishedBeforestring · date-time · nullableOptional

GradeReleasedSincestring · date-time · nullableOptional

GradeReleasedBeforestring · date-time · nullableOptional

GradeWithheldSincestring · date-time · nullableOptional

GradeWithheldBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

RegistrationRequestedOnSincestring · date-time · nullableOptional

RegistrationRequestedOnBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/events/registrations/search

HTTPcURLJavaScriptPython

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

{
  "AttendanceTakenSince": "2026-05-08T21:39:01.620Z",
  "AttendanceTakenBefore": "2026-05-08T21:39:01.620Z",
  "DistributionExpectedSince": "2026-05-08T21:39:01.620Z",
  "DistributionExpectedBefore": "2026-05-08T21:39:01.620Z",
  "EligibilityUpdatedSince": "2026-05-08T21:39:01.620Z",
  "EligibilityUpdatedBefore": "2026-05-08T21:39:01.620Z",
  "GradeAssignedSince": "2026-05-08T21:39:01.620Z",
  "GradeAssignedBefore": "2026-05-08T21:39:01.620Z",
  "GradePublishedSince": "2026-05-08T21:39:01.620Z",
  "GradePublishedBefore": "2026-05-08T21:39:01.620Z",
  "GradeReleasedSince": "2026-05-08T21:39:01.620Z",
  "GradeReleasedBefore": "2026-05-08T21:39:01.620Z",
  "GradeWithheldSince": "2026-05-08T21:39:01.620Z",
  "GradeWithheldBefore": "2026-05-08T21:39:01.620Z",
  "LastChangeTimeSince": "2026-05-08T21:39:01.620Z",
  "LastChangeTimeBefore": "2026-05-08T21:39:01.620Z",
  "RegistrationRequestedOnSince": "2026-05-08T21:39:01.620Z",
  "RegistrationRequestedOnBefore": "2026-05-08T21:39:01.620Z"
}

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

200

OK

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