POST api/v1/portals/{portalUid}/candidates/registration

Registers a candidate for the Eclipse Web API.

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	The portal UID.	globally unique identifier	Required

Body Parameters

The candidate registration.

CandidateRegistration

Name	Description	Type	Additional information
Logon	The logon.	string	Required Data type: EmailAddress String length: inclusive between 0 and 255
Password	The password.	string	Required Data type: Password String length: inclusive between 0 and 255
Title	The title.	string	Data type: Text String length: inclusive between 0 and 100
Forename	The forename.	string	Required Data type: Text String length: inclusive between 0 and 100
Surname	The surname.	string	Required Data type: Text String length: inclusive between 0 and 100
OtherNames	The other names.	string	Data type: Text String length: inclusive between 0 and 100
AddressLine1	The address line1.	string	Data type: Text String length: inclusive between 0 and 100
AddressLine2	The address line2.	string	Data type: Text String length: inclusive between 0 and 100
AddressLine3	The address line3.	string	Data type: Text String length: inclusive between 0 and 100
AddressLine4	The address line4.	string	Data type: Text String length: inclusive between 0 and 100
PostCode	The post code.	string	Data type: PostalCode String length: inclusive between 0 and 50
Country	The post code.	string	Data type: Text String length: inclusive between 0 and 100
Telephone	The telephone.	string	Data type: PhoneNumber String length: inclusive between 0 and 100
Mobile	The mobile.	string	Data type: PhoneNumber String length: inclusive between 0 and 100
Position	The candidate employment position.	string	Data type: Text String length: inclusive between 0 and 100
Term	The candidate employment term.	string	Data type: Text String length: inclusive between 0 and 100
EarliestStartDate		date	Data type: DateTime
Company	The company.	globally unique identifier	Required
Industry	The name.	string	Data type: Text String length: inclusive between 0 and 100
Discipline	The discipline.	string	Data type: Text String length: inclusive between 0 and 100
SubDiscipline	The sub discipline.	string	Data type: Text String length: inclusive between 0 and 100
ReferralSource	The candidate referral source	string	Data type: Text String length: inclusive between 0 and 100
DateOfBirth	The candidates dob	date	None.
Nationality	The candidates nationality	string	Data type: Text String length: inclusive between 0 and 100
Gender		string	Data type: Text String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:

{
  "Logon": "sample string 1",
  "Password": "sample string 2",
  "Title": "sample string 3",
  "Forename": "sample string 4",
  "Surname": "sample string 5",
  "OtherNames": "sample string 6",
  "AddressLine1": "sample string 7",
  "AddressLine2": "sample string 8",
  "AddressLine3": "sample string 9",
  "AddressLine4": "sample string 10",
  "PostCode": "sample string 11",
  "Country": "sample string 12",
  "Telephone": "sample string 13",
  "Mobile": "sample string 14",
  "Position": "sample string 15",
  "Term": "sample string 16",
  "EarliestStartDate": "2025-10-27T13:57:38.6115289+00:00",
  "Company": "10a50f5a-93ec-4dad-8d80-ca32bff10292",
  "Industry": "sample string 18",
  "Discipline": "sample string 19",
  "SubDiscipline": "sample string 20",
  "ReferralSource": "sample string 21",
  "DateOfBirth": "2025-10-27T13:57:38.6115289+00:00",
  "Nationality": "sample string 22",
  "Gender": "sample string 23"
}

application/xml, text/xml

Sample:

<CandidateRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <AddressLine1>sample string 7</AddressLine1>
  <AddressLine2>sample string 8</AddressLine2>
  <AddressLine3>sample string 9</AddressLine3>
  <AddressLine4>sample string 10</AddressLine4>
  <Company>10a50f5a-93ec-4dad-8d80-ca32bff10292</Company>
  <Country>sample string 12</Country>
  <DateOfBirth>2025-10-27T13:57:38.6115289+00:00</DateOfBirth>
  <Discipline>sample string 19</Discipline>
  <EarliestStartDate>2025-10-27T13:57:38.6115289+00:00</EarliestStartDate>
  <Forename>sample string 4</Forename>
  <Gender>sample string 23</Gender>
  <Industry>sample string 18</Industry>
  <Logon>sample string 1</Logon>
  <Mobile>sample string 14</Mobile>
  <Nationality>sample string 22</Nationality>
  <OtherNames>sample string 6</OtherNames>
  <Password>sample string 2</Password>
  <Position>sample string 15</Position>
  <PostCode>sample string 11</PostCode>
  <ReferralSource>sample string 21</ReferralSource>
  <SubDiscipline>sample string 20</SubDiscipline>
  <Surname>sample string 5</Surname>
  <Telephone>sample string 13</Telephone>
  <Term>sample string 16</Term>
  <Title>sample string 3</Title>
</CandidateRegistration>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the user confirmation.

UserConfirmationViewModel

Name	Description	Type	Additional information
User	The user.	UserViewModel	None.
Email	The email.	string	None.
RequestGuid	The request GUID.	globally unique identifier	None.
CandidateReference	The candidate reference number, if the user is a candidate and one has been set	string	None.

Response Formats

application/json, text/json

Sample:

{
  "User": {
    "Logon": "sample string 1",
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "OtherNames": "sample string 4",
    "IsConfirmed": true,
    "CandidateReference": "sample string 6",
    "SecretKey2FA": "sample string 7",
    "Is2FASiteWide": true,
    "Uid": "3a4abcb6-b9e0-4c69-91c4-c034b347b91b",
    "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:57:38.6271534+00:00",
    "UpdatedBy": "sample string 10"
  },
  "Email": "sample string 1",
  "RequestGuid": "fbaa1aef-aaa9-43c3-a6cf-59dbd3e29aab",
  "CandidateReference": "sample string 3"
}

application/xml, text/xml

Sample:

<UserConfirmationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <CandidateReference>sample string 3</CandidateReference>
  <Email>sample string 1</Email>
  <RequestGuid>fbaa1aef-aaa9-43c3-a6cf-59dbd3e29aab</RequestGuid>
  <User>
    <DateUpdated>2025-10-27T13:57:38.6271534+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>3a4abcb6-b9e0-4c69-91c4-c034b347b91b</Uid>
    <UpdatedBy>sample string 10</UpdatedBy>
    <CandidateReference>sample string 6</CandidateReference>
    <Forename>sample string 2</Forename>
    <Is2FASiteWide>true</Is2FASiteWide>
    <IsConfirmed>true</IsConfirmed>
    <Logon>sample string 1</Logon>
    <OtherNames>sample string 4</OtherNames>
    <SecretKey2FA>sample string 7</SecretKey2FA>
    <Surname>sample string 3</Surname>
  </User>
</UserConfirmationViewModel>