POST Api/Platform/SendConcreteCandidates

Request Information

URI Parameters

None.

Body Parameters

CandidatesToSendDto
NameDescriptionTypeAdditional information
BatchSize

integer

Required

Range: inclusive between 1 and 1000

Identifiers

string

Required

String length: inclusive between 0 and 4096

Request Formats

application/json, text/json

Sample:
{
  "batchSize": 1,
  "identifiers": "sample string 2"
}

multipart/form-data

Sample:
{"batchSize":1,"identifiers":"sample string 2"}

application/xml, text/xml

Sample:
<CandidatesToSendDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BatchSize>1</BatchSize>
  <Identifiers>sample string 2</Identifiers>
</CandidatesToSendDto>

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": "db46ecf3-f8e7-4e47-b861-26ab99f64bb6",
  "timeElapsedInMs": 2
}

multipart/form-data

Sample:
{"totalAmount":1,"lastId":"db46ecf3-f8e7-4e47-b861-26ab99f64bb6","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>db46ecf3-f8e7-4e47-b861-26ab99f64bb6</LastId>
  <TimeElapsedInMs>2</TimeElapsedInMs>
</SentCandidatesStatisticsDto>