v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB

Entity

Adds a referee to an existing candidate

The Referee's Surname and RefereeType value must be passed.

Company and JobTitle are not supported if the RefereeType is InCaseOfEmergencyContact

Although Checked is optional, if set to true then the CheckedDate must also be passed.

post/Entity/Referee

CandidateIdinteger required

RefereeType'InCaseOfEmergencyContact' | 'PersonalReference' | 'EmployerReference' | 'AcademicReference' | 'VoluntaryReference' required

TitleIdinteger nullable

Forenamestring nullable

Surnamestring required

Relationshipstring nullable

Companystring nullable

JobTitlestring nullable

AddressLine1string nullable

AddressLine2string nullable

AddressLine3string nullable

Townstring nullable

Countystring nullable

Postcodestring nullable

CountryIdinteger nullable

Mobilestring nullable

Landlinestring nullable

Emailstring nullable

Notesstring nullable

Checkedboolean

CheckedDatestring date-time nullable

OK - Created ID

integer required