v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB

Entity

Creates an item in the ICapture candidate queue

If valid, the candidate will be placed in a queue to be processed by the Infinity ICapture service. A 'Candidate API'data source must be setup and active in Infinity for it to be processed. If the data source is not active, records will still be accepted but remain in the queue.

A Surname is required.

Comments and Summary must not exceed the max upload size configured in Infinity.

A CV must not exceed the max upload size configured in Infinity.

A maximimum of 5 attachments can be uploaded. All Attachments must not exceed the max upload size configured in Infinity.

The max upload size can be retrieved from the /Reference/MaxUploadSize method (In KB)

All id fields must match active reference data from the /Reference methods

post/Entity/ICaptureCandidate

Request body

TitleIdinteger nullable

Forenamestring nullable

Middlenamestring nullable

Surnamestring required

KnownAsstring nullable

GenderIdinteger nullable

MaritalStatusIdinteger nullable

DateOfBirthstring date-time nullable

NationalityIdinteger nullable

SecondNationalityIdinteger nullable

ThirdNationalityIdinteger nullable

FourthNationalityIdinteger nullable

EthnicOriginIdinteger nullable

CountryOfOriginIdinteger nullable

AddressLine1string nullable

AddressLine2string nullable

AddressLine3string nullable

Townstring nullable

Postcodestring nullable

CountryIdinteger nullable

HomePhoneNumberstring nullable

WorkPhoneNumberstring nullable

MobileNumberstring nullable

HomeEmailAddressstring nullable

LinkedInPublicUrlstring nullable

WebIdstring nullable

IsPermanentboolean

IsContractboolean

IsTemporaryboolean

ExpectedRateCurrencyIdinteger nullable

PreferredLocationstring nullable

AvailabilityDatestring date-time nullable

HasOwnTransportboolean

Relocateboolean

Commentsstring nullable

Summarystring nullable

CVstring byte nullable

A Base64 CV document to attach to the candidate.

The document cannot exceed the max upload size configured in Infinity.

JobTitlesinteger[] nullable

Sourcesinteger[] nullable

ShortlistJobCodesstring[] nullable

A list of valid job codes to shortlist the candidate against e.g. JO0000000112

Response

integer required