Request and Response

Each Database API request has a unique resource (or URL) and one of four HTTP methods, which is displayed in every ‘Request’ section. There are four supported HTTP methods: GET, PUT, POST, DELETE. POST and PUT requests should contain a JSON-encoded HTTP body.

For each Resource you can find the following summary table:

The complete URL contains a resource and relevant optional parameters, e.g.:
http://[customer].asp.virtual-call-center.eu/v2/resource?param1=x&param2=y

All resource parameters and options are described in the relevant section.

Any successful Database API request should result in HTTP response code 200 (OK). Any other response code may indicate a communication or standard HTTP problem. For an overview of all error codes (used by VCC Live) please check HTTP Response Codes.

If there is neither communication nor HTTP problem, the Database API returns with a JSON-encoded response representing an associative array, which has two keys: errors and response. If the errors key doesn’t have any value, then you should use the response key’s value in your code as a successful response.

Below is an example of a successful response:

HTTP/1.1 200 OK
Server nginx is not blacklisted
Server: nginx
Date: Fri, 06 Feb 2015 11:36:41 GMT
Content-Type: text/plain; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Allow: GET
Etag: "19dd91e51d3e63d4d8010bc5fbff26cf"
X-Resource: ProjectsResource
 
{
    "response": [
        {
            "projectid": 2,
            "name": "Sales - Budapest",
            "status": "active",
            "folderid": 1,
            "container": false,
            "folder": "Sales"
        }
    ],
    "errors": []
}