GET api/DSM/Candidate

Used to fetch Candidate information by using email

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

COMPLETE

Candidate

Name	Description	Type	Additional information
CandidateId	This is Candidate Id	integer	None.
CandidateCode	This is Candidate Code	string	None.
ExternalCode	This is Candidate external Code (Code displayed on Stratos)	string	None.
FirstName	This is Candidate first name	string	None.
LastName	This is Candidate Last name	string	None.
JobTitle	This is Candidate job title	string	None.
Email	This is Candidate email	string	None.
Mobile	This is Candidate mobile no	string	None.
AddressLine1	This is Candidate address line 1	string	None.
AddressLine2	This is Candidate address line 2	string	None.
Suburb	This is Candidate suburb	string	None.
State	This is Candidate state	string	None.
Postcode	This is Candidate postcode	string	None.
Country	This is Candidate country	string	None.
Proximity	This is Candidate proximity	string	None.
Lat	This is Candidate latitude coordinate	string	None.
Lng	This is Candidate longitude coordinate	string	None.
Branch	This is Candidate branch	string	None.
Division	This is Candidate division	string	None.
DivisionGroup	This is Candidate division group	string	None.
CandidateStatus	This is Candidate status	string	None.
Dob	This is Candidate DOB	date	None.
PoliceCheckDate	This is Candidate police check date	date	None.
ReferenceCheckDate	This is Candidate reference check date	date	None.
ReferenceCheckCount	This is Candidate reference check count	integer	None.
IsBankDetailAvailable	This is Candidate bak detail availability	boolean	None.
IsActive	This is Candidate active indicator	boolean	None.
CreatedOn	This is Candidate created date	date	None.
LastUpdatedON	This is Candidate updated date	date	None.
CreatedBy	This is Candidate created by email	string	None.
LastUpdatedBy	This is Candidate last updated by email	string	None.
CandidateBranches	This is Candidate list of assigned branches	Collection of CandidateBranch	None.
CandidateDivisions	This is Candidate list of assigned divisions	Collection of CandidateDivision	None.
CandidateFilter	This is CandidateFilter	CandidateFilter	None.
systemMode		integer	None.
systemModeCode		string	None.

Response Formats

application/json, text/json

Sample:

{
  "CandidateId": 1,
  "CandidateCode": "sample string 2",
  "ExternalCode": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "JobTitle": "sample string 6",
  "Email": "sample string 7",
  "Mobile": "sample string 8",
  "AddressLine1": "sample string 9",
  "AddressLine2": "sample string 10",
  "Suburb": "sample string 11",
  "State": "sample string 12",
  "Postcode": "sample string 13",
  "Country": "sample string 14",
  "Proximity": "sample string 15",
  "Lat": "sample string 16",
  "Lng": "sample string 17",
  "Branch": "sample string 18",
  "Division": "sample string 19",
  "DivisionGroup": "sample string 20",
  "CandidateStatus": "sample string 21",
  "Dob": "2024-06-29T07:18:10.0227947+10:00",
  "PoliceCheckDate": "2024-06-29T07:18:10.0227947+10:00",
  "ReferenceCheckDate": "2024-06-29T07:18:10.0227947+10:00",
  "ReferenceCheckCount": 25,
  "IsBankDetailAvailable": true,
  "IsActive": true,
  "CreatedOn": "2024-06-29T07:18:10.0227947+10:00",
  "LastUpdatedON": "2024-06-29T07:18:10.0227947+10:00",
  "CreatedBy": "sample string 30",
  "LastUpdatedBy": "sample string 31",
  "CandidateBranches": [
    {
      "CandidateBranchId": 1,
      "CandidateId": 2,
      "Branch": "sample string 3"
    },
    {
      "CandidateBranchId": 1,
      "CandidateId": 2,
      "Branch": "sample string 3"
    }
  ],
  "CandidateDivisions": [
    {
      "CandidateDivisionId": 1,
      "CandidateId": 2,
      "Division": "sample string 3"
    },
    {
      "CandidateDivisionId": 1,
      "CandidateId": 2,
      "Division": "sample string 3"
    }
  ],
  "CandidateFilter": {
    "JobTitle": [
      "sample string 1",
      "sample string 2"
    ],
    "Distance": "sample string 1",
    "StartDate": "sample string 2",
    "EndDate": "sample string 3",
    "ShowPreferredSites": true
  },
  "systemMode": 32,
  "systemModeCode": "sample string 33"
}

text/xml

Sample:

<Candidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DSM">
  <AddressLine1>sample string 9</AddressLine1>
  <AddressLine2>sample string 10</AddressLine2>
  <Branch>sample string 18</Branch>
  <CandidateBranches>
    <CandidateBranch>
      <Branch>sample string 3</Branch>
      <CandidateBranchId>1</CandidateBranchId>
      <CandidateId>2</CandidateId>
    </CandidateBranch>
    <CandidateBranch>
      <Branch>sample string 3</Branch>
      <CandidateBranchId>1</CandidateBranchId>
      <CandidateId>2</CandidateId>
    </CandidateBranch>
  </CandidateBranches>
  <CandidateCode>sample string 2</CandidateCode>
  <CandidateDivisions>
    <CandidateDivision>
      <CandidateDivisionId>1</CandidateDivisionId>
      <CandidateId>2</CandidateId>
      <Division>sample string 3</Division>
    </CandidateDivision>
    <CandidateDivision>
      <CandidateDivisionId>1</CandidateDivisionId>
      <CandidateId>2</CandidateId>
      <Division>sample string 3</Division>
    </CandidateDivision>
  </CandidateDivisions>
  <CandidateFilter>
    <Distance>sample string 1</Distance>
    <EndDate>sample string 3</EndDate>
    <JobTitle xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </JobTitle>
    <ShowPreferredSites>true</ShowPreferredSites>
    <StartDate>sample string 2</StartDate>
  </CandidateFilter>
  <CandidateId>1</CandidateId>
  <CandidateStatus>sample string 21</CandidateStatus>
  <Country>sample string 14</Country>
  <CreatedBy>sample string 30</CreatedBy>
  <CreatedOn>2024-06-29T07:18:10.0227947+10:00</CreatedOn>
  <Division>sample string 19</Division>
  <DivisionGroup>sample string 20</DivisionGroup>
  <Dob>2024-06-29T07:18:10.0227947+10:00</Dob>
  <Email>sample string 7</Email>
  <ExternalCode>sample string 3</ExternalCode>
  <FirstName>sample string 4</FirstName>
  <IsActive>true</IsActive>
  <IsBankDetailAvailable>true</IsBankDetailAvailable>
  <JobTitle>sample string 6</JobTitle>
  <LastName>sample string 5</LastName>
  <LastUpdatedBy>sample string 31</LastUpdatedBy>
  <LastUpdatedON>2024-06-29T07:18:10.0227947+10:00</LastUpdatedON>
  <Lat>sample string 16</Lat>
  <Lng>sample string 17</Lng>
  <Mobile>sample string 8</Mobile>
  <PoliceCheckDate>2024-06-29T07:18:10.0227947+10:00</PoliceCheckDate>
  <Postcode>sample string 13</Postcode>
  <Proximity>sample string 15</Proximity>
  <ReferenceCheckCount>25</ReferenceCheckCount>
  <ReferenceCheckDate>2024-06-29T07:18:10.0227947+10:00</ReferenceCheckDate>
  <State>sample string 12</State>
  <Suburb>sample string 11</Suburb>
  <SystemMode>32</SystemMode>
  <SystemModeCode>sample string 33</SystemModeCode>
</Candidate>

multipart/form-data

Sample:

<Candidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DSM"><AddressLine1>sample string 9</AddressLine1><AddressLine2>sample string 10</AddressLine2><Branch>sample string 18</Branch><CandidateBranches><CandidateBranch><Branch>sample string 3</Branch><CandidateBranchId>1</CandidateBranchId><CandidateId>2</CandidateId></CandidateBranch><CandidateBranch><Branch>sample string 3</Branch><CandidateBranchId>1</CandidateBranchId><CandidateId>2</CandidateId></CandidateBranch></CandidateBranches><CandidateCode>sample string 2</CandidateCode><CandidateDivisions><CandidateDivision><CandidateDivisionId>1</CandidateDivisionId><CandidateId>2</CandidateId><Division>sample string 3</Division></CandidateDivision><CandidateDivision><CandidateDivisionId>1</CandidateDivisionId><CandidateId>2</CandidateId><Division>sample string 3</Division></CandidateDivision></CandidateDivisions><CandidateFilter><Distance>sample string 1</Distance><EndDate>sample string 3</EndDate><JobTitle xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></JobTitle><ShowPreferredSites>true</ShowPreferredSites><StartDate>sample string 2</StartDate></CandidateFilter><CandidateId>1</CandidateId><CandidateStatus>sample string 21</CandidateStatus><Country>sample string 14</Country><CreatedBy>sample string 30</CreatedBy><CreatedOn>2024-06-29T07:18:10.0227947+10:00</CreatedOn><Division>sample string 19</Division><DivisionGroup>sample string 20</DivisionGroup><Dob>2024-06-29T07:18:10.0227947+10:00</Dob><Email>sample string 7</Email><ExternalCode>sample string 3</ExternalCode><FirstName>sample string 4</FirstName><IsActive>true</IsActive><IsBankDetailAvailable>true</IsBankDetailAvailable><JobTitle>sample string 6</JobTitle><LastName>sample string 5</LastName><LastUpdatedBy>sample string 31</LastUpdatedBy><LastUpdatedON>2024-06-29T07:18:10.0227947+10:00</LastUpdatedON><Lat>sample string 16</Lat><Lng>sample string 17</Lng><Mobile>sample string 8</Mobile><PoliceCheckDate>2024-06-29T07:18:10.0227947+10:00</PoliceCheckDate><Postcode>sample string 13</Postcode><Proximity>sample string 15</Proximity><ReferenceCheckCount>25</ReferenceCheckCount><ReferenceCheckDate>2024-06-29T07:18:10.0227947+10:00</ReferenceCheckDate><State>sample string 12</State><Suburb>sample string 11</Suburb><SystemMode>32</SystemMode><SystemModeCode>sample string 33</SystemModeCode></Candidate>