GET PlanCare2Api/Documents/MyDepartments/Metadata?categoryId={categoryId}&organizationEntityId={organizationEntityId}
Returns a list of MyDepartment documents of the employee in the given category.
Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| categoryId |
Document category identifier as provided by MyDepartment document categories. |
integer |
Required |
| organizationEntityId |
Organization entity identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
List of metadata of MyDepartment documents.
Collection of MyDepartmentsDocumentMetaData| Name | Description | Type | Additional information |
|---|---|---|---|
| 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 |
None |
| DateCreated |
Date / time the document is stored the first time. |
date |
None |
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.