POST Api/Platform/SendCandidates

Request Information

URI Parameters

None.

Body Parameters

CandidatesToSendSelectorDto
NameDescriptionTypeAdditional information
CreatedOnFrom

date

None.

CreatedOnTo

date

None.

BatchSize

integer

Required

Range: inclusive between 1 and 1000

Request Formats

application/json, text/json

Sample:
{
  "createdOnFrom": "2024-05-18T05:32:35.2218237+00:00",
  "createdOnTo": "2024-05-18T05:32:35.2218237+00:00",
  "batchSize": 1
}

multipart/form-data

Sample:
{"createdOnFrom":"2024-05-18T05:32:35.2218237+00:00","createdOnTo":"2024-05-18T05:32:35.2218237+00:00","batchSize":1}

application/xml, text/xml

Sample:
<CandidatesToSendSelectorDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CreatedOnFrom>2024-05-18T05:32:35.2218237+00:00</CreatedOnFrom>
  <CreatedOnTo>2024-05-18T05:32:35.2218237+00:00</CreatedOnTo>
  <BatchSize>1</BatchSize>
</CandidatesToSendSelectorDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SentCandidatesStatisticsDto
NameDescriptionTypeAdditional information
TotalAmount

integer

None.

LastId

globally unique identifier

None.

TimeElapsedInMs

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "totalAmount": 1,
  "lastId": "911b4e59-54b0-4d2d-ba56-f9d365ce6955",
  "timeElapsedInMs": 2
}

multipart/form-data

Sample:
{"totalAmount":1,"lastId":"911b4e59-54b0-4d2d-ba56-f9d365ce6955","timeElapsedInMs":2}

application/xml, text/xml

Sample:
<SentCandidatesStatisticsDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <TotalAmount>1</TotalAmount>
  <LastId>911b4e59-54b0-4d2d-ba56-f9d365ce6955</LastId>
  <TimeElapsedInMs>2</TimeElapsedInMs>
</SentCandidatesStatisticsDto>