TicketCode

  • 15.5
This article is may not be up to date with the latest stable release of M4.

Description

The Ticket Code endpoint provides the API consumer with access to methods pertaining to ticket codes and related data objects. The methods allow consumers to pull ticket code data.

Methods

URL base/Workforce/TicketCode/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to the Ticket Code.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
  {
    "HttpAction": "Get",
    "MethodName": "GetTicketCode",
    "Description": "Returns the record for a single 'Ticket Code' given the passed in ID value (see Path).",
    "Path": "/TicketCode/GetTicketCode/25032"
  },
  {
    "HttpAction": "Get",
    "MethodName": "GetTicketCodes",
    "Description": "Returns all 'Ticket Codes' in the database (see Path).",
    "Path": "/TicketCode/GetTicketCodes"
  },
  {
    "HttpAction": "Get",
    "MethodName": "GetTicketCodesByCategory",
    "Description": "Returns all 'Ticket Codes' associated with the specified 'Ticket Category' referenced in the passed in ID value (see Path).",
    "Path": "/TicketCode/GetTicketCodesByCategory/25032"
  }
]
URL base/Workforce/TicketCode/GetTicketCodes
Action GET
Description Returns a list of Ticket Code objects in the M4 database.
Parameters None
Returns A list of JSON Ticket Code data objects.
Sample Return Object 
[
  {
    "ID": 84,
    "Description": "CABLE DAMAGE",
    "TicketType": 1,
    "TicketCategory": 4,
    "DurationMins": 30,
    "TransitionTemplate": 1,
    "NotifyDispatcher": false,
    "NotifyTech": false,
    "PostLeadTime": null,
    "Notify": null
  },
  {
    "ID": 4,
    "Description": "CALLER ID TROUBLE",
    "TicketType": 1,
    "TicketCategory": 4,
    "DurationMins": 30,
    "TransitionTemplate": 1,
    "NotifyDispatcher": false,
    "NotifyTech": false,
    "PostLeadTime": null,
    "Notify": null
  },
  {
    "ID": 5,
    "Description": "CAN NOT BE CALLED",
    "TicketType": 1,
    "TicketCategory": 4,
    "DurationMins": 30,
    "TransitionTemplate": 1,
    "NotifyDispatcher": false,
    "NotifyTech": false,
    "PostLeadTime": null,
    "Notify": null
  }
]
URL base/Workforce/TicketCode/GetTicketCode/ID
Action GET
Description Returns a Ticket Code object when given an ID of a valid ticket Code in the M4 database.
Parameters
Name Required? Code Description
ID Yes Integer An integer value representing the ID of a Ticket Code in the M4 database.
Returns A JSON Ticket Code data object
Sample Return Object 
{
    "ID": 4,
    "Description": "CALLER ID TROUBLE",
    "TicketType": 1,
    "TicketCategory": 4,
    "DurationMins": 30,
    "TransitionTemplate": 1,
    "NotifyDispatcher": false,
    "NotifyTech": false,
    "PostLeadTime": null,
    "Notify": null
}
URL base/Workforce/TicketCode/GetTicketCodesByCategory/ID
Action GET
Description Returns a List of Ticket Code objects when given an ID of a valid ticket category in the M4 database.
Parameters
Name Required? Code Description
ID Yes Integer An integer value representing the ID of a Ticket Category in the M4 database.
Returns A list of JSON Ticket Code data objects
Sample Return Object 
[
  {
    "ID": 7,
    "Description": "CAN NOT BREAK DIAL TONE",
    "TicketType": 1,
    "TicketCategory": 4,
    "DurationMins": 30,
    "TransitionTemplate": 1,
    "NotifyDispatcher": false,
    "NotifyTech": false,
    "PostLeadTime": null,
    "Notify": null
  },
  {
    "ID": 9,
    "Description": "CAN NOT CALL INTERNATIONAL",
    "TicketType": 1,
    "TicketCategory": 4,
    "DurationMins": 30,
    "TransitionTemplate": 1,
    "NotifyDispatcher": false,
    "NotifyTech": false,
    "PostLeadTime": null,
    "Notify": null
  }
]

Was this article helpful?

Yes No

Related Articles