Skip to content

Dependency API

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

Description : To fetch meta data about FAVEO. It will give all the required meta data like help topic, sla, priorities, source, agents, statuses and departments.

  1. URL : api/v1/helpdesk/dependency

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

HTTP Method : GET

Response Format : JSON

Response : Give list of all meta data in FAVEO.In case of any errors, an error message will be returned.

URL Request Example : http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/dependency?api_key=9p41T2XFZ34YRZJUNQAdmM7iV0Rr1CjN&ip=null&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTY5MTMsImV4cCI6MTUzNTAxNzE1MywibmJmIjoxNTM1MDE2OTEzLCJqdGkiOiI3eURrVmZveWhkQlQxNmNBIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.mPeLz6HFP7EGi7hUXJA2OmWytIOPwCBVUmR_7aqggmQ

JSON Response Example :

Success Response :

 {
    "result": {
        "departments": [
            {
                "name": "Support",
                "id": 1
            },
            {
                "name": "Sales",
                "id": 2
            },
            {
                "name": "Operation",
                "id": 3
            }
        ],
        "sla": [
            {
                "name": "Sla 1",
                "id": 1,
                "sla_duration": "6 Hours"
            },
            {
                "name": "Sla 2",
                "id": 2,
                "sla_duration": "12 Hours"
            },
            {
                "name": "Sla 3",
                "id": 3,
                "sla_duration": "24 Hours"
            },
            {
                "name": "sla 4",
                "id": 4,
                "sla_duration": "36 Hours"
            },
            {
                "name": "sla 5",
                "id": 5,
                "sla_duration": "48 Hours"
            }
        ],
        "staffs": [
            {
                "email": "admiww@ladybirdweb.com",
                "id": 2
            },
            {
                "email": "ramesh@gmail.com",
                "id": 8
            },
            {
                "email": "guru@gmail.com",
                "id": 9
            },
            {
                "email": "saifu@gmail.com",
                "id": 35
            },
            {
                "email": "jully@gmail.com",
                "id": 38
            }
        ],
        "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
            },
            {
                "topic": "Sales query",
                "id": 2
            },
            {
                "topic": "Operational query",
                "id": 3
            }
        ],
        "status": [
            {
                "name": "Open",
                "id": 1
            },
            {
                "name": "Resolved",
                "id": 2
            },
            {
                "name": "Closed",
                "id": 3
            },
            {
                "name": "Archived",
                "id": 4
            },
            {
                "name": "Deleted",
                "id": 5
            },
            {
                "name": "Unverified",
                "id": 6
            },
            {
                "name": "New Status",
                "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": 52
            },
            {
                "name": "Closed",
                "count": 4
            },
            {
                "name": "Deleted",
                "count": 50
            },
            {
                "name": "unassigned",
                "count": 13
            },
            {
                "name": "mytickets",
                "count": 4
            }
        ]
    }
}



Some Common Error :

Error Response : If the token is expired

{
“error":"Token has expired"
}

If the token is not provided

 {
  "error": "token_not_provided"
}

Response Description :

Parameter Description
name name of the metadata
id id of the metadata

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