POST Api/Platform/SendCandidateDocuments

Request Information

URI Parameters

None.

Body Parameters

CandidateDocumentsToSendSelectorDto

Name	Type	Additional information
DocumentProfileCreatedOnFrom	date	None.
DocumentProfileCreatedOnTo	date	None.
BatchSize	integer	Required Range: inclusive between 1 and 1000

Name

Description

Type

Additional information

DocumentProfileCreatedOnFrom

date

None.

DocumentProfileCreatedOnTo

date

None.

BatchSize

integer

Required

Range: inclusive between 1 and 1000

Request Formats

application/json, text/json

Sample:

{
  "documentProfileCreatedOnFrom": "2024-05-18T07:12:35.6805804+00:00",
  "documentProfileCreatedOnTo": "2024-05-18T07:12:35.6805804+00:00",
  "batchSize": 1
}

multipart/form-data

Sample:

{"documentProfileCreatedOnFrom":"2024-05-18T07:12:35.6805804+00:00","documentProfileCreatedOnTo":"2024-05-18T07:12:35.6805804+00:00","batchSize":1}

application/xml, text/xml

Sample:

<CandidateDocumentsToSendSelectorDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DocumentProfileCreatedOnFrom>2024-05-18T07:12:35.6805804+00:00</DocumentProfileCreatedOnFrom>
  <DocumentProfileCreatedOnTo>2024-05-18T07:12:35.6805804+00:00</DocumentProfileCreatedOnTo>
  <BatchSize>1</BatchSize>
</CandidateDocumentsToSendSelectorDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SentCandidatesStatisticsDto

Name	Type	Additional information
TotalAmount	integer	None.
LastId	globally unique identifier	None.
TimeElapsedInMs	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "totalAmount": 1,
  "lastId": "5b9d2b68-4bea-4617-a810-1cecc1b84772",
  "timeElapsedInMs": 2
}

multipart/form-data

Sample:

{"totalAmount":1,"lastId":"5b9d2b68-4bea-4617-a810-1cecc1b84772","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>5b9d2b68-4bea-4617-a810-1cecc1b84772</LastId>
  <TimeElapsedInMs>2</TimeElapsedInMs>
</SentCandidatesStatisticsDto>