POST api/Appointments
API interface handling generic JSON request for Appointment details (Note: maximum number of records returned defaults to 1000)
Request Information
URI Parameters
None.
Body Parameters
AppointmentRequest
AppointmentRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Request specified appointment by Id |
integer |
None. |
| ClientId |
Match appointments for given Client |
integer |
None. |
| UserId |
Match appointments allocated to User |
integer |
None. |
| FromDate |
Match appointments from this date onwards |
date |
None. |
| ToDate |
Match appoints up to this date |
date |
None. |
| FromTime |
Match appoints active from this time of day onwards |
date |
None. |
| ToTime |
Match appointments active up to this time of day |
date |
None. |
| ReferenceNumber |
Match appointments associated with reference number |
string |
None. |
| Status1 |
Match a comma separated list of statuses (pending,rejected,changed by office,changed by carer,accepted,started,completed,canceled) |
string |
None. |
| Limit |
Limit to number of rows returned by request (default is 1000) |
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
{
"Id": 707,
"ClientId": 534,
"UserId": 581,
"FromDate": "2024-04-25T11:10:42.6621298+10:00",
"ToDate": "2024-04-25T11:10:42.6621298+10:00",
"FromTime": "2024-04-25T11:10:42.6621298+10:00",
"ToTime": "2024-04-25T11:10:42.6621298+10:00",
"ReferenceNumber": "sample string 8",
"Status1": "sample string 9",
"Limit": 291,
"Skip": 303
}
application/xml, text/xml
<AppointmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <ClientId>534</ClientId> <FromDate>2024-04-25T11:10:42.6621298+10:00</FromDate> <FromTime>2024-04-25T11:10:42.6621298+10:00</FromTime> <Id>707</Id> <Limit>291</Limit> <ReferenceNumber>sample string 8</ReferenceNumber> <Skip>303</Skip> <Status1>sample string 9</Status1> <ToDate>2024-04-25T11:10:42.6621298+10:00</ToDate> <ToTime>2024-04-25T11:10:42.6621298+10:00</ToTime> <UserId>581</UserId> </AppointmentRequest>
application/x-www-form-urlencoded
[ClientId]=1234&[FromDate]=2019-01-01&[Todate]=2019-01-31
Response Information
Resource Description
AppointmentReportDetails()
AppointmentReportDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| appointmentID |
Unique appointment Id |
integer |
None. |
| appointmentClientID |
Client reference for appointment |
integer |
None. |
| appointmentUserID |
User allocated to appointment |
integer |
None. |
| appointmentDate |
Date of appointment |
date |
None. |
| appointmentStartTime |
Starting time of appointment |
date |
None. |
| appointmentEndTime |
Scheduled end time of appointment |
date |
None. |
| appointmentNotes_Carer |
Notes for carer |
string |
None. |
| appointmentReferenceNumber |
Reference number |
string |
None. |
| appointmentStatus1 |
Appointment status |
integer |
None. |
| appointmentQualificationLevel |
appointment qualification Level required |
string |
None. |
| appointmentDuration |
Appointment Duration |
integer |
None. |
| appointmentNotes |
Appointment general notes |
string |
None. |
| appointmentEstCarerCost |
Appointment estimated cost to carer |
decimal number |
None. |
| appointmentCost |
Appointment actual cost |
decimal number |
None. |
| appointmentShiftCode |
Appointment Shift Code assigned |
string |
None. |
| appointmentStatus2 |
Appointment secondary status |
integer |
None. |
| appointmentStatus3 |
Appointment status (extra) |
integer |
None. |
| appointmentStatus4 |
Appointment status (extra) |
decimal number |
None. |
| appointmentStatusTags |
Appointment tagged statuses |
string |
None. |
| appointmentTasks |
Appointment Tasks required to be performed |
string |
None. |
| appointmentMedications |
appointment medication |
string |
None. |
| appointmentMedicationDetails |
Appointment medication administration details |
string |
None. |
| appointmentEquipment |
Appointment Equipment required |
string |
None. |
| appointmentEquipmentDetails |
Appointment equipment operation details |
string |
None. |
| appointmentRepeat |
Appointment is a repeat appointment |
boolean |
None. |
| appointmentNotes_Admin |
Notes made by administration staff |
string |
None. |
Response Formats
application/json, text/json
{
"appointmentID": 776,
"appointmentClientID": 123456,
"appointmentUserID": 321,
"appointmentDate": "2024-04-25T11:10:42.6621298+10:00",
"appointmentStartTime": "2024-04-25T11:10:42.6621298+10:00",
"appointmentEndTime": "2024-04-25T11:10:42.6621298+10:00",
"appointmentNotes_Carer": "sample string 2",
"appointmentReferenceNumber": "sample string 3",
"appointmentStatus1": 15,
"appointmentQualificationLevel": "sample string 4",
"appointmentDuration": 762,
"appointmentNotes": "sample string 5",
"appointmentEstCarerCost": 1.1,
"appointmentCost": 1.1,
"appointmentShiftCode": "sample string 6",
"appointmentStatus2": 815,
"appointmentStatus3": 710,
"appointmentStatus4": 1.1,
"appointmentStatusTags": "sample string 7",
"appointmentTasks": "sample string 8",
"appointmentMedications": "sample string 9",
"appointmentMedicationDetails": "sample string 10",
"appointmentEquipment": "sample string 11",
"appointmentEquipmentDetails": "sample string 12",
"appointmentRepeat": true,
"appointmentNotes_Admin": "sample string 13"
}
application/xml, text/xml
<AppointmentReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Controllers"> <appointmentClientID>123456</appointmentClientID> <appointmentCost>1.1</appointmentCost> <appointmentDate>2024-04-25T11:10:42.6621298+10:00</appointmentDate> <appointmentDuration>762</appointmentDuration> <appointmentEndTime>2024-04-25T11:10:42.6621298+10:00</appointmentEndTime> <appointmentEquipment>sample string 11</appointmentEquipment> <appointmentEquipmentDetails>sample string 12</appointmentEquipmentDetails> <appointmentEstCarerCost>1.1</appointmentEstCarerCost> <appointmentID>776</appointmentID> <appointmentMedicationDetails>sample string 10</appointmentMedicationDetails> <appointmentMedications>sample string 9</appointmentMedications> <appointmentNotes>sample string 5</appointmentNotes> <appointmentNotes_Admin>sample string 13</appointmentNotes_Admin> <appointmentNotes_Carer>sample string 2</appointmentNotes_Carer> <appointmentQualificationLevel>sample string 4</appointmentQualificationLevel> <appointmentReferenceNumber>sample string 3</appointmentReferenceNumber> <appointmentRepeat>true</appointmentRepeat> <appointmentShiftCode>sample string 6</appointmentShiftCode> <appointmentStartTime>2024-04-25T11:10:42.6621298+10:00</appointmentStartTime> <appointmentStatus1>15</appointmentStatus1> <appointmentStatus2>815</appointmentStatus2> <appointmentStatus3>710</appointmentStatus3> <appointmentStatus4>1.1</appointmentStatus4> <appointmentStatusTags>sample string 7</appointmentStatusTags> <appointmentTasks>sample string 8</appointmentTasks> <appointmentUserID>321</appointmentUserID> </AppointmentReportDetails>