GET api/clients/reference/{referenceId}
return a saved reference details by referenceId
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| referenceId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ReferenceDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| CandidateId | string |
None. |
|
| FirstName | string |
Required |
|
| LastName | string |
None. |
|
| string |
Required |
||
| Phone | string |
None. |
|
| DateFrom | date |
Required |
|
| DateTo | date |
None. |
|
| Subjects | string |
None. |
|
| AgeGroup | string |
None. |
|
| ComplianceTypeId | integer |
None. |
|
| ReferenceTypeId | integer |
None. |
|
| CreatedOn | date |
None. |
|
| CreatedBy | string |
None. |
|
| Candidate | CandidateDTO |
None. |
|
| ComplianceType | ComplianceTypeDTO |
None. |
|
| ScorePupilRelationship | ReferenceScore |
None. |
|
| ScoreColleagueRelationship | ReferenceScore |
None. |
|
| ScoreAttendance | ReferenceScore |
None. |
|
| ScoreKnowledge | ReferenceScore |
None. |
|
| ScorePlanning | ReferenceScore |
None. |
|
| ScoreComms | ReferenceScore |
None. |
|
| ReEmploy | ReferenceYesNoField |
None. |
|
| Safeguard | ReferenceYesNoField |
None. |
|
| SafeguardNotes | string |
None. |
|
| ReceivedOn | date |
None. |
|
| OrganisationName | string |
None. |
|
| JobTitle | string |
None. |
|
| AdditionalNotes | string |
None. |
|
| Source | ReferenceSource |
None. |
|
| Status | ReferenceStatus |
None. |
|
| RequestedOn | date |
None. |
|
| RequestedByUserId | string |
None. |
|
| RequestedBy | UserDTO |
None. |
|
| Role | string |
None. |
|
| MemberJobTitle | string |
None. |
|
| ReferenceType | ReferenceTypeDTO |
None. |
|
| ReferenceDocuments | Collection of ReferenceDocumentDTO |
None. |
|
| ReferenceRequests | Collection of ReferenceRequestDTO |
None. |
|
| AgreeShareWithCandidate | boolean |
None. |
|
| AgreeShareWithSchools | boolean |
None. |
|
| Notes | string |
None. |
|
| key | string |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.