Page tree


In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




Overview

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

The Rate a Ticket API adds a numeric rating to a support ticket. 

You can use the Get Ticket Meta-Data API to find the ticket number (ticketNumber).

Sample request

POST https://api.armor.com/tickets/271/rate
{
  star: 3
}

Input

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

API Call / URLMethod / Type
tickets/{ticketNumber}/ratePOST

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

ParameterDescriptionFormatRequired or optionalExample
ticketNumber

The number of the ticket

IntegerRequired271
starRating for the ticket, from 1 to 5.IntegerRequired3

Sample return

StatusResponse
200
{
      "tags": [],
      "comments": [{
            "id": "e06555ce-8489-4aad-8cda-b71511b9b38e",
            "text": "Please check VM",
            "commentorId": "f9153914-9e29-42f0-9101-9b31fa4df6eb",
            "commentorName": "Robert Smith",
            "commentorEmail": "robert.smith@gmail.com",
            "date": "2015-01-06T23:51:45.05",
            "isPublic": true,
            "attachments": [],
            "feedback": 0,
            "reason": 0,
            "read": false
      },
      {
            "id": "7c07dac5-de64-49f9-b2d9-23bc269aa5ab",
            "text": "Review VM",
            "commentorId": "f9153914-9e29-42f0-9101-9b31fa4df6eb",
            "commentorName": "Addison Smith",
            "commentorEmail": "addison.smith@armor.com",
            "date": "2015-01-06T23:44:03.237",
            "isPublic": true,
            "attachments": [],
            "feedback": 0,
            "reason": 0,
            "read": false
      }],
      "recipients": [{
            "id": 2369,
            "firstName": "Robert",
            "lastName": "Smith",
            "emailAddress": "robert.smith@gmail.com",
            "account": false,
            "billing": false,
            "technical": false,
            "partner": false
      }],
      "relatedServers": [],
      "relatedTickets": [],
      "ticketNumber": 1476,
      "title": "VM Ticket",
      "type": "ticket",
      "status": "Resolved",
      "isClosed": false,
      "priority": 0,
      "sensitivity": null,
      "dateCreated": "2015-01-06T23:44:03.153",
      "dateModified": "2015-01-07T00:07:28.96",
      "createdByUserId": 2369,
      "lastResponderName": "Robert Smith",
      "lastResponderExcerpt": "Review Vm",
      "lastResponseDate": "2015-01-06T23:51:45.05",
      "starred": false,
      "read": false,
      "userRating": 3
}
400
Bad Request
{
 "error": true,
 "message": "An internal server error occurred."
}