GET api/Candidates/{CandidateNo}

Used to fetch a candidate

Request Information

URI Parameters

Name	Description	Type	Additional information
CandidateNo		string	Required

Body Parameters

None.

Response Information

Resource Description

COMPLETE

CandidateDTO

Name	Description	Type	Additional information
CandidateStaus	This is the Candidate's Status	string	None.
Comments	This is the Candidate Comments	string	None.
NextAvailableFrom	This is the date when the Candidate is available for work	date	None.
CandidateName	This is the Candidate Name	CandidateName	None.
CandidatePersonalDetails	This is the Candidate Name	CandidatePersonalDetails	None.
CandidateAddressDetails	This is the Candidate's Address Details	CandidateAddressDetails	None.
CandidateWorkRightsDetails	This is the Candidate's Work Right Details	CandidateWorkRightsDetails	None.
CandidatePreferences	This is the Candidate's Preferences	CandidatePreferences	None.
CandidateWorkExperienceDetails	This is the Candidate's Work Experience Details	CandidateWorkExperienceDetails	None.
CandidateQualificationList		Collection of CandidateQualification	None.
CandidateSkillsList		Collection of CandidateSkills	None.
CandidateLanguageList		Collection of CandidateLanguage	None.
CandidateLicenceList		Collection of CandidateLicence	None.
CandidateDocumentDetailList		Collection of CandidateDocumentDetail	None.
EmailStopFlag	This is Candidate's EmailStopFlag	boolean	None.
EmailBounceBackFlag	This is Candidate's EmailBounceBackFlag	boolean	None.
SMSStopFlag	This is Candidate's SMS StopFlag	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CandidateStaus": "sample string 1",
  "Comments": "sample string 2",
  "NextAvailableFrom": "2024-06-29T07:32:44.4227119+10:00",
  "CandidateName": {
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "Surname": "sample string 4",
    "PreferredName": "sample string 5"
  },
  "CandidatePersonalDetails": {
    "DateOfBirth": "2024-06-29T07:32:44.4227119+10:00",
    "Email": "sample string 1",
    "Phone": "sample string 2",
    "Mobile": "sample string 3",
    "Gender": "sample string 4",
    "MaritalStatus": "sample string 5",
    "EmergencyContactName": "sample string 6",
    "EmergencyContactNumber": "sample string 7",
    "AboriginalOrTorresStraitIslander": true
  },
  "CandidateAddressDetails": {
    "UseMyResidentialAddress": true,
    "CandidateResidentialAddress": {
      "AddressLineOne": "sample string 1",
      "AddressLineTwo": "sample string 2",
      "Suburb": "sample string 3",
      "State": "sample string 4",
      "PostCode": "sample string 5",
      "Country": "sample string 6"
    },
    "CandidatePostalAddress": {
      "AddressLineOne": "sample string 1",
      "AddressLineTwo": "sample string 2",
      "Suburb": "sample string 3",
      "State": "sample string 4",
      "PostCode": "sample string 5",
      "Country": "sample string 6"
    }
  },
  "CandidateWorkRightsDetails": {
    "CitizenshipCountry": "sample string 1",
    "VisaType": "sample string 2",
    "VisaExpiryDate": "2024-06-29T07:32:44.4234985+10:00",
    "WorkRightsAndIdentificationList": [
      {
        "WorkRightsDocumentType": "sample string 1",
        "WorkRightsReferenceNumber": "sample string 2",
        "WorkRightsExpiryDate": "2024-06-29T07:32:44.4234985+10:00",
        "IssuingCountry": "sample string 3"
      },
      {
        "WorkRightsDocumentType": "sample string 1",
        "WorkRightsReferenceNumber": "sample string 2",
        "WorkRightsExpiryDate": "2024-06-29T07:32:44.4234985+10:00",
        "IssuingCountry": "sample string 3"
      }
    ]
  },
  "CandidatePreferences": {
    "OwningDivision": "sample string 1",
    "OwningCountry": "sample string 2",
    "CandidateWorkTypeList": [
      {
        "WorkPreferenceType": "sample string 1"
      },
      {
        "WorkPreferenceType": "sample string 1"
      }
    ],
    "PreferenceNextJob": "sample string 3",
    "PermSalaryType": "sample string 4",
    "PermSalaryRange": "sample string 5",
    "PermSalaryCurrency": "sample string 6",
    "TempSalaryType": "sample string 7",
    "TempSalaryRange": "sample string 8",
    "TempSalaryCurrency": "sample string 9",
    "WillingToRelocate": true,
    "OwnTransport": true,
    "TravelDistance": "sample string 10",
    "WorkLocationList": [
      {
        "WorkLocationPreference": "sample string 1"
      },
      {
        "WorkLocationPreference": "sample string 1"
      }
    ],
    "MarketingList": [
      {
        "MarketingMedium": "sample string 1"
      },
      {
        "MarketingMedium": "sample string 1"
      }
    ]
  },
  "CandidateWorkExperienceDetails": {
    "CurrentJobTitle": "sample string 1",
    "CurrentNoticePeriod": "sample string 2",
    "RegisteredWithAgency": true,
    "AgencyName": "sample string 4",
    "JobSeekerID": "sample string 5",
    "CandidateIndustryList": [
      {
        "Id": 1,
        "Code": "sample string 1"
      },
      {
        "Id": 1,
        "Code": "sample string 1"
      }
    ]
  },
  "CandidateQualificationList": [
    {
      "Id": 1,
      "Code": "sample string 1",
      "IssuingAuthority": "sample string 2",
      "MajorSubject": "sample string 3"
    },
    {
      "Id": 1,
      "Code": "sample string 1",
      "IssuingAuthority": "sample string 2",
      "MajorSubject": "sample string 3"
    }
  ],
  "CandidateSkillsList": [
    {
      "Id": 1,
      "Code": "sample string 1",
      "SkillLevel": "sample string 2",
      "Experience": 1.1
    },
    {
      "Id": 1,
      "Code": "sample string 1",
      "SkillLevel": "sample string 2",
      "Experience": 1.1
    }
  ],
  "CandidateLanguageList": [
    {
      "Id": 1,
      "Code": "sample string 1",
      "IsPrimaryLanguage": true
    },
    {
      "Id": 1,
      "Code": "sample string 1",
      "IsPrimaryLanguage": true
    }
  ],
  "CandidateLicenceList": [
    {
      "Id": 1,
      "Code": "sample string 1",
      "ValidTo": "2024-06-29T07:32:44.4266765+10:00"
    },
    {
      "Id": 1,
      "Code": "sample string 1",
      "ValidTo": "2024-06-29T07:32:44.4266765+10:00"
    }
  ],
  "CandidateDocumentDetailList": [
    {
      "Id": 1,
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Subtype": "sample string 3",
      "UploadedOn": "2024-06-29T07:32:44.4266765+10:00"
    },
    {
      "Id": 1,
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Subtype": "sample string 3",
      "UploadedOn": "2024-06-29T07:32:44.4266765+10:00"
    }
  ],
  "EmailStopFlag": true,
  "EmailBounceBackFlag": true,
  "SMSStopFlag": true
}

text/xml

Sample:

<CandidateDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <CandidateAddressDetails>
    <CandidatePostalAddress>
      <AddressLineOne>sample string 1</AddressLineOne>
      <AddressLineTwo>sample string 2</AddressLineTwo>
      <Country>sample string 6</Country>
      <PostCode>sample string 5</PostCode>
      <State>sample string 4</State>
      <Suburb>sample string 3</Suburb>
    </CandidatePostalAddress>
    <CandidateResidentialAddress>
      <AddressLineOne>sample string 1</AddressLineOne>
      <AddressLineTwo>sample string 2</AddressLineTwo>
      <Country>sample string 6</Country>
      <PostCode>sample string 5</PostCode>
      <State>sample string 4</State>
      <Suburb>sample string 3</Suburb>
    </CandidateResidentialAddress>
    <UseMyResidentialAddress>true</UseMyResidentialAddress>
  </CandidateAddressDetails>
  <CandidateDocumentDetailList>
    <CandidateDocumentDetail>
      <Id>1</Id>
      <Name>sample string 1</Name>
      <Subtype>sample string 3</Subtype>
      <Type>sample string 2</Type>
      <UploadedOn>2024-06-29T07:32:44.4266765+10:00</UploadedOn>
    </CandidateDocumentDetail>
    <CandidateDocumentDetail>
      <Id>1</Id>
      <Name>sample string 1</Name>
      <Subtype>sample string 3</Subtype>
      <Type>sample string 2</Type>
      <UploadedOn>2024-06-29T07:32:44.4266765+10:00</UploadedOn>
    </CandidateDocumentDetail>
  </CandidateDocumentDetailList>
  <CandidateLanguageList>
    <CandidateLanguage>
      <Code>sample string 1</Code>
      <Id>1</Id>
      <IsPrimaryLanguage>true</IsPrimaryLanguage>
    </CandidateLanguage>
    <CandidateLanguage>
      <Code>sample string 1</Code>
      <Id>1</Id>
      <IsPrimaryLanguage>true</IsPrimaryLanguage>
    </CandidateLanguage>
  </CandidateLanguageList>
  <CandidateLicenceList>
    <CandidateLicence>
      <Code>sample string 1</Code>
      <Id>1</Id>
      <ValidTo>2024-06-29T07:32:44.4266765+10:00</ValidTo>
    </CandidateLicence>
    <CandidateLicence>
      <Code>sample string 1</Code>
      <Id>1</Id>
      <ValidTo>2024-06-29T07:32:44.4266765+10:00</ValidTo>
    </CandidateLicence>
  </CandidateLicenceList>
  <CandidateName>
    <FirstName>sample string 2</FirstName>
    <MiddleName>sample string 3</MiddleName>
    <PreferredName>sample string 5</PreferredName>
    <Surname>sample string 4</Surname>
    <Title>sample string 1</Title>
  </CandidateName>
  <CandidatePersonalDetails>
    <AboriginalOrTorresStraitIslander>true</AboriginalOrTorresStraitIslander>
    <DateOfBirth>2024-06-29T07:32:44.4227119+10:00</DateOfBirth>
    <Email>sample string 1</Email>
    <EmergencyContactName>sample string 6</EmergencyContactName>
    <EmergencyContactNumber>sample string 7</EmergencyContactNumber>
    <Gender>sample string 4</Gender>
    <MaritalStatus>sample string 5</MaritalStatus>
    <Mobile>sample string 3</Mobile>
    <Phone>sample string 2</Phone>
  </CandidatePersonalDetails>
  <CandidatePreferences>
    <CandidateWorkTypeList>
      <WorkType>
        <WorkPreferenceType>sample string 1</WorkPreferenceType>
      </WorkType>
      <WorkType>
        <WorkPreferenceType>sample string 1</WorkPreferenceType>
      </WorkType>
    </CandidateWorkTypeList>
    <MarketingList>
      <Marketing>
        <MarketingMedium>sample string 1</MarketingMedium>
      </Marketing>
      <Marketing>
        <MarketingMedium>sample string 1</MarketingMedium>
      </Marketing>
    </MarketingList>
    <OwnTransport>true</OwnTransport>
    <OwningCountry>sample string 2</OwningCountry>
    <OwningDivision>sample string 1</OwningDivision>
    <PermSalaryCurrency>sample string 6</PermSalaryCurrency>
    <PermSalaryRange>sample string 5</PermSalaryRange>
    <PermSalaryType>sample string 4</PermSalaryType>
    <PreferenceNextJob>sample string 3</PreferenceNextJob>
    <TempSalaryCurrency>sample string 9</TempSalaryCurrency>
    <TempSalaryRange>sample string 8</TempSalaryRange>
    <TempSalaryType>sample string 7</TempSalaryType>
    <TravelDistance>sample string 10</TravelDistance>
    <WillingToRelocate>true</WillingToRelocate>
    <WorkLocationList>
      <WorkLocation>
        <WorkLocationPreference>sample string 1</WorkLocationPreference>
      </WorkLocation>
      <WorkLocation>
        <WorkLocationPreference>sample string 1</WorkLocationPreference>
      </WorkLocation>
    </WorkLocationList>
  </CandidatePreferences>
  <CandidateQualificationList>
    <CandidateQualification>
      <Code>sample string 1</Code>
      <Id>1</Id>
      <IssuingAuthority>sample string 2</IssuingAuthority>
      <MajorSubject>sample string 3</MajorSubject>
    </CandidateQualification>
    <CandidateQualification>
      <Code>sample string 1</Code>
      <Id>1</Id>
      <IssuingAuthority>sample string 2</IssuingAuthority>
      <MajorSubject>sample string 3</MajorSubject>
    </CandidateQualification>
  </CandidateQualificationList>
  <CandidateSkillsList>
    <CandidateSkills>
      <Code>sample string 1</Code>
      <Experience>1.1</Experience>
      <Id>1</Id>
      <SkillLevel>sample string 2</SkillLevel>
    </CandidateSkills>
    <CandidateSkills>
      <Code>sample string 1</Code>
      <Experience>1.1</Experience>
      <Id>1</Id>
      <SkillLevel>sample string 2</SkillLevel>
    </CandidateSkills>
  </CandidateSkillsList>
  <CandidateStaus>sample string 1</CandidateStaus>
  <CandidateWorkExperienceDetails>
    <AgencyName>sample string 4</AgencyName>
    <CandidateIndustryList>
      <CandidateIndustry>
        <Code>sample string 1</Code>
        <Id>1</Id>
      </CandidateIndustry>
      <CandidateIndustry>
        <Code>sample string 1</Code>
        <Id>1</Id>
      </CandidateIndustry>
    </CandidateIndustryList>
    <CurrentJobTitle>sample string 1</CurrentJobTitle>
    <CurrentNoticePeriod>sample string 2</CurrentNoticePeriod>
    <JobSeekerID>sample string 5</JobSeekerID>
    <RegisteredWithAgency>true</RegisteredWithAgency>
  </CandidateWorkExperienceDetails>
  <CandidateWorkRightsDetails>
    <CitizenshipCountry>sample string 1</CitizenshipCountry>
    <VisaExpiryDate>2024-06-29T07:32:44.4234985+10:00</VisaExpiryDate>
    <VisaType>sample string 2</VisaType>
    <WorkRightsAndIdentificationList>
      <WorkRightsAndIdentification>
        <IssuingCountry>sample string 3</IssuingCountry>
        <WorkRightsDocumentType>sample string 1</WorkRightsDocumentType>
        <WorkRightsExpiryDate>2024-06-29T07:32:44.4234985+10:00</WorkRightsExpiryDate>
        <WorkRightsReferenceNumber>sample string 2</WorkRightsReferenceNumber>
      </WorkRightsAndIdentification>
      <WorkRightsAndIdentification>
        <IssuingCountry>sample string 3</IssuingCountry>
        <WorkRightsDocumentType>sample string 1</WorkRightsDocumentType>
        <WorkRightsExpiryDate>2024-06-29T07:32:44.4234985+10:00</WorkRightsExpiryDate>
        <WorkRightsReferenceNumber>sample string 2</WorkRightsReferenceNumber>
      </WorkRightsAndIdentification>
    </WorkRightsAndIdentificationList>
  </CandidateWorkRightsDetails>
  <Comments>sample string 2</Comments>
  <EmailBounceBackFlag>true</EmailBounceBackFlag>
  <EmailStopFlag>true</EmailStopFlag>
  <NextAvailableFrom>2024-06-29T07:32:44.4227119+10:00</NextAvailableFrom>
  <SMSStopFlag>true</SMSStopFlag>
</CandidateDTO>

multipart/form-data

Sample:

<CandidateDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><CandidateAddressDetails><CandidatePostalAddress><AddressLineOne>sample string 1</AddressLineOne><AddressLineTwo>sample string 2</AddressLineTwo><Country>sample string 6</Country><PostCode>sample string 5</PostCode><State>sample string 4</State><Suburb>sample string 3</Suburb></CandidatePostalAddress><CandidateResidentialAddress><AddressLineOne>sample string 1</AddressLineOne><AddressLineTwo>sample string 2</AddressLineTwo><Country>sample string 6</Country><PostCode>sample string 5</PostCode><State>sample string 4</State><Suburb>sample string 3</Suburb></CandidateResidentialAddress><UseMyResidentialAddress>true</UseMyResidentialAddress></CandidateAddressDetails><CandidateDocumentDetailList><CandidateDocumentDetail><Id>1</Id><Name>sample string 1</Name><Subtype>sample string 3</Subtype><Type>sample string 2</Type><UploadedOn>2024-06-29T07:32:44.4266765+10:00</UploadedOn></CandidateDocumentDetail><CandidateDocumentDetail><Id>1</Id><Name>sample string 1</Name><Subtype>sample string 3</Subtype><Type>sample string 2</Type><UploadedOn>2024-06-29T07:32:44.4266765+10:00</UploadedOn></CandidateDocumentDetail></CandidateDocumentDetailList><CandidateLanguageList><CandidateLanguage><Code>sample string 1</Code><Id>1</Id><IsPrimaryLanguage>true</IsPrimaryLanguage></CandidateLanguage><CandidateLanguage><Code>sample string 1</Code><Id>1</Id><IsPrimaryLanguage>true</IsPrimaryLanguage></CandidateLanguage></CandidateLanguageList><CandidateLicenceList><CandidateLicence><Code>sample string 1</Code><Id>1</Id><ValidTo>2024-06-29T07:32:44.4266765+10:00</ValidTo></CandidateLicence><CandidateLicence><Code>sample string 1</Code><Id>1</Id><ValidTo>2024-06-29T07:32:44.4266765+10:00</ValidTo></CandidateLicence></CandidateLicenceList><CandidateName><FirstName>sample string 2</FirstName><MiddleName>sample string 3</MiddleName><PreferredName>sample string 5</PreferredName><Surname>sample string 4</Surname><Title>sample string 1</Title></CandidateName><CandidatePersonalDetails><AboriginalOrTorresStraitIslander>true</AboriginalOrTorresStraitIslander><DateOfBirth>2024-06-29T07:32:44.4227119+10:00</DateOfBirth><Email>sample string 1</Email><EmergencyContactName>sample string 6</EmergencyContactName><EmergencyContactNumber>sample string 7</EmergencyContactNumber><Gender>sample string 4</Gender><MaritalStatus>sample string 5</MaritalStatus><Mobile>sample string 3</Mobile><Phone>sample string 2</Phone></CandidatePersonalDetails><CandidatePreferences><CandidateWorkTypeList><WorkType><WorkPreferenceType>sample string 1</WorkPreferenceType></WorkType><WorkType><WorkPreferenceType>sample string 1</WorkPreferenceType></WorkType></CandidateWorkTypeList><MarketingList><Marketing><MarketingMedium>sample string 1</MarketingMedium></Marketing><Marketing><MarketingMedium>sample string 1</MarketingMedium></Marketing></MarketingList><OwnTransport>true</OwnTransport><OwningCountry>sample string 2</OwningCountry><OwningDivision>sample string 1</OwningDivision><PermSalaryCurrency>sample string 6</PermSalaryCurrency><PermSalaryRange>sample string 5</PermSalaryRange><PermSalaryType>sample string 4</PermSalaryType><PreferenceNextJob>sample string 3</PreferenceNextJob><TempSalaryCurrency>sample string 9</TempSalaryCurrency><TempSalaryRange>sample string 8</TempSalaryRange><TempSalaryType>sample string 7</TempSalaryType><TravelDistance>sample string 10</TravelDistance><WillingToRelocate>true</WillingToRelocate><WorkLocationList><WorkLocation><WorkLocationPreference>sample string 1</WorkLocationPreference></WorkLocation><WorkLocation><WorkLocationPreference>sample string 1</WorkLocationPreference></WorkLocation></WorkLocationList></CandidatePreferences><CandidateQualificationList><CandidateQualification><Code>sample string 1</Code><Id>1</Id><IssuingAuthority>sample string 2</IssuingAuthority><MajorSubject>sample string 3</MajorSubject></CandidateQualification><CandidateQualification><Code>sample string 1</Code><Id>1</Id><IssuingAuthority>sample string 2</IssuingAuthority><MajorSubject>sample string 3</MajorSubject></CandidateQualification></CandidateQualificationList><CandidateSkillsList><CandidateSkills><Code>sample string 1</Code><Experience>1.1</Experience><Id>1</Id><SkillLevel>sample string 2</SkillLevel></CandidateSkills><CandidateSkills><Code>sample string 1</Code><Experience>1.1</Experience><Id>1</Id><SkillLevel>sample string 2</SkillLevel></CandidateSkills></CandidateSkillsList><CandidateStaus>sample string 1</CandidateStaus><CandidateWorkExperienceDetails><AgencyName>sample string 4</AgencyName><CandidateIndustryList><CandidateIndustry><Code>sample string 1</Code><Id>1</Id></CandidateIndustry><CandidateIndustry><Code>sample string 1</Code><Id>1</Id></CandidateIndustry></CandidateIndustryList><CurrentJobTitle>sample string 1</CurrentJobTitle><CurrentNoticePeriod>sample string 2</CurrentNoticePeriod><JobSeekerID>sample string 5</JobSeekerID><RegisteredWithAgency>true</RegisteredWithAgency></CandidateWorkExperienceDetails><CandidateWorkRightsDetails><CitizenshipCountry>sample string 1</CitizenshipCountry><VisaExpiryDate>2024-06-29T07:32:44.4234985+10:00</VisaExpiryDate><VisaType>sample string 2</VisaType><WorkRightsAndIdentificationList><WorkRightsAndIdentification><IssuingCountry>sample string 3</IssuingCountry><WorkRightsDocumentType>sample string 1</WorkRightsDocumentType><WorkRightsExpiryDate>2024-06-29T07:32:44.4234985+10:00</WorkRightsExpiryDate><WorkRightsReferenceNumber>sample string 2</WorkRightsReferenceNumber></WorkRightsAndIdentification><WorkRightsAndIdentification><IssuingCountry>sample string 3</IssuingCountry><WorkRightsDocumentType>sample string 1</WorkRightsDocumentType><WorkRightsExpiryDate>2024-06-29T07:32:44.4234985+10:00</WorkRightsExpiryDate><WorkRightsReferenceNumber>sample string 2</WorkRightsReferenceNumber></WorkRightsAndIdentification></WorkRightsAndIdentificationList></CandidateWorkRightsDetails><Comments>sample string 2</Comments><EmailBounceBackFlag>true</EmailBounceBackFlag><EmailStopFlag>true</EmailStopFlag><NextAvailableFrom>2024-06-29T07:32:44.4227119+10:00</NextAvailableFrom><SMSStopFlag>true</SMSStopFlag></CandidateDTO>