POST api/Candidates/SMS

Used to send an SMS to one or more candidates

Request Information

URI Parameters

None.

Body Parameters

This is SMS request data

Name	Description	Type	Additional information
MessageBody	This is the SMS message to send	string	None.
CandidateIDs	This is the list of candidateids to send the SMS	Collection of integer	None.
ActionDate	This is the SMS message to send	date	None.

Request Formats

application/json, text/json

Sample:

{
  "MessageBody": "sample string 1",
  "CandidateIDs": [
    1,
    2
  ],
  "ActionDate": "2024-06-29T07:28:47.9290327+10:00"
}

text/xml

Sample:

<CandidateSMSMessageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <ActionDate>2024-06-29T07:28:47.9290327+10:00</ActionDate>
  <CandidateIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CandidateIDs>
  <MessageBody>sample string 1</MessageBody>
</CandidateSMSMessageDTO>

multipart/form-data

Sample:

<CandidateSMSMessageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><ActionDate>2024-06-29T07:28:47.9290327+10:00</ActionDate><CandidateIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>1</d2p1:int><d2p1:int>2</d2p1:int></CandidateIDs><MessageBody>sample string 1</MessageBody></CandidateSMSMessageDTO>

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>