POST api/v1/candidates/{candidateUid}/industrydisciplines
Creates the candidate industry discipline.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| candidateUid |
The candidate UID. |
globally unique identifier |
Required |
Body Parameters
The candidate industry discipline.
CandidateIndustryDiscipline| Name | Description | Type | Additional information |
|---|---|---|---|
| Industry |
The industry name. |
string |
String length: inclusive between 0 and 100 |
| Discipline |
The discipline name. |
string |
String length: inclusive between 0 and 100 |
| SubDiscipline |
The sub discipline name. |
string |
String length: inclusive between 0 and 100 |
| Primary |
Is this the primary industry / discipline |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Industry": "sample string 1",
"Discipline": "sample string 2",
"SubDiscipline": "sample string 3",
"Primary": true
}
application/xml, text/xml
Sample:
<CandidateIndustryDiscipline xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models"> <Discipline>sample string 2</Discipline> <Industry>sample string 1</Industry> <Primary>true</Primary> <SubDiscipline>sample string 3</SubDiscipline> </CandidateIndustryDiscipline>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the created candidate industry discipline.
CandidateIndustryDisciplineViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Candidate |
The candidate. |
CandidateViewModel |
None. |
| Industry |
The name. |
string |
None. |
| Discipline |
The discipline. |
string |
None. |
| SubDiscipline |
The sub discipline. |
string |
None. |
| Primary |
Is this the primary industry discipline |
boolean |
None. |
| CandidateIndustryDisciplineGuid |
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-10-27T13:59:52.5286649+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": "9d704246-b794-48ab-96a1-7ef111859ffd",
"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-10-27T13:59:52.5286649+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "2249923d-d5b7-4932-8690-4ada6bcb0b37",
"Uid": "a07f9b00-950f-4cf8-9a6f-6f2551423284",
"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-10-27T13:59:52.5286649+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "809f1808-1b95-4fb8-a02c-817cd72fa3de",
"PortalGuid": "71c0f9dd-540f-4441-bb1d-0e961679ad16",
"CompanyGuid": "bd227f82-808e-4eab-99d8-e9f2310fb5ea",
"Uid": "13f4c00b-ec1a-4afa-b3b9-8a216ad694c4",
"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-10-27T13:59:52.5286649+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-10-27T13:59:52.5286649+00:00",
"ComplianceExpires": "2025-10-27T13:59:52.5286649+00:00",
"CandidateGuid": "6ef3f98d-cac8-4496-b391-ca866d3c6f7e",
"DateOfBirth": "2025-10-27T13:59:52.5286649+00:00",
"Nationality": "sample string 29",
"EmploymentSought": "sample string 30",
"MinAnnualSalary": 31.1,
"MaxAnnualSalary": 32.1,
"MinHourlyPayrate": 33.1,
"MaxHourlyPayrate": 34.1,
"Uid": "6f077563-602c-4fed-8965-004f509b34c4",
"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-10-27T13:59:52.5286649+00:00",
"UpdatedBy": "sample string 36"
},
"Industry": "sample string 1",
"Discipline": "sample string 2",
"SubDiscipline": "sample string 3",
"Primary": true,
"CandidateIndustryDisciplineGuid": "cd1dbf82-691b-4e93-810d-c86a29d374d0",
"Uid": "0943ef31-5ff6-41b3-bfd8-cebabb023c05",
"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-10-27T13:59:52.5286649+00:00",
"UpdatedBy": "sample string 7"
}
application/xml, text/xml
Sample:
<CandidateIndustryDisciplineViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-10-27T13:59:52.5286649+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>0943ef31-5ff6-41b3-bfd8-cebabb023c05</Uid>
<UpdatedBy>sample string 7</UpdatedBy>
<Candidate>
<DateUpdated>2025-10-27T13:59:52.5286649+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>6f077563-602c-4fed-8965-004f509b34c4</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>6ef3f98d-cac8-4496-b391-ca866d3c6f7e</CandidateGuid>
<Company>
<DateUpdated>2025-10-27T13:59:52.5286649+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>13f4c00b-ec1a-4afa-b3b9-8a216ad694c4</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>bd227f82-808e-4eab-99d8-e9f2310fb5ea</CompanyGuid>
<Country>
<DateUpdated>2025-10-27T13:59:52.5286649+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>a07f9b00-950f-4cf8-9a6f-6f2551423284</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>2249923d-d5b7-4932-8690-4ada6bcb0b37</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-10-27T13:59:52.5286649+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>9d704246-b794-48ab-96a1-7ef111859ffd</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>71c0f9dd-540f-4441-bb1d-0e961679ad16</PortalGuid>
<PortalUid>809f1808-1b95-4fb8-a02c-817cd72fa3de</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<ComplianceExpires>2025-10-27T13:59:52.5286649+00:00</ComplianceExpires>
<Country>sample string 10</Country>
<DateOfBirth>2025-10-27T13:59:52.5286649+00:00</DateOfBirth>
<EarliestStartDate>2025-10-27T13:59:52.5286649+00:00</EarliestStartDate>
<EclipseLastUpdated>2025-10-27T13:59:52.5286649+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>
<CandidateIndustryDisciplineGuid>cd1dbf82-691b-4e93-810d-c86a29d374d0</CandidateIndustryDisciplineGuid>
<Discipline>sample string 2</Discipline>
<Industry>sample string 1</Industry>
<Primary>true</Primary>
<SubDiscipline>sample string 3</SubDiscipline>
</CandidateIndustryDisciplineViewModel>