Sign in
Candidate Availability

Listing of the the candidates availability

get/candidate/{candidate_id}/availability

Query parameters

sEarly'Available' | 'Unavailable' | 'Unknown' | 'Booked'

The early block of a candidates availability

sLate'Available' | 'Unavailable' | 'Unknown' | 'Booked'

The late block of a candidates availability

sNight'Available' | 'Unavailable' | 'Unknown' | 'Booked'

The night block of a candidates availability

idstring

A single mongo id

from-dtModifiedstring date-time

The from date time for dtModified, inclusive

dtModifiedstring date-time

The actual date time for dtModified

to-dtModifiedstring date-time

The to date time for dtModified, exclusive

from-dtCreatedstring date-time

The from date time for dtCreated, inclusive

dtCreatedstring date-time

The actual date time for dtCreated

to-dtCreatedstring date-time

The to date time for dtCreated, exclusive

from-dAvailabilityDatestring date

The from date for dAvailabilityDate, inclusive

dAvailabilityDatestring date

The actual date for dAvailabilityDate

to-dAvailabilityDatestring date

The to date for dAvailabilityDate, exclusive

pageinteger

The page of documents to be displayed

items_per_pageinteger

The number of documents per page

sortBystring[]

A comma seperated list of fields indicating sort order dtModified, dtCreated, a negative sign reverses direction -dtModified

Response

Candidate availability listing

sEarly'Unknown' | 'Available' | 'Unavailable' | 'Booked' required
sLate'Unknown' | 'Available' | 'Unavailable' | 'Booked' required
sNight'Unknown' | 'Available' | 'Unavailable' | 'Booked' required
dAvailabilityDatestring date required
sCandidateIdstring required
dtCreatedstring date-time required
dtModifiedstring date-time required
idstring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.