GET PlanCare2Api/Documents/ClientDocuments/Metadata?clientId={clientId}&categoryId={categoryId}

Returns a list of available ClientDocuments of the client in the given category.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client identifier	integer	Required
categoryId	Document category identifier as provided by ClientDocumentCategories	integer	Nullable

Body Parameters

None.

Response Information

Resource Description

List of available documents of the client in the given category.

Collection of ClientDocumentMetadata

Name	Description	Type	Additional information
ClientId	Id of the client associated with the document.	integer	-
CategoryName	Name of the document category.	string	-
OwnerName	Name of the owner.	string	-
FileType	FileType.	string	-
PriorityLevel	Level of priority.	integer	Nullable
DateModified	DateModified.	date	Nullable
Id	Id of the document. Should be 0 for new instance.	integer	Required
CategoryId	Id of the document category.	integer	Required
OwnerId	The internal id of the person who has done the registration (The Access user id). When the person is not the same as the logged on employee, then the logged on employee must be authorized in Plancare2 to store information on behalf of the given person. The ownerId may not be changed by the user of the API.	integer	Required
Name	The name of the document.	string	Required
FileName	The original full path to the document. Please note that backslashes should be escaped (see RFC7159). Example: The Windows path to C:\Temp\LogFile.Text should be passed as C:\\Temp\\LogFile.Text.	string	Required
FileSize	Binary size of the document.	integer	-
DateCreated	Date / time the document is stored the first time.	date	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "ClientId": 1,
    "CategoryName": "sample string 2",
    "OwnerName": "sample string 3",
    "FileType": "sample string 4",
    "PriorityLevel": 1,
    "DateModified": "2026-05-26T23:17:42.5779276+02:00",
    "Id": 5,
    "CategoryId": 6,
    "OwnerId": 7,
    "Name": "sample string 8",
    "FileName": "sample string 9",
    "FileSize": 10,
    "DateCreated": "2026-05-26T23:17:42.5779276+02:00"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientDocumentMetadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Documents">
  <ClientDocumentMetadata>
    <CategoryId>6</CategoryId>
    <DateCreated>2026-05-26T23:17:42.5779276+02:00</DateCreated>
    <FileName>sample string 9</FileName>
    <FileSize>10</FileSize>
    <Id>5</Id>
    <Name>sample string 8</Name>
    <OwnerId>7</OwnerId>
    <CategoryName>sample string 2</CategoryName>
    <ClientId>1</ClientId>
    <DateModified>2026-05-26T23:17:42.5779276+02:00</DateModified>
    <FileType>sample string 4</FileType>
    <OwnerName>sample string 3</OwnerName>
    <PriorityLevel>1</PriorityLevel>
  </ClientDocumentMetadata>
  <ClientDocumentMetadata>
    <CategoryId>6</CategoryId>
    <DateCreated>2026-05-26T23:17:42.5779276+02:00</DateCreated>
    <FileName>sample string 9</FileName>
    <FileSize>10</FileSize>
    <Id>5</Id>
    <Name>sample string 8</Name>
    <OwnerId>7</OwnerId>
    <CategoryName>sample string 2</CategoryName>
    <ClientId>1</ClientId>
    <DateModified>2026-05-26T23:17:42.5779276+02:00</DateModified>
    <FileType>sample string 4</FileType>
    <OwnerName>sample string 3</OwnerName>
    <PriorityLevel>1</PriorityLevel>
  </ClientDocumentMetadata>
</ArrayOfClientDocumentMetadata>