POST api/Candidates/{CandidateCode}/GenerateReferenceCheckDocument

This is used to generate candidate reference check document

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CandidateCode

string

Required

Body Parameters

VerbalReferenceCheckDocumentDO
NameDescriptionTypeAdditional information
CandidateCode

string

None.

ActivityId

integer

None.

PersonalityId

integer

None.

DocumentData

ReferenceCheckDocumentDO

None.

Request Formats

application/json, text/json

Sample:
{
  "CandidateCode": "sample string 1",
  "ActivityId": 2,
  "PersonalityId": 3,
  "DocumentData": {
    "DocumentName": "sample string 1",
    "DocumentContent": "QEA=",
    "DocumentExtn": "sample string 2"
  }
}

text/xml

Sample:
<VerbalReferenceCheckDocumentDO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <ActivityId>2</ActivityId>
  <CandidateCode>sample string 1</CandidateCode>
  <DocumentData>
    <DocumentContent>QEA=</DocumentContent>
    <DocumentExtn>sample string 2</DocumentExtn>
    <DocumentName>sample string 1</DocumentName>
  </DocumentData>
  <PersonalityId>3</PersonalityId>
</VerbalReferenceCheckDocumentDO>

multipart/form-data

Sample:
<VerbalReferenceCheckDocumentDO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><ActivityId>2</ActivityId><CandidateCode>sample string 1</CandidateCode><DocumentData><DocumentContent>QEA=</DocumentContent><DocumentExtn>sample string 2</DocumentExtn><DocumentName>sample string 1</DocumentName></DocumentData><PersonalityId>3</PersonalityId></VerbalReferenceCheckDocumentDO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

This returns boolean

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>