GET api/ClientRespitePeriods/ByClient/{id}/{day}
Get respite details for a specified client and day
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Client ID specified as singular ID or commas separated list of IDs |
string |
Required |
| day |
Date of requested respites (uses Start Date only) |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
ClientRespitePeriodReportDetails()
ClientRespitePeriodReportDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| respiteID | integer |
None. |
|
| respiteClient | integer |
None. |
|
| respiteUser | integer |
None. |
|
| respiteNotes | string |
None. |
|
| respiteDateStart | date |
None. |
|
| respiteDateEnd | date |
None. |
|
| respiteDateEnd_2 | date |
None. |
|
| respiteDisabled | boolean |
None. |
|
| respiteCareRequiredDuringRespite | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"respiteID": 707,
"respiteClient": 534,
"respiteUser": 581,
"respiteNotes": "sample string 2",
"respiteDateStart": "2024-04-20T23:06:01.7847572+10:00",
"respiteDateEnd": "2024-04-20T23:06:01.7847572+10:00",
"respiteDateEnd_2": "2024-04-20T23:06:01.7847572+10:00",
"respiteDisabled": true,
"respiteCareRequiredDuringRespite": true
}
application/xml, text/xml
Sample:
<ClientRespitePeriodReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint"> <respiteCareRequiredDuringRespite>true</respiteCareRequiredDuringRespite> <respiteClient>534</respiteClient> <respiteDateEnd>2024-04-20T23:06:01.7847572+10:00</respiteDateEnd> <respiteDateEnd_2>2024-04-20T23:06:01.7847572+10:00</respiteDateEnd_2> <respiteDateStart>2024-04-20T23:06:01.7847572+10:00</respiteDateStart> <respiteDisabled>true</respiteDisabled> <respiteID>707</respiteID> <respiteNotes>sample string 2</respiteNotes> <respiteUser>581</respiteUser> </ClientRespitePeriodReportDetails>