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 NamedObject	None.
WritePermissionGroups	Collection of NamedObject	None.
Identity	globally unique identifier	None.
Name	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Description": "sample string 1",
    "IsAdditionalFilter": true,
    "ParentCategoryTypeIdentities": [
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      },
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      }
    ],
    "ReadPermissionGroups": [
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      },
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      }
    ],
    "WritePermissionGroups": [
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      },
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      }
    ],
    "Identity": "8379bb1a-9fc5-4336-9722-7a0fcbf49c8f",
    "Name": "sample string 4"
  },
  {
    "Description": "sample string 1",
    "IsAdditionalFilter": true,
    "ParentCategoryTypeIdentities": [
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      },
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      }
    ],
    "ReadPermissionGroups": [
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      },
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      }
    ],
    "WritePermissionGroups": [
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      },
      {
        "Identity": "6fa7b4e0-5c02-4890-8424-95b218682f85",
        "Name": "sample string 2"
      }
    ],
    "Identity": "8379bb1a-9fc5-4336-9722-7a0fcbf49c8f",
    "Name": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCategoryType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <CategoryType>
    <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">8379bb1a-9fc5-4336-9722-7a0fcbf49c8f</Identity>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name>
    <ReadPermissionGroups xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
    </ReadPermissionGroups>
    <WritePermissionGroups xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
    </WritePermissionGroups>
    <Description>sample string 1</Description>
    <IsAdditionalFilter>true</IsAdditionalFilter>
    <ParentCategoryTypeIdentities xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
    </ParentCategoryTypeIdentities>
  </CategoryType>
  <CategoryType>
    <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">8379bb1a-9fc5-4336-9722-7a0fcbf49c8f</Identity>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name>
    <ReadPermissionGroups xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
    </ReadPermissionGroups>
    <WritePermissionGroups xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
    </WritePermissionGroups>
    <Description>sample string 1</Description>
    <IsAdditionalFilter>true</IsAdditionalFilter>
    <ParentCategoryTypeIdentities xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
      <d3p1:NamedObject>
        <d3p1:Identity>6fa7b4e0-5c02-4890-8424-95b218682f85</d3p1:Identity>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:NamedObject>
    </ParentCategoryTypeIdentities>
  </CategoryType>
</ArrayOfCategoryType>