GET api/Categories/GetCategory?categoryId={categoryId}

Gets category and its category items

Request Information

URI Parameters

Name	Description	Type	Additional information
categoryId		integer	Required

Body Parameters

None.

Response Information

Resource Description

GetCategoryResult

Name	Description	Type	Additional information
Id	Category id	integer	None.
Name	The name	string	None.
Disabled	If true, the category is disabled	boolean	None.
DisableForNewEntity	OBSOLETE, USE ForTicketsRequired INSTEAD	boolean	None.
DisableForNewTicket	The category is not available when creating a new Ticket	boolean	None.
ForTickets	Enable the category for tickets.	boolean	None.
ForCompanies	Enable the category for companies.	boolean	None.
ForUsers	Enable the category for users.	boolean	None.
ForTrackTimeRecords	Enable the category for track time records.	boolean	None.
ForChats	Enable the category for chats.	boolean	None.
ForCalls	Enable the category for calls.	boolean	None.
SelectionRequired	OBSOLETE, USE ForTicketsRequired INSTEAD	boolean	None.
ForTicketsRequired	The category must be selected for Tickets.	boolean	None.
ForCompaniesRequired	The category must be selected for Companies.	boolean	None.
ForUsersRequired	The category must be selected for Users.	boolean	None.
ForTrackTimeRecordsRequired	The category must be selected for TrackTimeRecords.	boolean	None.
ForChatsRequired	The category must be selected for Chats.	boolean	None.
ForCallsRequired	The category must be selected for Calls.	boolean	None.
ForTicketsRequiredWhenFinished	The category must be selected when the ticket is being finished.	boolean	None.
Multiselect	OBSOLETE. Not used.	boolean	None.
CategoryItems	Structured (as a tree) category items	Collection of CategoryItem	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": "Text",
  "Disabled": false,
  "DisableForNewEntity": false,
  "DisableForNewTicket": false,
  "ForTickets": false,
  "ForCompanies": false,
  "ForUsers": false,
  "ForTrackTimeRecords": false,
  "ForChats": false,
  "ForCalls": false,
  "SelectionRequired": false,
  "ForTicketsRequired": false,
  "ForCompaniesRequired": false,
  "ForUsersRequired": false,
  "ForTrackTimeRecordsRequired": false,
  "ForChatsRequired": false,
  "ForCallsRequired": false,
  "ForTicketsRequiredWhenFinished": false,
  "Multiselect": false,
  "CategoryItems": [
    {
      "Id": 1,
      "Name": "Category item",
      "Color": "#FF9900",
      "IsFolder": false,
      "Disabled": false,
      "Children": null
    }
  ],
  "ShowForEndUserAndSmartUser": false,
  "EndUserAndSmartUserCanEdit": false
}

application/xml, text/xml

Sample:

<GetCategoryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <CategoryItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
    <d2p1:CategoryItem>
      <d2p1:Children i:nil="true" />
      <d2p1:Color>#FF9900</d2p1:Color>
      <d2p1:Disabled>false</d2p1:Disabled>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsFolder>false</d2p1:IsFolder>
      <d2p1:Name>Category item</d2p1:Name>
    </d2p1:CategoryItem>
  </CategoryItems>
  <DisableForNewEntity>false</DisableForNewEntity>
  <DisableForNewTicket>false</DisableForNewTicket>
  <Disabled>false</Disabled>
  <EndUserAndSmartUserCanEdit>false</EndUserAndSmartUserCanEdit>
  <ForCalls>false</ForCalls>
  <ForCallsRequired>false</ForCallsRequired>
  <ForChats>false</ForChats>
  <ForChatsRequired>false</ForChatsRequired>
  <ForCompanies>false</ForCompanies>
  <ForCompaniesRequired>false</ForCompaniesRequired>
  <ForTickets>false</ForTickets>
  <ForTicketsRequired>false</ForTicketsRequired>
  <ForTicketsRequiredWhenFinished>false</ForTicketsRequiredWhenFinished>
  <ForTrackTimeRecords>false</ForTrackTimeRecords>
  <ForTrackTimeRecordsRequired>false</ForTrackTimeRecordsRequired>
  <ForUsers>false</ForUsers>
  <ForUsersRequired>false</ForUsersRequired>
  <Id>1</Id>
  <Multiselect>false</Multiselect>
  <Name>Text</Name>
  <SelectionRequired>false</SelectionRequired>
  <ShowForEndUserAndSmartUser>false</ShowForEndUserAndSmartUser>
</GetCategoryResult>