Sign in

v1

latestOpenAPI 3.0.4MIT License2026-07-236622149.8 KB
Schools Experience

Sign up a candidate for the Schools Experience service.

            Upsert a candidate. Returns the updated candidate information in the body of the response along 
            with a Location header which specifies the location of the candidate
post/api/schools_experience/candidates

Request body

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

Response

Created

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