- 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/TicketType/Specification |
|---|---|
| Action | GET |
| Description | Returns a data dictionary that details the available web service methods related to the Ticket Type. |
| Parameters | None |
| Returns | A JSON object with method descriptions |
| Sample Return Object | |
[
{
"HttpAction": "Get",
"MethodName": "GetTicketTypes",
"Description": "Returns the list of all Ticket Types in the database.",
"Path": "/Workforce/TicketType/GetTicketTypes"
},
{
"HttpAction": "Get",
"MethodName": "GetTicketType",
"Description": "Returns the record for a single Ticket Type given the passed in ID value (see Path)",
"Path": "/Workforce/TicketType/GetTicketType/25032"
}
]
|
|
| URL | base/Workforce/TicketType/GetTicketTypes |
|---|---|
| Action | GET |
| Description | Returns a list of Ticket Type objects in the M4 database. |
| Parameters | None |
| Returns | A list of JSON Ticket Type data objects. |
| Sample Return Object | |
[
{
"ID": 100,
"TicketTypeDesc": "NAC",
"LinkTable": "NAC",
"ResourceStyleCategory": "rsCategoryBlue",
"ShowInCreateTicket": true,
"ShowInMobileTech": true,
"ShortCode": "N"
},
{
"ID": 103,
"TicketTypeDesc": "Outage",
"LinkTable": "Outage",
"ResourceStyleCategory": "rsCategoryBrightOrange",
"ShowInCreateTicket": true,
"ShowInMobileTech": true,
"ShortCode": "O"
}
]
|
|
| URL | base/Workforce/TicketType/GetTicketType/ID | ||
|---|---|---|---|
| Action | GET | ||
| Description | Returns a Ticket Type object when given an ID of a valid ticket Type in the M4 database. | ||
| Parameters | |||
| Name | Required? | Type | Description |
| ID | Yes | Integer | An integer value representing the ID of a Ticket Type in the M4 database. |
| Returns | A JSON Ticket Type data object | ||
| Sample Return Object | |||
{
"ID": 100,
"TicketTypeDesc": "NAC",
"LinkTable": "NAC",
"ResourceStyleType": "rsTypeBlue",
"ShowInCreateTicket": true,
"ShowInMobileTech": true,
"ShortCode": "N"
}
|
|||