GET PlanCare2Api/DynamicData/AppointmentProtocols?appointmentlist={appointmentlist}

Gets protocols by a list of unique appointment identifiers

Request Information

URI Parameters

NameDescriptionTypeAdditional information
appointmentlist

The list of appointment identifiers seperated by comma to obtain the protocols for

string

Required

Body Parameters

None.

Response Information

Resource Description

Protocols by appointment, name and content

Collection of AppointmentProtocolsResult
NameDescriptionTypeAdditional information
Appointmentid

Identifier of the appointment in which the protocol is linked

integer

None.

Activity

Name of the activity, activities are clustered under a product

string

None.

Protocol

Content of de protocol in RTF

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Appointmentid": 1,
    "Activity": "sample string 1",
    "Protocol": "sample string 2"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDynamicDataController.AppointmentProtocolsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Controllers">
  <DynamicDataController.AppointmentProtocolsResult>
    <Activity>sample string 1</Activity>
    <Appointmentid>1</Appointmentid>
    <Protocol>sample string 2</Protocol>
  </DynamicDataController.AppointmentProtocolsResult>
  <DynamicDataController.AppointmentProtocolsResult>
    <Activity>sample string 1</Activity>
    <Appointmentid>1</Appointmentid>
    <Protocol>sample string 2</Protocol>
  </DynamicDataController.AppointmentProtocolsResult>
</ArrayOfDynamicDataController.AppointmentProtocolsResult>