v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB
Entity

Gets availability dates for a single temp candidate

A candidate is available when the IsAvailable property is True. The UnavailabilityDetail property will return null in this instance.

A candidate is unavailable when the IsAvailable property is False. The UnavailabilityDetail property will return additional information about why they are unavailable.

If they are unavailable because they are in an Infinity placement, then the PlacementId property will return a value.

The /Entity/Placement method can be used to get additional information about an Infinity Placement if required.

get/Entity/TempCandidateAvailabilityDates

Query parameters

candidateidinteger required

Candidate Id to return

fromDatestring date-time required

From date

toDatestring date-time nullable

Optional to date. If not supplied, all future shifts will be returned

Response

OK

Idinteger required
Startstring date-time required
Endstring date-time required
TimeZoneIdstring required
IsAvailableboolean required
IsReadOnlyboolean required
CanDeleteboolean required