# Events API: Registrations

## GET /api/events/registrations/{registration}

> Retrieves one specific registration

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ProblemDetails":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/events/registrations/{registration}":{"get":{"tags":["Events API: Registrations"],"summary":"Retrieves one specific registration","operationId":"retrieveRegistration","parameters":[{"name":"registration","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## HEAD /api/events/registrations/{registration}

> Checks for the existence of one specific registration

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ProblemDetails":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/events/registrations/{registration}":{"head":{"tags":["Events API: Registrations"],"summary":"Checks for the existence of one specific registration","operationId":"assertRegistration","parameters":[{"name":"registration","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## POST /api/events/registrations/collect

> Collects the list of registrations that match specific criteria

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"CollectRegistrations":{"type":"object","properties":{"AttendanceTakenSince":{"type":"string","format":"date-time","nullable":true},"AttendanceTakenBefore":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedSince":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedBefore":{"type":"string","format":"date-time","nullable":true},"GradeAssignedSince":{"type":"string","format":"date-time","nullable":true},"GradeAssignedBefore":{"type":"string","format":"date-time","nullable":true},"GradePublishedSince":{"type":"string","format":"date-time","nullable":true},"GradePublishedBefore":{"type":"string","format":"date-time","nullable":true},"GradeReleasedSince":{"type":"string","format":"date-time","nullable":true},"GradeReleasedBefore":{"type":"string","format":"date-time","nullable":true},"GradeWithheldSince":{"type":"string","format":"date-time","nullable":true},"GradeWithheldBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnSince":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"RegistrationModel":{"type":"object","properties":{"AttemptIdentifier":{"type":"string","format":"uuid","nullable":true},"CandidateIdentifier":{"type":"string","format":"uuid"},"CustomerIdentifier":{"type":"string","format":"uuid","nullable":true},"EmployerIdentifier":{"type":"string","format":"uuid","nullable":true},"EventIdentifier":{"type":"string","format":"uuid"},"ExamFormIdentifier":{"type":"string","format":"uuid","nullable":true},"OrganizationIdentifier":{"type":"string","format":"uuid"},"PaymentIdentifier":{"type":"string","format":"uuid","nullable":true},"RegistrationIdentifier":{"type":"string","format":"uuid"},"RegistrationRequestedBy":{"type":"string","format":"uuid","nullable":true},"SchoolIdentifier":{"type":"string","format":"uuid","nullable":true},"SeatIdentifier":{"type":"string","format":"uuid","nullable":true},"IncludeInT2202":{"type":"boolean"},"MaterialsIncludeDiagramBook":{"type":"boolean","nullable":true},"ApprovalProcess":{"type":"string","nullable":true},"ApprovalReason":{"type":"string","nullable":true},"ApprovalStatus":{"type":"string","nullable":true},"AttendanceStatus":{"type":"string","nullable":true},"BillingCode":{"type":"string","nullable":true},"BillingCustomer":{"type":"string","nullable":true},"CandidateType":{"type":"string","nullable":true},"EligibilityProcess":{"type":"string","nullable":true},"EligibilityStatus":{"type":"string","nullable":true},"EventPotentialConflicts":{"type":"string","nullable":true},"Grade":{"type":"string","nullable":true},"GradeWithheldReason":{"type":"string","nullable":true},"GradingProcess":{"type":"string","nullable":true},"GradingStatus":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"MaterialsPackagedForDistribution":{"type":"string","nullable":true},"MaterialsPermittedToCandidates":{"type":"string","nullable":true},"RegistrationComment":{"type":"string","nullable":true},"RegistrationPassword":{"type":"string","nullable":true},"RegistrationSource":{"type":"string","nullable":true},"SynchronizationProcess":{"type":"string","nullable":true},"SynchronizationStatus":{"type":"string","nullable":true},"ExamTimeLimit":{"type":"integer","format":"int32","nullable":true},"RegistrationSequence":{"type":"integer","format":"int32","nullable":true},"WorkBasedHoursToDate":{"type":"integer","format":"int32","nullable":true},"RegistrationFee":{"type":"number","format":"double","nullable":true},"Score":{"type":"number","format":"double","nullable":true},"AttendanceTaken":{"type":"string","format":"date-time","nullable":true},"DistributionExpected":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdated":{"type":"string","format":"date-time","nullable":true},"GradeAssigned":{"type":"string","format":"date-time","nullable":true},"GradePublished":{"type":"string","format":"date-time","nullable":true},"GradeReleased":{"type":"string","format":"date-time","nullable":true},"GradeWithheld":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOn":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}},"paths":{"/api/events/registrations/collect":{"post":{"tags":["Events API: Registrations"],"summary":"Collects the list of registrations that match specific criteria","operationId":"collectRegistrations","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CollectRegistrations"}},"application/json":{"schema":{"$ref":"#/components/schemas/CollectRegistrations"}},"text/json":{"schema":{"$ref":"#/components/schemas/CollectRegistrations"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CollectRegistrations"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegistrationModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegistrationModel"}}}}}}}}}}
```

## POST /api/events/registrations/count

> Counts the registrations that match specific criteria

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"CountRegistrations":{"type":"object","properties":{"AttendanceTakenSince":{"type":"string","format":"date-time","nullable":true},"AttendanceTakenBefore":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedSince":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedBefore":{"type":"string","format":"date-time","nullable":true},"GradeAssignedSince":{"type":"string","format":"date-time","nullable":true},"GradeAssignedBefore":{"type":"string","format":"date-time","nullable":true},"GradePublishedSince":{"type":"string","format":"date-time","nullable":true},"GradePublishedBefore":{"type":"string","format":"date-time","nullable":true},"GradeReleasedSince":{"type":"string","format":"date-time","nullable":true},"GradeReleasedBefore":{"type":"string","format":"date-time","nullable":true},"GradeWithheldSince":{"type":"string","format":"date-time","nullable":true},"GradeWithheldBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnSince":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"CountResult":{"type":"object","properties":{"Count":{"type":"integer","format":"int32"},"Summary":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/events/registrations/count":{"post":{"tags":["Events API: Registrations"],"summary":"Counts the registrations that match specific criteria","operationId":"countRegistrations","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CountRegistrations"}},"application/json":{"schema":{"$ref":"#/components/schemas/CountRegistrations"}},"text/json":{"schema":{"$ref":"#/components/schemas/CountRegistrations"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CountRegistrations"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/CountResult"}}}}}}}}}
```

## POST /api/events/registrations/download

> Downloads the list of registrations that match specific criteria

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"CollectRegistrations":{"type":"object","properties":{"AttendanceTakenSince":{"type":"string","format":"date-time","nullable":true},"AttendanceTakenBefore":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedSince":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedBefore":{"type":"string","format":"date-time","nullable":true},"GradeAssignedSince":{"type":"string","format":"date-time","nullable":true},"GradeAssignedBefore":{"type":"string","format":"date-time","nullable":true},"GradePublishedSince":{"type":"string","format":"date-time","nullable":true},"GradePublishedBefore":{"type":"string","format":"date-time","nullable":true},"GradeReleasedSince":{"type":"string","format":"date-time","nullable":true},"GradeReleasedBefore":{"type":"string","format":"date-time","nullable":true},"GradeWithheldSince":{"type":"string","format":"date-time","nullable":true},"GradeWithheldBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnSince":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}},"paths":{"/api/events/registrations/download":{"post":{"tags":["Events API: Registrations"],"summary":"Downloads the list of registrations that match specific criteria","operationId":"downloadRegistrations","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CollectRegistrations"}},"application/json":{"schema":{"$ref":"#/components/schemas/CollectRegistrations"}},"text/json":{"schema":{"$ref":"#/components/schemas/CollectRegistrations"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CollectRegistrations"}}}},"responses":{"200":{"description":"OK"}}}}}}
```

## POST /api/events/registrations/search

> Searches for the list of registrations that match specific criteria

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"SearchRegistrations":{"type":"object","properties":{"AttendanceTakenSince":{"type":"string","format":"date-time","nullable":true},"AttendanceTakenBefore":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedSince":{"type":"string","format":"date-time","nullable":true},"DistributionExpectedBefore":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedSince":{"type":"string","format":"date-time","nullable":true},"EligibilityUpdatedBefore":{"type":"string","format":"date-time","nullable":true},"GradeAssignedSince":{"type":"string","format":"date-time","nullable":true},"GradeAssignedBefore":{"type":"string","format":"date-time","nullable":true},"GradePublishedSince":{"type":"string","format":"date-time","nullable":true},"GradePublishedBefore":{"type":"string","format":"date-time","nullable":true},"GradeReleasedSince":{"type":"string","format":"date-time","nullable":true},"GradeReleasedBefore":{"type":"string","format":"date-time","nullable":true},"GradeWithheldSince":{"type":"string","format":"date-time","nullable":true},"GradeWithheldBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnSince":{"type":"string","format":"date-time","nullable":true},"RegistrationRequestedOnBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"RegistrationMatch":{"type":"object","properties":{"RegistrationIdentifier":{"type":"string","format":"uuid"}},"additionalProperties":false}}},"paths":{"/api/events/registrations/search":{"post":{"tags":["Events API: Registrations"],"summary":"Searches for the list of registrations that match specific criteria","operationId":"searchRegistrations","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/SearchRegistrations"}},"application/json":{"schema":{"$ref":"#/components/schemas/SearchRegistrations"}},"text/json":{"schema":{"$ref":"#/components/schemas/SearchRegistrations"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/SearchRegistrations"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegistrationMatch"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RegistrationMatch"}}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shiftiq.com/developers/api-v2/navigating-the-api/events-api-registrations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.