GET api/v1/candidates/cv/{candidateCvUid}
Gets the candidate CV by the specified candidate CV UID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| candidateCvUid |
The candidate CV UID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the candidate CV.
CandidateCvViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Candidate |
The candidate. |
CandidateViewModel |
None. |
| Name |
The name. |
string |
None. |
| Attachment |
The attachment. |
AttachmentViewModel |
None. |
| OriginalFileName |
The name of the original file. |
string |
None. |
| DateCreated |
The date/time the cv was created. |
date |
None. |
| CandidateCVGuid |
The uniqie identifier |
globally unique identifier |
None. |
| Uid |
The GUID. |
globally unique identifier |
None. |
| Links |
The links. |
Collection of Link |
None. |
| DateUpdated |
Last time the record was updated |
date |
None. |
| UpdatedBy |
Who updated the record last |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Candidate": {
"Title": "sample string 1",
"Forename": "sample string 2",
"Surname": "sample string 3",
"OtherNames": "sample string 4",
"AddressLine1": "sample string 5",
"AddressLine2": "sample string 6",
"AddressLine3": "sample string 7",
"AddressLine4": "sample string 8",
"PostCode": "sample string 9",
"Country": "sample string 10",
"Telephone": "sample string 11",
"Mobile": "sample string 12",
"Email": "sample string 13",
"Position": "sample string 14",
"Term": "sample string 15",
"EarliestStartDate": "2025-12-21T17:53:45.0375172+00:00",
"Company": {
"Name": "sample string 1",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"PostCode": "sample string 6",
"Country": {
"Iso3Code": "sample string 1",
"Name": "sample string 2",
"Portal": {
"Name": "sample string 1",
"Uid": "31147c28-abad-49d7-aadc-e432ca43e449",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:45.0375172+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "fb35d8dd-3ce4-44fa-84ff-e651e2c29871",
"Uid": "4ae8ebc3-993d-4aad-abfe-9ea6b78b5286",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:45.0375172+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "04c012d0-93f7-4bc1-a503-2de710902fca",
"PortalGuid": "fab2cb92-f986-4b85-b206-014e7721a5ef",
"CompanyGuid": "2ab2854c-c4ca-43cd-8648-2634b446d82d",
"Uid": "3413c578-290f-43d1-8abd-f13f0df38434",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:45.0375172+00:00",
"UpdatedBy": "sample string 13"
},
"ReferenceNumber": "sample string 16",
"PrimaryIndustry": "sample string 17",
"PrimaryDiscipline": "sample string 18",
"PrimarySubDiscipline": "sample string 19",
"IsPrimaryIndustryDiscipline": true,
"PersonalStatement": "sample string 21",
"Latitude": 1.1,
"Longitude": 1.1,
"ReferralSource": "sample string 22",
"Gender": "sample string 23",
"Location": "sample string 24",
"Area": "sample string 25",
"Region": "sample string 26",
"EclipseStatus": "sample string 27",
"EclipseLastUpdated": "2025-12-21T17:53:45.0375172+00:00",
"ComplianceExpires": "2025-12-21T17:53:45.0375172+00:00",
"CandidateGuid": "6b10c61d-2bae-49cf-bef8-f41353b4da5f",
"DateOfBirth": "2025-12-21T17:53:45.0375172+00:00",
"Nationality": "sample string 29",
"EmploymentSought": "sample string 30",
"MinAnnualSalary": 31.1,
"MaxAnnualSalary": 32.1,
"MinHourlyPayrate": 33.1,
"MaxHourlyPayrate": 34.1,
"Uid": "681cfc06-d49c-4186-ada5-b21dcc641329",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:45.0375172+00:00",
"UpdatedBy": "sample string 36"
},
"Name": "sample string 1",
"Attachment": {
"Binary": "QEA=",
"FileName": "sample string 1",
"ContentType": "sample string 2",
"Uid": "c4ace4af-c6ef-4674-b821-d3eb4764ee23",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:45.0375172+00:00",
"UpdatedBy": "sample string 4"
},
"OriginalFileName": "sample string 2",
"DateCreated": "2025-12-21T17:53:45.0375172+00:00",
"CandidateCVGuid": "12ed8a7a-7843-40f0-a162-75f462fe34a3",
"Uid": "5807a41c-0c09-40bc-8070-03a8e181dd22",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:45.0375172+00:00",
"UpdatedBy": "sample string 5"
}
application/xml, text/xml
Sample:
<CandidateCvViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-12-21T17:53:45.0375172+00:00</DateUpdated>
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
</Links>
<Uid>5807a41c-0c09-40bc-8070-03a8e181dd22</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<Attachment>
<DateUpdated>2025-12-21T17:53:45.0375172+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>c4ace4af-c6ef-4674-b821-d3eb4764ee23</Uid>
<UpdatedBy>sample string 4</UpdatedBy>
<Binary>QEA=</Binary>
<ContentType>sample string 2</ContentType>
<FileName>sample string 1</FileName>
</Attachment>
<Candidate>
<DateUpdated>2025-12-21T17:53:45.0375172+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>681cfc06-d49c-4186-ada5-b21dcc641329</Uid>
<UpdatedBy>sample string 36</UpdatedBy>
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<AddressLine4>sample string 8</AddressLine4>
<Area>sample string 25</Area>
<CandidateGuid>6b10c61d-2bae-49cf-bef8-f41353b4da5f</CandidateGuid>
<Company>
<DateUpdated>2025-12-21T17:53:45.0375172+00:00</DateUpdated>
<Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d4p1:Link>
<d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
<d4p1:Method>sample string 2</d4p1:Method>
<d4p1:Rel>sample string 3</d4p1:Rel>
<d4p1:Title>sample string 4</d4p1:Title>
<d4p1:Type>sample string 5</d4p1:Type>
</d4p1:Link>
<d4p1:Link>
<d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
<d4p1:Method>sample string 2</d4p1:Method>
<d4p1:Rel>sample string 3</d4p1:Rel>
<d4p1:Title>sample string 4</d4p1:Title>
<d4p1:Type>sample string 5</d4p1:Type>
</d4p1:Link>
</Links>
<Uid>3413c578-290f-43d1-8abd-f13f0df38434</Uid>
<UpdatedBy>sample string 13</UpdatedBy>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<CompanyGuid>2ab2854c-c4ca-43cd-8648-2634b446d82d</CompanyGuid>
<Country>
<DateUpdated>2025-12-21T17:53:45.0375172+00:00</DateUpdated>
<Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
</Links>
<Uid>4ae8ebc3-993d-4aad-abfe-9ea6b78b5286</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>fb35d8dd-3ce4-44fa-84ff-e651e2c29871</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-12-21T17:53:45.0375172+00:00</DateUpdated>
<Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d6p1:Link>
<d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
<d6p1:Method>sample string 2</d6p1:Method>
<d6p1:Rel>sample string 3</d6p1:Rel>
<d6p1:Title>sample string 4</d6p1:Title>
<d6p1:Type>sample string 5</d6p1:Type>
</d6p1:Link>
<d6p1:Link>
<d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
<d6p1:Method>sample string 2</d6p1:Method>
<d6p1:Rel>sample string 3</d6p1:Rel>
<d6p1:Title>sample string 4</d6p1:Title>
<d6p1:Type>sample string 5</d6p1:Type>
</d6p1:Link>
</Links>
<Uid>31147c28-abad-49d7-aadc-e432ca43e449</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</Country>
<Latitude>sample string 7</Latitude>
<Longitude>sample string 8</Longitude>
<Name>sample string 1</Name>
<PortalGuid>fab2cb92-f986-4b85-b206-014e7721a5ef</PortalGuid>
<PortalUid>04c012d0-93f7-4bc1-a503-2de710902fca</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<ComplianceExpires>2025-12-21T17:53:45.0375172+00:00</ComplianceExpires>
<Country>sample string 10</Country>
<DateOfBirth>2025-12-21T17:53:45.0375172+00:00</DateOfBirth>
<EarliestStartDate>2025-12-21T17:53:45.0375172+00:00</EarliestStartDate>
<EclipseLastUpdated>2025-12-21T17:53:45.0375172+00:00</EclipseLastUpdated>
<EclipseStatus>sample string 27</EclipseStatus>
<Email>sample string 13</Email>
<EmploymentSought>sample string 30</EmploymentSought>
<Forename>sample string 2</Forename>
<Gender>sample string 23</Gender>
<IsPrimaryIndustryDiscipline>true</IsPrimaryIndustryDiscipline>
<Latitude>1.1</Latitude>
<Location>sample string 24</Location>
<Longitude>1.1</Longitude>
<MaxAnnualSalary>32.1</MaxAnnualSalary>
<MaxHourlyPayrate>34.1</MaxHourlyPayrate>
<MinAnnualSalary>31.1</MinAnnualSalary>
<MinHourlyPayrate>33.1</MinHourlyPayrate>
<Mobile>sample string 12</Mobile>
<Nationality>sample string 29</Nationality>
<OtherNames>sample string 4</OtherNames>
<PersonalStatement>sample string 21</PersonalStatement>
<Position>sample string 14</Position>
<PostCode>sample string 9</PostCode>
<PrimaryDiscipline>sample string 18</PrimaryDiscipline>
<PrimaryIndustry>sample string 17</PrimaryIndustry>
<PrimarySubDiscipline>sample string 19</PrimarySubDiscipline>
<ReferenceNumber>sample string 16</ReferenceNumber>
<ReferralSource>sample string 22</ReferralSource>
<Region>sample string 26</Region>
<Surname>sample string 3</Surname>
<Telephone>sample string 11</Telephone>
<Term>sample string 15</Term>
<Title>sample string 1</Title>
</Candidate>
<CandidateCVGuid>12ed8a7a-7843-40f0-a162-75f462fe34a3</CandidateCVGuid>
<DateCreated>2025-12-21T17:53:45.0375172+00:00</DateCreated>
<Name>sample string 1</Name>
<OriginalFileName>sample string 2</OriginalFileName>
</CandidateCvViewModel>