POST Agents/List/GetTicketCategoryList

• 5 minutes to read
 • 5 minutes to read 
POST /api/v1/Agents/List/GetTicketCategoryList

Gets an array of TicketCategoryEntity objects.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/List/GetTicketCategoryList?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: ticketCategoryEntityIds

The primary keys.

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
TicketCategoryId int32 The id of the ticket category. (primary key)
ParentId int32 The parent category for this category. -1 if this is a toplevel category.
Name string The (short) name of this category. E.g. 'support'.
Fullname string The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.
CategoryMaster int32 The user associated with this category.
Flags string A bitmask representing flags for this category.
DelegateMethod string An integer indicating the delegation method for this category.
ExternalName string The external name for this category, used for the customer frontend.
ClosingStatus string Determines the default status used in the GUI when creating a ticket
MsgClosingStatus string Determines the default status used in the GUI when adding a request to a ticket
AssignmentLag int32 Number of minutes we shall override the assignment if a customer sends consecutive messages to this category
ReplyTemplate int32 Reply template to merge with messages posted in this category
NotificationEmail string Comma separated list of addresses to notify when requests are redelegated to (unassigned) in this category.
DefaultTicketStatus TicketStatusEntity Default status for new tickets, if 0 then there is a fallback to a user-dependent value
DefaultMessageStatus TicketStatusEntity Default status for new messages, if 0 then there is a fallback to a user-dependent value
EffectiveReplyTemplateId int32 Id of reply template to merge into messages, whose ticket belongs to this category. Also takes into account 'Apply to subcategories' on parent categories. This is a calculated, readonly field.
ExtraFields object Deprecated: Use {SuperOffice.CRM.Services.TicketCategoryEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.
CustomFields object Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.TicketCategoryEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/List/GetTicketCategoryList
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "TicketCategoryId": 466,
    "ParentId": 874,
    "Name": "Stiedemann, Hegmann and Grimes",
    "Fullname": "eius",
    "CategoryMaster": 911,
    "Flags": "AcceptWhenReplying",
    "DelegateMethod": "Even",
    "ExternalName": "Mayer LLC",
    "ClosingStatus": "Active",
    "MsgClosingStatus": "Active",
    "AssignmentLag": 458,
    "ReplyTemplate": 231,
    "NotificationEmail": "wilton.homenick@wiza.biz",
    "DefaultTicketStatus": null,
    "DefaultMessageStatus": null,
    "EffectiveReplyTemplateId": 338,
    "ExtraFields": {
      "ExtraFields1": "molestiae",
      "ExtraFields2": "consequuntur"
    },
    "CustomFields": {
      "CustomFields1": "eaque",
      "CustomFields2": "quia"
    },
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 615
      }
    }
  }
]