Availability for Client

Client Availability

Outcome:

GET availability preferences by client ID. Should return the list of weekly availability for the client.

POST - Client Availability should be sent as part of the Client API. Multiple availabilities should be sent as an array of objects.

Field

Data Type

Max Length

Description

Req

Expected Values

Error Message

Message if API is successful

Field

Data Type

Max Length

Description

Req

Expected Values

Error Message

Message if API is successful

1

clientAvailabilityID

number

10

Unique ID to identify a client availability record. Can be blank when a client availability is added. Client Availability ID needs to be sent when updates are being made to existing client availability

No

1

Invalid Client Availability ID

Invalid Format - Must be a number.

 

 

2

dayID

number

10

Should be one of the following values in Appendix 12.0 Day Types

Yes

1

Invalid Day Id. Valid range of values is 0-6.

Invalid Format - Must be a number.

 

 

3

startTime

string

 10

Time when availability of Staff or Client begins. Times must be in UTC

Yes

16:00

Invalid Start Time

 

4

endTime

string

 10

Time when availability of Staff or Client ends. Times must be in UTC

Yes

17:00

Invalid End Time

 

 



 

 

Related pages