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, text/json

Sample:

[
  {
    "$id": "1",
    "Reason": "sample string 1",
    "Name": "sample string 2",
    "Start": "2026-05-26T21:10:05.1594233+02:00",
    "End": "2026-05-26T21:10:05.1594233+02:00",
    "Status": "sample string 5",
    "AppointmentType": "sample string 6",
    "Timestamp": "2026-05-26T21:10:05.1594233+02:00",
    "Title": "sample string 8"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAppointmentRemark xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
  <AppointmentRemark>
    <AppointmentType>sample string 6</AppointmentType>
    <End>2026-05-26T21:10:05.1594233+02:00</End>
    <Name>sample string 2</Name>
    <Reason>sample string 1</Reason>
    <Start>2026-05-26T21:10:05.1594233+02:00</Start>
    <Status>sample string 5</Status>
    <Timestamp>2026-05-26T21:10:05.1594233+02:00</Timestamp>
    <Title>sample string 8</Title>
  </AppointmentRemark>
  <AppointmentRemark>
    <AppointmentType>sample string 6</AppointmentType>
    <End>2026-05-26T21:10:05.1594233+02:00</End>
    <Name>sample string 2</Name>
    <Reason>sample string 1</Reason>
    <Start>2026-05-26T21:10:05.1594233+02:00</Start>
    <Status>sample string 5</Status>
    <Timestamp>2026-05-26T21:10:05.1594233+02:00</Timestamp>
    <Title>sample string 8</Title>
  </AppointmentRemark>
</ArrayOfAppointmentRemark>