POST PlanCare2Api/Documents/MyDepartments

Store a MyDepartments document.

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

Request Information

URI Parameters

None.

Body Parameters

MyDepartmentDocument
Name Description Type Additional information
Content

Byte array (Base64encoded) containing the (new) content of the document.

Collection of byte

Required

OrganizationEntityId

Id of the Organisation Entity associated with the document.

integer

Required

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

-

Request Formats

application/json, text/json

Sample:
{
  "Content": "QEA=",
  "OrganizationEntityId": 1,
  "Id": 2,
  "CategoryId": 3,
  "OwnerId": 4,
  "Name": "sample string 5",
  "FileName": "sample string 6",
  "FileSize": 7,
  "DateCreated": "2026-05-26T21:12:15.2497344+02:00"
}

application/xml, text/xml

Sample:
<MyDepartmentDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Documents">
  <CategoryId>3</CategoryId>
  <DateCreated>2026-05-26T21:12:15.2497344+02:00</DateCreated>
  <FileName>sample string 6</FileName>
  <FileSize>7</FileSize>
  <Id>2</Id>
  <Name>sample string 5</Name>
  <OwnerId>4</OwnerId>
  <OrganizationEntityId>1</OrganizationEntityId>
  <Content>QEA=</Content>
</MyDepartmentDocument>

Response Information

Resource Description

The document metadata.

HttpResponseMessage
Name Description Type Additional information
Version

Version

-

Content

HttpContent

-

StatusCode

HttpStatusCode

-

ReasonPhrase

string

-

Headers

Collection of Object

-

RequestMessage

HttpRequestMessage

-

IsSuccessStatusCode

boolean

-