GET api/Appointments/{id}

Untested: Get details for appointment specified by unique Id

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

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

Sample:

{
  "appointmentID": 707,
  "appointmentClientID": 123456,
  "appointmentUserID": 321,
  "appointmentDate": "2024-04-19T01:52:08.8756876+10:00",
  "appointmentStartTime": "2024-04-19T01:52:08.8756876+10:00",
  "appointmentEndTime": "2024-04-19T01:52:08.8756876+10:00",
  "appointmentNotes_Carer": "sample string 2",
  "appointmentReferenceNumber": "sample string 3",
  "appointmentStatus1": 534,
  "appointmentQualificationLevel": "sample string 4",
  "appointmentDuration": 581,
  "appointmentNotes": "sample string 5",
  "appointmentEstCarerCost": 1.1,
  "appointmentCost": 1.1,
  "appointmentShiftCode": "sample string 6",
  "appointmentStatus2": 291,
  "appointmentStatus3": 303,
  "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

Sample:

<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-19T01:52:08.8756876+10:00</appointmentDate>
  <appointmentDuration>581</appointmentDuration>
  <appointmentEndTime>2024-04-19T01:52:08.8756876+10:00</appointmentEndTime>
  <appointmentEquipment>sample string 11</appointmentEquipment>
  <appointmentEquipmentDetails>sample string 12</appointmentEquipmentDetails>
  <appointmentEstCarerCost>1.1</appointmentEstCarerCost>
  <appointmentID>707</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-19T01:52:08.8756876+10:00</appointmentStartTime>
  <appointmentStatus1>534</appointmentStatus1>
  <appointmentStatus2>291</appointmentStatus2>
  <appointmentStatus3>303</appointmentStatus3>
  <appointmentStatus4>1.1</appointmentStatus4>
  <appointmentStatusTags>sample string 7</appointmentStatusTags>
  <appointmentTasks>sample string 8</appointmentTasks>
  <appointmentUserID>321</appointmentUserID>
</AppointmentReportDetails>