A PHP Error was encountered

Severity: Notice

Message: Undefined index: HTTP_ACCEPT_LANGUAGE

Filename: core/MY_Controller.php

Line Number: 258

Backtrace:

File: /home/lourenss/www/pingen_www/application/core/MY_Controller.php
Line: 258
Function: _error_handler

File: /home/lourenss/www/pingen_www/application/core/MY_Controller.php
Line: 54
Function: get_browser_language

File: /home/lourenss/www/pingen_www/application/controllers/Api.php
Line: 7
Function: __construct

File: /home/lourenss/www/pingen_www/index.php
Line: 316
Function: require_once

Pingen | Send Letters Online for Private, Business and Software Developers

You can list your queue with the following URL.

                    GET https://api.pingen.com/queue/list/
                

URL Parameters

NameTypeRequiredDefaultOptionsNotes
limitintno0Limit the amount of results
pageintno1When limiting the results, specifies page
sortstringnodatedateSorts the list by the available values
sorttypestringnodescasc
desc
Defines the way of sorting


Example: Making a request with 100 Results, getting second page, and sorting by date ascending

                    GET https://api.pingen.com/queue/list/limit/100/page/2/sort/date/sorttype/asc/
                

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.
pageintCurrent page that was passed in on the request
pagesintTotal number of pages available
countintTotal number of objects available
itemscollectionCollection of Queue Objects

Example response:

    {
        "error":false,
        "page":1,
        "pages":1,
        "count":2,
        "items":[
            {
                "id": 1,
                "filename":"My_document.pdf",
                "date": "2012-08-10 18:32:00",
                "user_id":35,
                "send": 1,
                "speed": 1,
                "color": 1,
                "rightaddress":0,
                "status": 100,
            },
            {
                "id": 2,
                "filename":"My_document.pdf",
                "date": "2012-08-10 18:32:00",
                "user_id":35,
                "send": 1,
                "speed": 1,
                "color": 1,
                "rightaddress":0,
                "status": 100,
            }
        ]
    }
    

You can get your queue object with the following URL:

                    GET https://api.pingen.com/queue/get/
                

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the queue entry


Example: Making a request for letter with id 5

                    GET https://api.pingen.com/queue/get/id/5
                

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.
itemobjectObject of Queue

Example response:

    {
        "error":false,
        "item":{
            "id": 1,
            "filename":"My_document.pdf",
            "date": "2012-08-10 18:32:00",
            "user_id":35,
            "send": 1,
            "speed": 1,
            "color": 1,
            "rightaddress":0,
            "status": 100,
        }
    }
    

You can cancel a pending queue entry with the following URL:

                    POST https://api.pingen.com/queue/cancel/
                

Request Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the queue entry

Body Parameters

NameTypeRequiredDefaultOptionsNotes
reasonstringnoReason for cancelling


Example: Cancelling a queue entry with id 5

                    POST https://api.pingen.com/queue/cancel/id/5
                

Example content of data variable
    {
        "reason":"Documents had wrong content"
    }
    

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.

Example response:

    {
        "error":false
    }