GET api/CategoryTypes?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	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": "6e14d51d-8c7c-4ef4-9f79-552a0a377740",
        "Name": "sample string 2"
      },
      {
        "Identity": "6e14d51d-8c7c-4ef4-9f79-552a0a377740",
        "Name": "sample string 2"
      }
    ],
    "ReadPermissionGroups": [
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      },
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      }
    ],
    "WritePermissionGroups": [
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      },
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      }
    ],
    "BookPermissionGroups": [
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      },
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      }
    ],
    "RequestPermissionGroups": [
      {
        "PermissionTarget": {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
          "Name": "sample string 2"
        },
        "Approvers": [
          {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
            "Name": "sample string 2"
          },
          {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
            "Name": "sample string 2"
          }
        ]
      },
      {
        "PermissionTarget": {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
          "Name": "sample string 2"
        },
        "Approvers": [
          {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
            "Name": "sample string 2"
          },
          {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
            "Name": "sample string 2"
          }
        ]
      }
    ],
    "Identity": "47aa41f4-7344-41ef-8ffc-822215a9743b",
    "Name": "sample string 4"
  },
  {
    "Description": "sample string 1",
    "IsAdditionalFilter": true,
    "ParentCategoryTypeIdentities": [
      {
        "Identity": "6e14d51d-8c7c-4ef4-9f79-552a0a377740",
        "Name": "sample string 2"
      },
      {
        "Identity": "6e14d51d-8c7c-4ef4-9f79-552a0a377740",
        "Name": "sample string 2"
      }
    ],
    "ReadPermissionGroups": [
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      },
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      }
    ],
    "WritePermissionGroups": [
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      },
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      }
    ],
    "BookPermissionGroups": [
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      },
      {
        "PermissionClaim": {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2",
          "ClaimTypeLower": "sample string 1",
          "ClaimValueLower": "sample string 2"
        },
        "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
        "Name": "sample string 2"
      }
    ],
    "RequestPermissionGroups": [
      {
        "PermissionTarget": {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
          "Name": "sample string 2"
        },
        "Approvers": [
          {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
            "Name": "sample string 2"
          },
          {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
            "Name": "sample string 2"
          }
        ]
      },
      {
        "PermissionTarget": {
          "PermissionClaim": {
            "ClaimType": "sample string 1",
            "ClaimValue": "sample string 2",
            "ClaimTypeLower": "sample string 1",
            "ClaimValueLower": "sample string 2"
          },
          "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
          "Name": "sample string 2"
        },
        "Approvers": [
          {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
            "Name": "sample string 2"
          },
          {
            "PermissionClaim": {
              "ClaimType": "sample string 1",
              "ClaimValue": "sample string 2",
              "ClaimTypeLower": "sample string 1",
              "ClaimValueLower": "sample string 2"
            },
            "Identity": "350d093f-2037-4e59-a427-d124a789f4c6",
            "Name": "sample string 2"
          }
        ]
      }
    ],
    "Identity": "47aa41f4-7344-41ef-8ffc-822215a9743b",
    "Name": "sample string 4"
  }
]
application/xml

Sample:
Sample not available.
text/xml

Sample:
Sample not available.