GET PlanCare2Api/ClientProtocols?clientId={clientId}&referenceDate={referenceDate}&format={format}

Retrieve all protocols for the selected client.

Requires 'Start' permission for function ClientProtocols {B5597D92-76C6-41AC-A2AA-C46E0E6E6D57}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The client for whom to fetch the protocols.	integer	Required
referenceDate	Filters protocols valid on given date, if null then all protocols are returned.	date	Nullable
format	Format of the content.	ApiTextFormat	Default value is RTF

Body Parameters

None.

Response Information

Resource Description

A list of protocols.

Collection of ClientProtocol

Name	Description	Type	Additional information
Name	The name of the protocol	string	-
ValidFrom	The start date	date	-
ValidUntil	The end date	date	Nullable
ContentValue	The content of the protocol in rtf-format (if null then use the ContentDocumentId)	string	-
ContentDocumentId	The id of the document	integer	Nullable
Arrangement	Name of the arrangement	string	-
Act	Name of the act	string	-
ProtocolCategoryId	The id of the protocolcategory	integer	-
ProtocolCategoryName	The name of the protocolcategory	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Name": "sample string 1",
    "ValidFrom": "2026-05-26T21:07:42.8940481+02:00",
    "ValidUntil": "2026-05-26T21:07:42.8940481+02:00",
    "ContentValue": "sample string 3",
    "ContentDocumentId": 1,
    "Arrangement": "sample string 4",
    "Act": "sample string 5",
    "ProtocolCategoryId": 6,
    "ProtocolCategoryName": "sample string 7"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientProtocol xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <ClientProtocol>
    <Act>sample string 5</Act>
    <Arrangement>sample string 4</Arrangement>
    <ContentDocumentId>1</ContentDocumentId>
    <ContentValue>sample string 3</ContentValue>
    <Name>sample string 1</Name>
    <ProtocolCategoryId>6</ProtocolCategoryId>
    <ProtocolCategoryName>sample string 7</ProtocolCategoryName>
    <ValidFrom>2026-05-26T21:07:42.8940481+02:00</ValidFrom>
    <ValidUntil>2026-05-26T21:07:42.8940481+02:00</ValidUntil>
  </ClientProtocol>
  <ClientProtocol>
    <Act>sample string 5</Act>
    <Arrangement>sample string 4</Arrangement>
    <ContentDocumentId>1</ContentDocumentId>
    <ContentValue>sample string 3</ContentValue>
    <Name>sample string 1</Name>
    <ProtocolCategoryId>6</ProtocolCategoryId>
    <ProtocolCategoryName>sample string 7</ProtocolCategoryName>
    <ValidFrom>2026-05-26T21:07:42.8940481+02:00</ValidFrom>
    <ValidUntil>2026-05-26T21:07:42.8940481+02:00</ValidUntil>
  </ClientProtocol>
</ArrayOfClientProtocol>