GET PlanCare2Api/Documents/MyDocuments/Categories
Get all my MyDocument document categories.
Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
List of my document categories.
Collection of DocumentCategory| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Id of the category. Should be 0 for new instance |
integer |
None. |
| Description |
Description of the category |
string |
None. |
| IsEditable |
Are documents in this category editable |
boolean |
None. |
| GroupId |
Id of the group of the category |
integer |
None. |
| GroupName |
Name of the group of the category |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": 1,
"Description": "sample string 2",
"IsEditable": true,
"GroupId": 4,
"GroupName": "sample string 5"
},
{
"$id": "2",
"Id": 1,
"Description": "sample string 2",
"IsEditable": true,
"GroupId": 4,
"GroupName": "sample string 5"
}
]
application/xml, text/xml
Sample:
<ArrayOfDocumentCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Documents">
<DocumentCategory>
<Description>sample string 2</Description>
<GroupId>4</GroupId>
<GroupName>sample string 5</GroupName>
<Id>1</Id>
<IsEditable>true</IsEditable>
</DocumentCategory>
<DocumentCategory>
<Description>sample string 2</Description>
<GroupId>4</GroupId>
<GroupName>sample string 5</GroupName>
<Id>1</Id>
<IsEditable>true</IsEditable>
</DocumentCategory>
</ArrayOfDocumentCategory>