- 15.5
Description
The Ticket Priority endpoint provides the API consumer with access to methods pertaining to ticket priorities and related data objects. The methods allow consumers to pull ticket priority data.
Methods
| URL | base/Workforce/TicketPriority/Specification |
|---|---|
| Action | GET |
| Description | Returns a data dictionary that details the available web service methods related to the Ticket Priority. |
| Parameters | None |
| Returns | A JSON object with method descriptions |
| Sample Return Object | |
[
{
"HttpAction": "Get",
"MethodName": "GetTicketPriority",
"Description": "Returns the record for a single 'Ticket Priority' given the passed in ID value (see Path).",
"Path": "/TicketPriority/GetTicketPriority/25032"
},
{
"HttpAction": "Get",
"MethodName": "GetTicketPriorities",
"Description": "Returns all 'Ticket Priorities' in the database (see Path).",
"Path": "/TicketPriority/GetTicketPriorities"
}
]
|
|
| URL | base/Workforce/TicketPriority/GetTicketPriorities |
|---|---|
| Action | GET |
| Description | Returns a list of Ticket Priority objects in the M4 database. |
| Parameters | None |
| Returns | A list of JSON Ticket Priority data objects. |
| Sample Return Object | |
[
{
"ID": 1,
"Description": "Low",
"ResourceStyleCategory": "rsCategoryGreen"
},
{
"ID": 2,
"Description": "Medium",
"ResourceStyleCategory": "rsCategoryBrighhtYellow"
},
{
"ID": 3,
"Description": "High",
"ResourceStyleCategory": "rsCategoryRed"
},
{
"ID": 4,
"Description": "Critical",
"ResourceStyleCategory": "rsCategoryDarkRed"
}
]
|
|
| URL | base/Workforce/TicketPriority/GetTicketPriority/ID | ||
|---|---|---|---|
| Action | GET | ||
| Description | Returns a Ticket Priority object when given an ID of a valid ticket Priority in the M4 database. | ||
| Parameters | |||
| Name | Required? | Type | Description |
| ID | Yes | Integer | An integer value representing the ID of a Ticket Priority in the M4 database. |
| Returns | A JSON Ticket Priority data object | ||
| Sample Return Object | |||
{
"ID": 2,
"Description": "Medium",
"ResourceStyleCategory": "rsCategoryBrighhtYellow"
}
|
|||