GET api/Availability/{email}?fromDate={fromDate}&toDate={toDate}

Used to fetch availability for a requested candidate email ID

Request Information

URI Parameters

Name	Type	Additional information
email	string	Required
fromDate	date	None.
toDate	date	None.

Body Parameters

None.

Response Information

Resource Description

COMPLETE

Collection of AvailabilityDTO

Name	Description	Type	Additional information
Day	This is the availability day	date	None.
Availability	This is the Availability Status (Available/Unavailable)	string	None.
IsHoliday	This is an indicator if the day is a public holiday	boolean	None.
Shift	This is the shift Type (All Day, PM, AM, etc)	string	None.
IsBooked	This is an indicator if their is a current booking at the same time (get only)	boolean	None.
ShiftStart	This is the Shift Start time day	date	None.
ShiftEnd	This is the Shift End Time day	date	None.
AvailabilityId	Identifier of the availability.	integer	None.
StartDateTime	This is the Shift Start time day	date	None.
EndDateTime	This is the Shift End Time day	date	None.
AvailabilityType	This is the Availability Status (Available/Unavailable)	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Day": "2024-06-29T07:12:54.5172021+10:00",
    "Availability": "sample string 1",
    "IsHoliday": true,
    "Shift": "sample string 2",
    "IsBooked": true,
    "ShiftStart": "2024-06-29T07:12:54.5172021+10:00",
    "ShiftEnd": "2024-06-29T07:12:54.5172021+10:00",
    "AvailabilityId": 1,
    "StartDateTime": "2024-06-29T07:12:54.5172021+10:00",
    "EndDateTime": "2024-06-29T07:12:54.5172021+10:00",
    "AvailabilityType": "sample string 3"
  },
  {
    "Day": "2024-06-29T07:12:54.5172021+10:00",
    "Availability": "sample string 1",
    "IsHoliday": true,
    "Shift": "sample string 2",
    "IsBooked": true,
    "ShiftStart": "2024-06-29T07:12:54.5172021+10:00",
    "ShiftEnd": "2024-06-29T07:12:54.5172021+10:00",
    "AvailabilityId": 1,
    "StartDateTime": "2024-06-29T07:12:54.5172021+10:00",
    "EndDateTime": "2024-06-29T07:12:54.5172021+10:00",
    "AvailabilityType": "sample string 3"
  }
]

text/xml

Sample:

<ArrayOfAvailabilityDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <AvailabilityDTO>
    <Availability>sample string 1</Availability>
    <AvailabilityId>1</AvailabilityId>
    <AvailabilityType>sample string 3</AvailabilityType>
    <Day>2024-06-29T07:12:54.5172021+10:00</Day>
    <EndDateTime>2024-06-29T07:12:54.5172021+10:00</EndDateTime>
    <IsBooked>true</IsBooked>
    <IsHoliday>true</IsHoliday>
    <Shift>sample string 2</Shift>
    <ShiftEnd>2024-06-29T07:12:54.5172021+10:00</ShiftEnd>
    <ShiftStart>2024-06-29T07:12:54.5172021+10:00</ShiftStart>
    <StartDateTime>2024-06-29T07:12:54.5172021+10:00</StartDateTime>
  </AvailabilityDTO>
  <AvailabilityDTO>
    <Availability>sample string 1</Availability>
    <AvailabilityId>1</AvailabilityId>
    <AvailabilityType>sample string 3</AvailabilityType>
    <Day>2024-06-29T07:12:54.5172021+10:00</Day>
    <EndDateTime>2024-06-29T07:12:54.5172021+10:00</EndDateTime>
    <IsBooked>true</IsBooked>
    <IsHoliday>true</IsHoliday>
    <Shift>sample string 2</Shift>
    <ShiftEnd>2024-06-29T07:12:54.5172021+10:00</ShiftEnd>
    <ShiftStart>2024-06-29T07:12:54.5172021+10:00</ShiftStart>
    <StartDateTime>2024-06-29T07:12:54.5172021+10:00</StartDateTime>
  </AvailabilityDTO>
</ArrayOfAvailabilityDTO>

multipart/form-data

Sample:

<ArrayOfAvailabilityDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><AvailabilityDTO><Availability>sample string 1</Availability><AvailabilityId>1</AvailabilityId><AvailabilityType>sample string 3</AvailabilityType><Day>2024-06-29T07:12:54.5172021+10:00</Day><EndDateTime>2024-06-29T07:12:54.5172021+10:00</EndDateTime><IsBooked>true</IsBooked><IsHoliday>true</IsHoliday><Shift>sample string 2</Shift><ShiftEnd>2024-06-29T07:12:54.5172021+10:00</ShiftEnd><ShiftStart>2024-06-29T07:12:54.5172021+10:00</ShiftStart><StartDateTime>2024-06-29T07:12:54.5172021+10:00</StartDateTime></AvailabilityDTO><AvailabilityDTO><Availability>sample string 1</Availability><AvailabilityId>1</AvailabilityId><AvailabilityType>sample string 3</AvailabilityType><Day>2024-06-29T07:12:54.5172021+10:00</Day><EndDateTime>2024-06-29T07:12:54.5172021+10:00</EndDateTime><IsBooked>true</IsBooked><IsHoliday>true</IsHoliday><Shift>sample string 2</Shift><ShiftEnd>2024-06-29T07:12:54.5172021+10:00</ShiftEnd><ShiftStart>2024-06-29T07:12:54.5172021+10:00</ShiftStart><StartDateTime>2024-06-29T07:12:54.5172021+10:00</StartDateTime></AvailabilityDTO></ArrayOfAvailabilityDTO>