POST api/Candidates/StaticList

Used to add candidates to an existing or new static list

Request Information

URI Parameters

None.

Body Parameters

This is MFront CandidateId

StaticListDataDTO
NameDescriptionTypeAdditional information
Description

(Optional) This is the extended description of the static list

string

None.

ListID

This is the internal ID of the list (0 for new)

integer

None.

ListName

(Optional) This is the simple name of the static list

string

None.

CandidateIDs

This is the list of candidate ids included in the list

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Description": "sample string 1",
  "ListID": 2,
  "ListName": "sample string 3",
  "CandidateIDs": [
    1,
    2
  ]
}

text/xml

Sample:
<StaticListDataDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <CandidateIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CandidateIDs>
  <Description>sample string 1</Description>
  <ListID>2</ListID>
  <ListName>sample string 3</ListName>
</StaticListDataDTO>

multipart/form-data

Sample:
<StaticListDataDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><CandidateIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>1</d2p1:int><d2p1:int>2</d2p1:int></CandidateIDs><Description>sample string 1</Description><ListID>2</ListID><ListName>sample string 3</ListName></StaticListDataDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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>