DEdepartment-for-education
Schools Experience

Retrieves a pre-populated SchoolsExperienceSignUp for the candidate.

            Retrieves a pre-populated SchoolsExperienceSignUp 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/schools_experience/candidates/exchange_access_token/{accessToken}

Request

  • Base URL
    https://getintoteachingapi-production.teacherservices.cloud (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

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
preferredTeachingSubjectIdstring uuid required
secondaryPreferredTeachingSubjectIdstring uuid nullable
acceptedPolicyIdstring uuid required
masterIdstring uuid nullable
mergedboolean
fullNamestring nullable
emailstring required
firstNamestring required
lastNamestring required
addressLine1string required
addressLine2string nullable
addressLine3string nullable
addressCitystring required
addressStateOrProvincestring required
addressPostcodestring required
telephonestring required
hasDbsCertificateboolean required
dbsCertificateIssuedAtstring date-time nullable
qualificationIdstring uuid nullable
degreeStatusIdinteger nullable
degreeTypeIdinteger nullable
degreeSubjectstring nullable
ukDegreeGradeIdinteger nullable
creationChannelSourceIdinteger nullable
creationChannelServiceIdinteger nullable
creationChannelActivityIdinteger nullable
defaultContactCreationChannelinteger nullable
defaultCreationChannelSourceIdinteger nullable
defaultCreationChannelServiceIdinteger nullable
defaultCreationChannelActivityIdinteger nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.