GET List/TicketCategory/Items/Default

Some tooltip text!

• 4 minutes to read

 • 4 minutes to read

GET /api/v1/List/TicketCategory/Items/Default

Gets a default TicketCategoryEntity list item.

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
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.

Response:

OK

Response	Description
200	OK

Response body: TicketCategoryEntity

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

GET /api/v1/List/TicketCategory/Items/Default
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

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

{
  "TicketCategoryId": 174,
  "ParentId": 389,
  "Name": "Harber LLC",
  "Fullname": "sunt",
  "CategoryMaster": 740,
  "Flags": "AcceptWhenReplying",
  "DelegateMethod": "Even",
  "ExternalName": "Wiza Inc and Sons",
  "ClosingStatus": "Active",
  "MsgClosingStatus": "Active",
  "AssignmentLag": 580,
  "ReplyTemplate": 628,
  "NotificationEmail": "dean@walsh.com",
  "DefaultTicketStatus": null,
  "DefaultMessageStatus": null,
  "EffectiveReplyTemplateId": 342,
  "ExtraFields": {
    "ExtraFields1": "provident",
    "ExtraFields2": "fugit"
  },
  "CustomFields": {
    "CustomFields1": "consequatur",
    "CustomFields2": "laborum"
  },
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 617
    }
  }
}