GET api/CategoryTypes/UserCategoryTypes?includeAdditional={includeAdditional}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| includeAdditional | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of CategoryType| Name | Description | Type | Additional information |
|---|---|---|---|
| Description | string |
None. |
|
| IsAdditionalFilter | boolean |
None. |
|
| ParentCategoryTypeIdentities | Collection of NamedObject |
None. |
|
| ReadPermissionGroups | Collection of PermissionObject |
None. |
|
| WritePermissionGroups | Collection of PermissionObject |
None. |
|
| BookPermissionGroups | Collection of PermissionObject |
None. |
|
| RequestPermissionGroups | Collection of PermissionWithApproval |
None. |
|
| Identity | globally unique identifier |
None. |
|
| Name | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Description": "sample string 1",
"IsAdditionalFilter": true,
"ParentCategoryTypeIdentities": [
{
"Identity": "e18a4408-6bbf-4cb5-b94c-86997396e8d5",
"Name": "sample string 2"
},
{
"Identity": "e18a4408-6bbf-4cb5-b94c-86997396e8d5",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
]
}
],
"Identity": "aaa1de63-0167-47d2-8239-779a1a9613c0",
"Name": "sample string 4"
},
{
"Description": "sample string 1",
"IsAdditionalFilter": true,
"ParentCategoryTypeIdentities": [
{
"Identity": "e18a4408-6bbf-4cb5-b94c-86997396e8d5",
"Name": "sample string 2"
},
{
"Identity": "e18a4408-6bbf-4cb5-b94c-86997396e8d5",
"Name": "sample string 2"
}
],
"ReadPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
],
"WritePermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
],
"BookPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
],
"RequestPermissionGroups": [
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
]
},
{
"PermissionTarget": {
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
"Approvers": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "5ec2f532-367e-4948-a073-7b12ffde15db",
"Name": "sample string 2"
}
]
}
],
"Identity": "aaa1de63-0167-47d2-8239-779a1a9613c0",
"Name": "sample string 4"
}
]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.