TicketClearCode

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

Description

The TicketClearCode endpoint provides the API consumer with access to methods pertaining to ticket clear codes. The methods allow consumers to pull all ticket clear codes or filter by clear code ID and/or appointment/schedule ID.

Methods

URL base/Workforce/TicketClearCode/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to Ticket Clear Codes.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
    {
        "HttpAction": "Get",
        "MethodName": "GetTicketClearCode",
        "Description": "Returns the record for a single 'Ticket Clear Code' given the passed in ID value (see Path).",
        "Path": "/TicketClearCode/GetTicketClearCode/25032"
    },
    {
        "HttpAction": "Get",
        "MethodName": "GetTicketClearCodes",
        "Description": "Returns all 'Ticket Clear Codes' in the database (see Path).",
        "Path": "/TicketClearCode/GetTicketClearCodes"
    },
    {
        "HttpAction": "Get",
        "MethodName": "GetTicketClearCodesByAppointment",
        "Description": "Returns all 'Ticket Clear Codes' that are associated with a single appointment (see Path).",
        "Path": "/TicketClearCode/GetTicketClearCodesByAppointment/25032"
    }
]
URL base/Workforce/TicketClearCode/GetTicketClearCode/ID
Action GET
Description Returns a Ticket Clear Code object when given an ID of a valid clear code in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of an Element in the M4 database.
Returns A JSON Ticket Clear Code data object
Sample Return Object 
{ 
    "ID": 1, 
    "TicketClearCodeType": 1, 
    "Description": "Trouble Ticket Clear Code" 
}
URL base/Workforce/TicketClearCode/GetTicketClearCodes
Action GET
Description Returns a list of Ticket Clear Code objects in the M4 database.
Parameters None
Returns A list of JSON Ticket Clear Code data objects.
Sample Return Object 
[
    {
        "ID": 1,
        "TicketClearCodeType": 1,
        "Description": "Trouble Ticket Clear Code"
    },
    {
        "ID": 2,
        "TicketClearCodeType": 2,
        "Description": "Service Order Clear Code"
    },
    {
        "ID": 3,
        "TicketClearCodeType": 3,
        "Description": "Locates Ticket Clear Code"
    }
]
URL base/Workforce/TicketClearCode/GetTicketClearCodesByAppointment/ ID
Action GET
Description Returns a collection of Ticket Clear Code objects when given the ID of a valid appointment/schedule in the M4 database.
Parameters
Name Required? Type Description
ID Yes Integer An integer value representing the ID of an appointment/schedule in the M4 database.
Returns A collection of JSON Ticket Clear Code data object
Sample Return Object 
[
    {
        "ID": 1,
        "TicketClearCodeType": 1,
        "Description": "Trouble Ticket Clear Code"
    },
    {
        "ID": 2,
        "TicketClearCodeType": 2,
        "Description": "Service Order Clear Code"
    },
    {
        "ID": 3,
        "TicketClearCodeType": 3,
        "Description": "Locates Ticket Clear Code"
    }
]
Business Rules
Any violations of these business rules result in an appropriate error message being returned to the API consumer.

ID:
  • The ID must link to a valid appointment in the database.
  • The appointment/schedule must be linked to a valid ticket.

Was this article helpful?

Yes No

Related Articles