GET api/CategoryTypes/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

CategoryType
NameDescriptionTypeAdditional 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": "6981f605-c5d3-4a4f-9048-f54cbf454804",
      "Name": "sample string 2"
    },
    {
      "Identity": "6981f605-c5d3-4a4f-9048-f54cbf454804",
      "Name": "sample string 2"
    }
  ],
  "ReadPermissionGroups": [
    {
      "Identity": "6981f605-c5d3-4a4f-9048-f54cbf454804",
      "Name": "sample string 2"
    },
    {
      "Identity": "6981f605-c5d3-4a4f-9048-f54cbf454804",
      "Name": "sample string 2"
    }
  ],
  "WritePermissionGroups": [
    {
      "Identity": "6981f605-c5d3-4a4f-9048-f54cbf454804",
      "Name": "sample string 2"
    },
    {
      "Identity": "6981f605-c5d3-4a4f-9048-f54cbf454804",
      "Name": "sample string 2"
    }
  ],
  "Identity": "9639ec4d-95a1-4aa1-ade2-5fdc8e0e71cb",
  "Name": "sample string 4"
}

application/xml, text/xml

Sample:
<CategoryType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">9639ec4d-95a1-4aa1-ade2-5fdc8e0e71cb</Identity>
  <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 4</Name>
  <ReadPermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>6981f605-c5d3-4a4f-9048-f54cbf454804</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>6981f605-c5d3-4a4f-9048-f54cbf454804</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </ReadPermissionGroups>
  <WritePermissionGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>6981f605-c5d3-4a4f-9048-f54cbf454804</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>6981f605-c5d3-4a4f-9048-f54cbf454804</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </WritePermissionGroups>
  <Description>sample string 1</Description>
  <IsAdditionalFilter>true</IsAdditionalFilter>
  <ParentCategoryTypeIdentities xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
    <d2p1:NamedObject>
      <d2p1:Identity>6981f605-c5d3-4a4f-9048-f54cbf454804</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
    <d2p1:NamedObject>
      <d2p1:Identity>6981f605-c5d3-4a4f-9048-f54cbf454804</d2p1:Identity>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:NamedObject>
  </ParentCategoryTypeIdentities>
</CategoryType>