GET PlanCare2Api/ClientReports/{clientId}/AppointmentRemarks
Retrieves the completed appointments for the given client
Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
The client to fetch appointments for. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The the completed appointments for the given client.
Collection of AppointmentRemark| Name | Description | Type | Additional information |
|---|---|---|---|
| Reason |
The given reason for this completion/cancellation |
string |
None |
| Name |
The name of employee who made the completion/cancellation |
string |
None |
| Start |
The start time of the appointment. |
date |
None |
| End |
The end time of the appointment. |
date |
None |
| Status |
The status of the appointment. |
string |
None |
| AppointmentType |
The type of the appointment. |
string |
None |
| Timestamp |
The time when the appointment was completed/cancelled. |
date |
None |
| Title |
The subject of the appointment. |
string |
None |
Response Formats
application/json
Sample:
text/json
Sample:
application/xml
Sample:
text/xml
Sample: