Skip to content

Get Specific Ticket Details

Sayar Samanta edited this page Aug 28, 2018 · 2 revisions

Description : To fetch one particular ticket related details.

  1. URL : api/v1/helpdesk/ticket

Parameters :

Name Data Type Required/Optional Description
token String Required token generated for a user
api_key String Optional An alphanumeric code that can be used to authenticate your API calls
`id String Required Id of the ticket

HTTP Method : GET

Response Format : JSON

Response : Give all the ticket specific details .In case of any errors, an error message will be returned.

URL Request Example : http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/ticket?api_key=9p41T2XFZ34YRZJUNQAdmM7iV0Rr1CjN&ip=null&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTcxNTksImV4cCI6MTUzNTAxNzM5OSwibmJmIjoxNTM1MDE3MTU5LCJqdGkiOiJnYVNwaElVSXVtR3EyNXlTIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.vsvL-qbQ3IwtOKY_Lj2xhNDwY6CiyeSW6WK_iiDYzK0&ticket_id=114

JSON Response Example :

Success Response :

{
    "result": {
        "dept_id": 1,
        "email": "user@gmail.com",
        "user_name": "user@gmail.com",
        "first_name": "demo",
        "last_name": "user",
        "id": 114,
        "ticket_number": "AAAA-0000-0113",
        "user_id": 47,
        "priority_id": 1,
        "priority_name": "Low",
        "dept_name": "Support",
        "status_name": "Open",
        "sla_name": "Sla 1",
        "source_name": "Agent",
        "sla": 1,
        "status": 1,
        "lock_by": 0,
        "lock_at": null,
        "source": 3,
        "isoverdue": 0,
        "reopened": 0,
        "isanswered": 0,
        "is_deleted": 0,
        "closed": 0,
        "reopened_at": null,
        "duedate": "2018-08-23 13:32:01",
        "closed_at": null,
        "created_at": "2018-08-23 07:32:01",
        "updated_at": "2018-08-23 07:32:01",
        "priority_color": "#00a65a",
        "helptopic_id": 1,
        "helptopic_name": "Support query",
        "title": "test ticket",
        "assignee": null
    }
}




Some Common Error :

Error Response : If the token is expired

{
“error":"Token has expired"
}

If the token is not provided

 {
  "error": "token_not_provided"
}

If the ticket id is not provided

{
    "result": {
        "ticketid": [
            "The ticketid field is required."
        ]
    }
}

Response Description :

Parameter Description
dept_id id of the department
email email of the user
user_name user name of the user
first_name first name of the user
last_name last name of the user
id id of the user
ticket_number ticket number
priority_id id of the priority
priority_name name of the priority
dept_name name of the department
status_name name of the status
sla_name name of the sla
source_name name of the source
sla id of the sla
status id of the status
source id of the source
isoverdue if the ticket is overdue or not
reopened if the ticket is reopened or not
isanswered if the ticket is answered or not
is_deleted if the ticket is deleted or not
closed if the ticket is closed or not
reopened_at ticket re opened time
duedate ticket due date time
closed_at ticket closing time
created_at ticket creation time
updated_at ticket last updated time
priority_color priority color
helptopic_id id of the help topic
helptopic_name name of the helptopic
title ticket title
assignee name of the assignee

Installation and Upgrade Guide

Administrator's Guide

Agent's Guide

Email Integration

Release & Upgrade Notes

Known Issues

Contribute & Feedback

Knowledge Base

Third Party Integration

Plugins

API

Clone this wiki locally