GET api/Tasks/Availability

Retrieves a list of available times for a proposed appointment.

Request

Parameters

Name Description Default
date Appointment date. May include a start time.
duration Appointment duration (in hours). 0.5
member Member code or unique member ID. Omit to schedule for the current member.
venue Optional appointment venue/resource to include in checks.
end Optional end date. Omit to stop at the end of the start date.

Response

Body

Content Type: application/xml or application/json
List of available times or an error message.

XML JSON 
<Response>                     
  <Result>                     <!--Array of 'Item'--> 
    <Item>DateTime</Item>      
  </Result>                    
  <Message>string</Message>    <!--Error message--> 
</Response>                    
{                               
   "Result": [ "DateTime" ],    
   "Message": "string"          // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid date or member.
401 Unauthorized Access token is invalid, expired or not specified.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

Availability is determined by a range of factors: