- 15.5
Description
The Ticket Category endpoint provides the API consumer with access to methods pertaining to ticket categories and related data objects. The methods allow consumers to pull ticket category data.
Methods
| URL | base/Workforce/TicketCategory/Specification |
|---|---|
| Action | GET |
| Description | Returns a data dictionary that details the available web service methods related to the Ticket Category. |
| Parameters | None |
| Returns | A JSON object with method descriptions |
| Sample Return Object | |
[
{
"HttpAction": "Get",
"MethodName": "GetTicketCategories",
"Description": "Returns the list of all Ticket Categories in the database.",
"Path": "/Workforce/TicketCategory/GetTicketCategories"
},
{
"HttpAction": "Get",
"MethodName": "GetTicketCategory",
"Description": "Returns the record for a single Ticket Category given the passed in ID value (see Path)",
"Path": "/Workforce/TicketCategory/GetTicketCategory/25032"
}
]
|
|
| URL | base/Workforce/TicketCategory/GetTicketCategories |
|---|---|
| Action | GET |
| Description | Returns a list of Ticket Category objects in the M4 database. |
| Parameters | None |
| Returns | A list of JSON Ticket Category data objects. |
| Sample Return Object | |
[
{
"ID": 9,
"TicketType": 2,
"Description": "Add",
"ResourceStyleCategory": "rsCategoryBlue"
},
{
"ID": 10,
"TicketType": 2,
"Description": "Change",
"ResourceStyleCategory": "rsCategoryBlue"
}
]
|
|
| URL | base/Workforce/TicketCategory/GetTicketCategory/ID | ||
|---|---|---|---|
| Action | GET | ||
| Description | Returns a Ticket Category object when given an ID of a valid ticket category in the M4 database. | ||
| Parameters | |||
| Name | Required? | Type | Description |
| ID | Yes | Integer | An integer value representing the ID of a Ticket Category in the M4 database. |
| Returns | A JSON Ticket Category data object | ||
| Sample Return Object | |||
{
"ID": 10,
"TicketType": 2,
"Description": "Change",
"ResourceStyleCategory": "rsCategoryBlue"
}
|
|||