GET PlanCare2Api/Documents/DocumentCategoryPermissions

Get all document category permissions

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of DocumentCategoryPermissions

Collection of DocumentCategoryPermission

Name	Description	Type	Additional information
DocumentCategory	The DocumentCategory.	DocumentCategory	None
AllowedEmployees	The Identities of the employees that have permission to the DocumentCategory.	Collection of Identity	Deprecated (unavailable from 21.01.1P): Please use 'EmployeePermissions.EmployeeId' instead.
EmployeePermissions	The Identities and Editpermissions of the employees to the DocumentCategory.	Collection of EmployeePermission	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "DocumentCategory": {
      "$id": "2",
      "Id": 1,
      "Description": "sample string 2",
      "IsEditable": true,
      "GroupId": 4,
      "GroupName": "sample string 5"
    },
    "AllowedEmployees": [
      {
        "$id": "3",
        "Identifier": "sample string 1",
        "Type": 0
      },
      {
        "$ref": "3"
      }
    ],
    "EmployeePermissions": [
      {
        "$id": "4",
        "EmployeeId": {
          "$ref": "3"
        },
        "HasEditPermission": true
      },
      {
        "$ref": "4"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocumentCategoryPermission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Documents">
  <DocumentCategoryPermission>
    <AllowedEmployees xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identity>
        <d3p1:Identifier>sample string 1</d3p1:Identifier>
        <d3p1:Type>ExternalId</d3p1:Type>
      </d3p1:Identity>
      <d3p1:Identity>
        <d3p1:Identifier>sample string 1</d3p1:Identifier>
        <d3p1:Type>ExternalId</d3p1:Type>
      </d3p1:Identity>
    </AllowedEmployees>
    <DocumentCategory>
      <Description>sample string 2</Description>
      <GroupId>4</GroupId>
      <GroupName>sample string 5</GroupName>
      <Id>1</Id>
      <IsEditable>true</IsEditable>
    </DocumentCategory>
    <EmployeePermissions>
      <EmployeePermission>
        <EmployeeId xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
          <d5p1:Identifier>sample string 1</d5p1:Identifier>
          <d5p1:Type>ExternalId</d5p1:Type>
        </EmployeeId>
        <HasEditPermission>true</HasEditPermission>
      </EmployeePermission>
      <EmployeePermission>
        <EmployeeId xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
          <d5p1:Identifier>sample string 1</d5p1:Identifier>
          <d5p1:Type>ExternalId</d5p1:Type>
        </EmployeeId>
        <HasEditPermission>true</HasEditPermission>
      </EmployeePermission>
    </EmployeePermissions>
  </DocumentCategoryPermission>
  <DocumentCategoryPermission>
    <AllowedEmployees xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identity>
        <d3p1:Identifier>sample string 1</d3p1:Identifier>
        <d3p1:Type>ExternalId</d3p1:Type>
      </d3p1:Identity>
      <d3p1:Identity>
        <d3p1:Identifier>sample string 1</d3p1:Identifier>
        <d3p1:Type>ExternalId</d3p1:Type>
      </d3p1:Identity>
    </AllowedEmployees>
    <DocumentCategory>
      <Description>sample string 2</Description>
      <GroupId>4</GroupId>
      <GroupName>sample string 5</GroupName>
      <Id>1</Id>
      <IsEditable>true</IsEditable>
    </DocumentCategory>
    <EmployeePermissions>
      <EmployeePermission>
        <EmployeeId xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
          <d5p1:Identifier>sample string 1</d5p1:Identifier>
          <d5p1:Type>ExternalId</d5p1:Type>
        </EmployeeId>
        <HasEditPermission>true</HasEditPermission>
      </EmployeePermission>
      <EmployeePermission>
        <EmployeeId xmlns:d5p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
          <d5p1:Identifier>sample string 1</d5p1:Identifier>
          <d5p1:Type>ExternalId</d5p1:Type>
        </EmployeeId>
        <HasEditPermission>true</HasEditPermission>
      </EmployeePermission>
    </EmployeePermissions>
  </DocumentCategoryPermission>
</ArrayOfDocumentCategoryPermission>