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

Get the content of a ClientDocument.

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Client identifier as provided by GetClientDocuments

integer

Required

categoryId

Document category identifier as provided by GetClientDocuments

integer

Required

documentId

Document identifier as provided by GetClientDocuments

integer

Required

Body Parameters

None.

Response Information

Resource Description

The document content.

DocumentContent
NameDescriptionTypeAdditional information
OriginalFilename

Filename the document original was given. Should be 0 for new instance

string

None

Name

Name of the document

string

None

Content

Base64encoded content of the document

Collection of byte

None

Response Formats

application/json, text/json

Sample:
{
  "OriginalFilename": "sample string 1",
  "Name": "sample string 2",
  "Content": "QEA="
}

application/xml, text/xml

Sample:
<DocumentContent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Documents">
  <Content>QEA=</Content>
  <Name>sample string 2</Name>
  <OriginalFilename>sample string 1</OriginalFilename>
</DocumentContent>