- 15.5
Description
The Ticket Type endpoint provides the API consumer with access to methods pertaining to ticket types and related data objects. The methods allow consumers to pull ticket type data.
Methods
| URL | base/Workforce/TicketStatus/Specification |
|---|---|
| Action | GET |
| Description | Returns a data dictionary that details the available web service methods related to the Ticket Status. |
| Parameters | None |
| Returns | A JSON object with method descriptions |
| Sample Return Object | |
[
{
"HttpAction": "Get",
"MethodName": "GetTicketStatuses",
"Description": "Returns the list of all Ticket Statuses in the database.",
"Path": "/Workforce/TicketStatus/GetTicketStatuses"
},
{
"HttpAction": "Get",
"MethodName": "GetTicketStatus",
"Description": "Returns the record for a single Ticket Status given the passed in ID value (see Path)",
"Path": "/Workforce/TicketStatus/GetTicketStatus/25032"
}
]
|
|
| URL | base/Workforce/TicketStatus/GetTicketStatuses |
|---|---|
| Action | GET |
| Description | Returns a list of Ticket Status objects in the M4 database. |
| Parameters | None |
| Returns | A list of JSON Ticket Status data objects. |
| Sample Return Object | |
[
{
"ID": 3,
"TicketStateDesc": "Acknowledged",
"TicketState": null,
"ContextMenuName": "cmAcknowledged1",
"BackColor": "-10157927",
"ForeColor": "-1",
"ResourceStyleStatus": "rsStatusViolet",
"CanReschedule": true,
"NotifyTech": false,
"NotifyDispatcher": true,
"ShowClearCode": false,
"ReassignStatus": false,
"TransitionTemplateID": 1,
"NotifyCustomer": false,
"IsDeferredStatus": false,
"IsEndStatus": false,
"IsPending": false,
"IsCancelled": false
},
{
"ID": 10,
"TicketStateDesc": "Assigned",
"TicketState": null,
"ContextMenuName": "cmAssigned2",
"BackColor": "-13382452",
"ForeColor": "-16777216",
"ResourceStyleStatus": "rsStatusBlue",
"CanReschedule": true,
"NotifyTech": true,
"NotifyDispatcher": false,
"ShowClearCode": false,
"ReassignStatus": false,
"TransitionTemplateID": 2,
"NotifyCustomer": false,
"IsDeferredStatus": false,
"IsEndStatus": false,
"IsPending": false,
"IsCancelled": false
}
]
|
|
| URL | base/Workforce/TicketStatus/GetTicketStatus/ID | ||
|---|---|---|---|
| Action | GET | ||
| Description | Returns a Ticket Status object when given an ID of a valid ticket Status in the M4 database. | ||
| Parameters | |||
| Name | Required? | Type | Description |
| ID | Yes | Integer | An integer value representing the ID of a Ticket Status in the M4 database. |
| Returns | A JSON Ticket Status data object | ||
| Sample Return Object | |||
{
"ID": 10,
"TicketStateDesc": "Assigned",
"TicketState": null,
"ContextMenuName": "cmAssigned2",
"BackColor": "-13382452",
"ForeColor": "-16777216",
"ResourceStyleStatus": "rsStatusBlue",
"CanReschedule": true,
"NotifyTech": true,
"NotifyDispatcher": false,
"ShowClearCode": false,
"ReassignStatus": false,
"TransitionTemplateID": 2,
"NotifyCustomer": false,
"IsDeferredStatus": false,
"IsEndStatus": false,
"IsPending": false,
"IsCancelled": false
}
|
|||