PUT api/Candidates/{CandidateNo}/CandidateAddress

Used to update candidate address (Postal and Residential)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CandidateNo

string

Required

Body Parameters

CandidateAddressDetails
NameDescriptionTypeAdditional information
UseMyResidentialAddress

This is a flag to use Residential Address for Postal Address

boolean

None.

CandidateResidentialAddress

This is the Candidate's Residential address

CandidateAddress

None.

CandidatePostalAddress

This is the Candidate's Postal address

CandidateAddress

None.

Request Formats

application/json, text/json

Sample:
{
  "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"
  }
}

text/xml

Sample:
<CandidateAddressDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <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>

multipart/form-data

Sample:
<CandidateAddressDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

COMPLETE

boolean

Response Formats

application/json, text/json

Sample:
true

text/xml, multipart/form-data

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>