Sign in

v1

latestOpenAPI 3.0.4MIT License2026-07-236622149.8 KB
Teaching Events

Retrieves a pre-populated TeachingEventAddAttendee for the candidate.

            Retrieves a pre-populated TeachingEventAddAttendee for the candidate. The `accessToken` is obtained from a 
            `POST /candidates/access_tokens` request (you must also ensure the `ExistingCandidateRequest` payload you 
            exchanged for your token matches the request payload here).
post/api/teaching_events/attendees/exchange_access_token/{accessToken}

Path parameters

accessTokenstring required

Access token (PIN code).

Request body

firstNamestring nullable
lastNamestring nullable
emailstring email required
dateOfBirthstring date-time nullable
referencestring nullable

Response

OK

candidateIdstring uuid nullable
qualificationIdstring uuid nullable
eventIdstring uuid required
channelIdinteger nullable
creationChannelSourceIdinteger nullable
creationChannelServiceIdinteger nullable
creationChannelActivityIdinteger nullable
acceptedPolicyIdstring uuid required
preferredTeachingSubjectIdstring uuid nullable
considerationJourneyStageIdinteger nullable
degreeStatusIdinteger nullable
emailstring required
firstNamestring required
lastNamestring required
addressPostcodestring nullable
addressTelephonestring nullable
isVerifiedboolean
isWalkInboolean
subscribeToMailingListboolean
alreadySubscribedToEventsboolean
alreadySubscribedToMailingListboolean
alreadySubscribedToTeacherTrainingAdviserboolean
defaultContactCreationChannelinteger nullable
defaultCreationChannelSourceIdinteger nullable
defaultCreationChannelServiceIdinteger nullable
defaultCreationChannelActivityIdinteger nullable
accessibilityNeedsForEventstring nullable