GET PlanCare2Api/DynamicData/ClientProtocols?clientlist={clientlist}

Gets relevant common and client protocols by a list of unique client identifiers

Request Information

URI Parameters

Name	Description	Type	Additional information
clientlist	The list of client identifiers seperated by comma to obtain the protocols for	string	Required

Body Parameters

None.

Response Information

Resource Description

Common and client protocols by client, type, name and content

Collection of ClientProtocolsResult

Name	Description	Type	Additional information
Clientid	Identifier of the client	integer	Nullable
Clientprotocolid	Identifier of the clientprotocol (only for type "clientprotocol")	integer	Nullable
Name	Name of the protocol	string	-
Arrangement	Name of the arrangement (if applied)	string	-
Activity	Name of the protocol (if applied)	string	-
Type	Type of the protocol. Possible values are "clientprotocol" (which is a clientprotocol optionaly applied to an activity in the arrangement) and "Common" (which is a common protocol applied to an activity).	string	-
Validfrom	The date from which the protocol is valid	date	Nullable
Validuntil	The date to which the protocol is valid	date	Nullable
Protocol	Content of de protocol in RTF	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Clientid": 1,
    "Clientprotocolid": 1,
    "Name": "sample string 1",
    "Arrangement": "sample string 2",
    "Activity": "sample string 3",
    "Type": "sample string 4",
    "Validfrom": "2026-05-26T21:07:39.8304223+02:00",
    "Validuntil": "2026-05-26T21:07:39.8304223+02:00",
    "Protocol": "sample string 5"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDynamicDataController.ClientProtocolsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Controllers">
  <DynamicDataController.ClientProtocolsResult>
    <Activity>sample string 3</Activity>
    <Arrangement>sample string 2</Arrangement>
    <Clientid>1</Clientid>
    <Clientprotocolid>1</Clientprotocolid>
    <Name>sample string 1</Name>
    <Protocol>sample string 5</Protocol>
    <Type>sample string 4</Type>
    <Validfrom>2026-05-26T21:07:39.8304223+02:00</Validfrom>
    <Validuntil>2026-05-26T21:07:39.8304223+02:00</Validuntil>
  </DynamicDataController.ClientProtocolsResult>
  <DynamicDataController.ClientProtocolsResult>
    <Activity>sample string 3</Activity>
    <Arrangement>sample string 2</Arrangement>
    <Clientid>1</Clientid>
    <Clientprotocolid>1</Clientprotocolid>
    <Name>sample string 1</Name>
    <Protocol>sample string 5</Protocol>
    <Type>sample string 4</Type>
    <Validfrom>2026-05-26T21:07:39.8304223+02:00</Validfrom>
    <Validuntil>2026-05-26T21:07:39.8304223+02:00</Validuntil>
  </DynamicDataController.ClientProtocolsResult>
</ArrayOfDynamicDataController.ClientProtocolsResult>