Page tree


Knowledge Base


Feedback

Have a suggestion for the Armor Knowledge Base?

Send a message to
kb@armor.com.









This API call applies to both Armor Complete and Armor Anywhere users.

The Get Ticket Entries API displays details for support ticket associated with your account, including support tickets where you are included as a recipient.  

Sample Request

GET https://api.armor.com/tickets/entries?searchText=&filterStatus=&filterStarred=&filterType=&sortField=dateModified&sortDirection=desc&pageSize=50&pageNumber=1

Input


The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/tickets/entriesGET


The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample

searchText

Query string to filter text server sideStringOptional

filterStatus

Query string to filter status server sideStringOptional

filterStarred

Query string to filter starred server sideStringOptional

filterType

Query string to filter type server sideStringOptional

sortField

Query string to sort by field server sideStringOptionaldateModified

sortDirection

The order of tickets, either descending or ascendingStringOptionaldesc

pageSize

Max of results per queryStringRequired50

pageNumber

Along with pageSize, this parameter determines the oination parameter combined with pageSize will allow for paging results.StringRequired1

To use multiple, optional parameters in one request, you must use the ampersand symbol ( & ) to connect each parameter together.

Sample Return

StatusResponse
200
  {
         "total": 1,
         "ticketsList": [{
               "ticketNumber": 1475,
               "title": "Ticket",
               "type": "ticket",
               "status": "Open",
               "isClosed": false,
               "priority": 0,
               "sensitivity": null,
               "dateCreated": "2015-01-06T22:33:27.4",
               "dateModified": "2015-01-06T22:33:27.4",
               "createdByUserId": 0,
               "lastResponderName": "Jason Smith",
               "lastResponderExcerpt": "Please review VM",
               "lastResponseDate": null,
               "starred": false,
               "read": true,
               "userRating": 0
         }]
  }
400
{
 "Message": "The request is invalid."
}
500
{"ErrorCode":"unhandled_exception","Message":"An unhandled exception has occurred.","Detail":{"Information":"The request has been logged and submitted to our internal operations support team."},"ReferenceId":"fdfc3497-309f-4f30-998e-f97e7bcd7a4e"}