POST api/ClientRespitePeriods
API interface handling generic JSON requests for ClientRespitePeriods
Request Information
URI Parameters
None.
Body Parameters
ClientRespitePeriodRequest
ClientRespitePeriodRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Request specified appointment by Id |
integer |
None. |
| ClientId |
Match Respite Periods for given Client |
integer |
None. |
| UserId |
Match Respite Periods allocated to User |
integer |
None. |
| FromDate |
Match Respite Periods from this date onwards |
date |
None. |
| ToDate |
Match Respite Periods up to this date |
date |
None. |
| Limit |
Limit to number of rows returned by request (default is 100) |
integer |
None. |
| Skip |
Number of rows to skip (so we can skip 10 get next 10 etc) |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 707,
"ClientId": 534,
"UserId": 581,
"FromDate": "2024-04-26T21:56:48.4912774+10:00",
"ToDate": "2024-04-26T21:56:48.4912774+10:00",
"Limit": 291,
"Skip": 303
}
application/xml, text/xml
Sample:
<ClientRespitePeriodRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint"> <ClientId>534</ClientId> <FromDate>2024-04-26T21:56:48.4912774+10:00</FromDate> <Id>707</Id> <Limit>291</Limit> <Skip>303</Skip> <ToDate>2024-04-26T21:56:48.4912774+10:00</ToDate> <UserId>581</UserId> </ClientRespitePeriodRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
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": 776,
"respiteClient": 15,
"respiteUser": 762,
"respiteNotes": "sample string 2",
"respiteDateStart": "2024-04-26T21:56:48.631899+10:00",
"respiteDateEnd": "2024-04-26T21:56:48.631899+10:00",
"respiteDateEnd_2": "2024-04-26T21:56:48.631899+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>15</respiteClient> <respiteDateEnd>2024-04-26T21:56:48.631899+10:00</respiteDateEnd> <respiteDateEnd_2>2024-04-26T21:56:48.631899+10:00</respiteDateEnd_2> <respiteDateStart>2024-04-26T21:56:48.631899+10:00</respiteDateStart> <respiteDisabled>true</respiteDisabled> <respiteID>776</respiteID> <respiteNotes>sample string 2</respiteNotes> <respiteUser>762</respiteUser> </ClientRespitePeriodReportDetails>