GET api/Categories/GetTicketCategories?serviceId={serviceId}

Gets categories for ticket

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serviceId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of GetTicketCategoriesResult
NameDescriptionTypeAdditional information
Id

Category id

integer

None.

Name

The name

string

None.

Disabled

If true, the category is disabled

boolean

None.

ItemSelectionRequired

If true, you must select at least one category item

boolean

None.

Multiselect

If true, the category allows to choose more category items

boolean

None.

CategoryItems

Structured (as a tree) category items

Collection of CategoryItem

None.

DisableForNewEntity

The category is not available when creating a new entity, f.e. for a new Ticket

boolean

None.

ShowForEndUserAndSmartUser

The category is shown for user

boolean

None.

EndUserAndSmartUserCanEdit

The category can be edited by EU or SU

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "Category",
    "Disabled": false,
    "ItemSelectionRequired": false,
    "Multiselect": false,
    "CategoryItems": [
      {
        "Id": 1,
        "Name": "Category item",
        "Color": "#FF9900",
        "IsFolder": false,
        "Children": null
      }
    ],
    "DisableForNewEntity": false,
    "ShowForEndUserAndSmartUser": false,
    "EndUserAndSmartUserCanEdit": false
  }
]

application/xml, text/xml

Sample:
<ArrayOfGetTicketCategoriesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <GetTicketCategoriesResult>
    <CategoryItems xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
      <d3p1:CategoryItem>
        <d3p1:Children i:nil="true" />
        <d3p1:Color>#FF9900</d3p1:Color>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsFolder>false</d3p1:IsFolder>
        <d3p1:Name>Category item</d3p1:Name>
      </d3p1:CategoryItem>
    </CategoryItems>
    <DisableForNewEntity>false</DisableForNewEntity>
    <Disabled>false</Disabled>
    <EndUserAndSmartUserCanEdit>false</EndUserAndSmartUserCanEdit>
    <Id>1</Id>
    <ItemSelectionRequired>false</ItemSelectionRequired>
    <Multiselect>false</Multiselect>
    <Name>Category</Name>
    <ShowForEndUserAndSmartUser>false</ShowForEndUserAndSmartUser>
  </GetTicketCategoriesResult>
</ArrayOfGetTicketCategoriesResult>