v1

latestOpenAPI 3.0.4MIT License2026-07-236622149.8 KB
Teacher Training Adviser

Retrieves a pre-populated TeacherTrainingAdviserSignUp for the candidate.

            Retrieves a pre-populated TeacherTrainingAdviserSignUp 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/teacher_training_adviser/candidates/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

degreeStatusIdinteger nullable
candidateIdstring uuid nullable
qualificationIdstring uuid nullable
subjectTaughtIdstring uuid nullable
pastTeachingPositionIdstring uuid nullable
preferredTeachingSubjectIdstring uuid nullable
countryIdstring uuid required
acceptedPolicyIdstring uuid required
typeIdinteger required
ukDegreeGradeIdinteger nullable
degreeTypeIdinteger nullable
initialTeacherTrainingYearIdinteger nullable
stageTaughtIdinteger nullable
preferredEducationPhaseIdinteger nullable
hasGcseMathsAndEnglishIdinteger nullable
hasGcseScienceIdinteger nullable
planningToRetakeGcseMathsAndEnglishIdinteger nullable
planningToRetakeGcseScienceIdinteger nullable
adviserStatusIdinteger nullable
channelIdinteger nullable
degreeCountrystring uuid nullable
creationChannelSourceIdinteger nullable
creationChannelServiceIdinteger nullable
creationChannelActivityIdinteger nullable
emailstring required
firstNamestring required
lastNamestring required
dateOfBirthstring date required
teacherIdstring nullable
degreeSubjectstring nullable
addressTelephonestring nullable
addressPostcodestring nullable
phoneCallScheduledAtstring date-time nullable
canSubscribeToTeacherTrainingAdviserboolean
assignmentStatusIdinteger nullable
defaultContactCreationChannelinteger nullable
defaultCreationChannelSourceIdinteger nullable
defaultCreationChannelServiceIdinteger nullable
defaultCreationChannelActivityIdinteger nullable
graduationYearinteger nullable
inferredGraduationDatestring date-time nullable
situationinteger nullable
citizenshipinteger nullable
visaStatusinteger nullable
locationinteger nullable