POST api/ClientPackageSchedules
API interface handling generic JSON requests for ClientPackageSchedules
Request Information
URI Parameters
None.
Body Parameters
ClientPackageScheduleRequest
ClientPackageScheduleRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Request specified appointment by Id |
integer |
None. |
| FromDate |
Match packages valid from this date onwards |
date |
None. |
| ToDate |
Match packages valid until 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,
"FromDate": "2024-04-25T00:35:15.8322957+10:00",
"ToDate": "2024-04-25T00:35:15.8322957+10:00",
"Limit": 534,
"Skip": 581
}
application/xml, text/xml
Sample:
<ClientPackageScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <FromDate>2024-04-25T00:35:15.8322957+10:00</FromDate> <Id>707</Id> <Limit>534</Limit> <Skip>581</Skip> <ToDate>2024-04-25T00:35:15.8322957+10:00</ToDate> </ClientPackageScheduleRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ClientPackageScheduleReportDetails()
ClientPackageScheduleReportDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| clientPackageScheduleID | integer |
None. |
|
| clientPackageScheduleClient | integer |
None. |
|
| clientPackageScheduleCaseManager | integer |
None. |
|
| clientPackageSchedulePackage | integer |
None. |
|
| clientPackageScheduleFundingType | integer |
None. |
|
| clientPackageScheduleBalance | decimal number |
None. |
|
| clientPackageScheduleStartDate | date |
None. |
|
| clientPackageScheduleEndDate | date |
None. |
|
| clientPackageScheduleLockedDate | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"clientPackageScheduleID": 291,
"clientPackageScheduleClient": 303,
"clientPackageScheduleCaseManager": 776,
"clientPackageSchedulePackage": 15,
"clientPackageScheduleFundingType": 762,
"clientPackageScheduleBalance": 1.1,
"clientPackageScheduleStartDate": "2024-04-25T00:35:15.8479319+10:00",
"clientPackageScheduleEndDate": "2024-04-25T00:35:15.8479319+10:00",
"clientPackageScheduleLockedDate": "2024-04-25T00:35:15.8479319+10:00"
}
application/xml, text/xml
Sample:
<ClientPackageScheduleReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <clientPackageScheduleBalance>1.1</clientPackageScheduleBalance> <clientPackageScheduleCaseManager>776</clientPackageScheduleCaseManager> <clientPackageScheduleClient>303</clientPackageScheduleClient> <clientPackageScheduleEndDate>2024-04-25T00:35:15.8479319+10:00</clientPackageScheduleEndDate> <clientPackageScheduleFundingType>762</clientPackageScheduleFundingType> <clientPackageScheduleID>291</clientPackageScheduleID> <clientPackageScheduleLockedDate>2024-04-25T00:35:15.8479319+10:00</clientPackageScheduleLockedDate> <clientPackageSchedulePackage>15</clientPackageSchedulePackage> <clientPackageScheduleStartDate>2024-04-25T00:35:15.8479319+10:00</clientPackageScheduleStartDate> </ClientPackageScheduleReportDetails>