This v1 API  will be deprecated from 15th March 2020

Description:

Fetch the metadata about our application such as priority, help-topics, agent names, statuses.

URL: api/v1/helpdesk/dependency

          (Replace this URL with you helpdesk URL)

Parameters:

Name Data Type Required / Optional Description
api_key String Optional An alphanumeric code that can be used to authenticate your API calls
token String Required Token generated for a user

HTTP Method: GET         

  •   URL Request Example:

https://www.stablehelpdesk.faveodemo.com/api/v1/helpdesk/dependency?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9wcm9kdWN0ZGVtb3VybC5jb20vc2FyZnJhei9wdWJsaWMvYXBpL3YxL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTUzNDc1OTg5MiwiZXhwIjoxNTM0NzYwMTMyLCJuYmYiOjE1MzQ3NTk4OTIsImp0aSI6IlhBdzNrNGhwZXNUVWNFeVQifQ.TpuZ6Vwo9oMlt_LKRZYv2cU5UY8YBKqe06-66ioZA24

Response

  •   Response Format: JSON
  •   Returns JSON which contains below response

Sample JSON Success Response :

{

   "success": true,

   "data": {

       "departments": [

           {

               "name": "Support",

               "id": 1

           },

           {

               "name": "Sales",

               "id": 2

           },

           {

               "name": "Operation",

               "id": 3

           }

       ],

       "sla": [

           {

               "name": "Low",

               "id": 1

           },

           {

               "name": "Normal",

               "id": 2

           },

           {

               "name": "High",

               "id": 3

           },

           {

               "name": "Emergency",

               "id": 4

           }

       ],

       "staffs": [

           {

               "email": "saifu@gmail.com",

               "id": 1,

               "first_name": "Saifu",

               "last_name": "QA",

               "user_name": "demoadmin"

           },

           {

               "email": "arindam.jana@gmail.com",

               "id": 4,

               "first_name": "Arindam",

               "last_name": "Jana",

               "user_name": "arindam.jana@gmail.com"

           },

           {

               "email": "sarfraz.khan@gmail.com",

               "id": 5,

               "first_name": "Sarfraz",

               "last_name": "Khan",

               "user_name": "sarfraz.khan@gmail.com"

           },

           {

               "email": "mallikarjun.h@ladybirdweb.com",

               "id": 6,

               "first_name": "Mallikarjun",

               "last_name": "H",

               "user_name": "mallikarjun.h@ladybirdweb.com"

           },

           {

               "email": "abhi.patak@gmail.com",

               "id": 8,

               "first_name": "Abhishekh",

               "last_name": "Pathak",

               "user_name": "abhi.patak@gmail.com"

           },

           {

               "email": "kada.bindu@gmail.com",

               "id": 9,

               "first_name": "Bindu",

               "last_name": "Kada",

               "user_name": "kada.bindu@gmail.com"

           },

           {

               "email": "hari.prasad@gmail.com",

               "id": 11,

               "first_name": "Hari",

               "last_name": "Prasad",

               "user_name": "hari.prasad@gmail.com"

           },

           {

               "email": "manish.tiwari@gmail.com",

               "id": 12,

               "first_name": "Manish",

               "last_name": "Tiwari",

               "user_name": "manish.tiwari@gmail.com"

           },

           {

               "email": "abhilash.jade@gmail.com",

               "id": 14,

               "first_name": "Abhilash",

               "last_name": "P",

               "user_name": "abhilash.jade@gmail.com"

           }

       ],

       "teams": [

           {

               "name": "Level 1 Support",

               "id": 1

           },

           {

               "name": "Level 2 Support",

               "id": 2

           },

           {

               "name": "Developer",

               "id": 3

           }

       ],

       "priorities": [

           {

               "priority": "Low",

               "priority_id": 1

           },

           {

               "priority": "Normal",

               "priority_id": 2

           },

           {

               "priority": "High",

               "priority_id": 3

           },

           {

               "priority": "Emergency",

               "priority_id": 4

           }

       ],

       "helptopics": [

           {

               "topic": "Support query",

               "id": 1

           }

       ],

       "status": [

           {

               "name": "Open",

               "id": 1

           },

           {

               "name": "Resolved",

               "id": 2

           },

           {

               "name": "Closed",

               "id": 3

           },

           {

               "name": "Deleted",

               "id": 4

           },

           {

               "name": "Request for close",

               "id": 5

           },

           {

               "name": "Spam",

               "id": 6

           },

           {

               "name": "Unapproved",

               "id": 7

           }

       ],

       "sources": [

           {

               "name": "Web",

               "id": 1

           },

           {

               "name": "Email",

               "id": 2

           },

           {

               "name": "Agent",

               "id": 3

           },

           {

               "name": "Facebook",

               "id": 4

           },

           {

               "name": "Twitter",

               "id": 5

           },

           {

               "name": "Call",

               "id": 6

           },

           {

               "name": "Chat",

               "id": 7

           }

       ],

       "tickets_count": [

           {

               "name": "Open",

               "count": 12

           },

           {

               "name": "Closed",

               "count": 5

           },

           {

               "name": "Deleted",

               "count": 15

           },

           {

               "name": "unassigned",

               "count": 1

           },

           {

               "name": "mytickets",

               "count": 4

           }

       ],

       "type": [

           {

               "name": "Question",

               "id": 1

           }

       ],

       "helpdesk": []

   }

}

Response Description: In this API we will get all the metadata about the faveo like the help topics, assignees, priority name, list of all statuses, sources and ticket types. We will get the name and the corresponding id.

It returns data JSON which contains following data array.

departments: It contains a list of all department names in helpdesk with their id’s.

Parameter Description
name Name of the department
id Id of the department

sla:  It contains all list of SLA names in helpdesk with their id’s.

Parameter Description
name Name of the SLA
id Id of the SLA

staffs:  It contains all list of agent names in helpdesk with their id’s.

Parameter Description
email Email of the Agent
id Id of the agent
first_name First name of the agent
last_name Last name of the agent
user_name Username of the agent

priorities:  It contains all list of ticket priority names in helpdesk with their id’s.

Parameter Description
priority Name of the priority
priority_id Id of the priority

status:  It contains all list of ticket status in helpdesk with their id’s.

Parameter Description
name Name of the ticket status
id Id of the ticket status

sources:  It contains all list of ticket sources in helpdesk with their id’s.

Parameter Description
name Name of the ticket source
id Id of the ticket source

tickets_count:  It contains all list of ticket counts in helpdesk with their count number.

Parameter Description
name Name of the ticket status
count Count of  the ticket status

type:  It contains all list of ticket type in helpdesk with their id number.

Parameter Description
name Name of the ticket type
id Id of  the ticket status

Possible Errors/Failures:

 *Please check the responses for some common errors

Leave a Reply

Your email address will not be published. Required fields are marked *