Skip to content

`PrintQueueList_Load_Query`#

Description#

This function is used to load a list of print queues.

Request Body Parameters#

Parameter	Type	Description
`count`	Number	Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
`filter`	String	A string for filtering returned data
`offset`	Number	Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
`sort`	String	The order for sorting returned data

Response Parameters#

Parameter	Type	Description
`total_count`	Number	Total number of records that matched your search criteria.
`start_offset`	Number	Used in conjunction with the Count parameter for paginating results of large datasets.
`id`	Number	Print Queue Id
`descrip`	String	This is the Print Queue Name/Description

Example Request#

{
    "Function": "PrintQueueList_Load_Query",
    "Count": 0,
    "Offset": 0,
    "Filter": []
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 3,
        "start_offset": 0,
        "data": [
            {
                "id": 1,
                "descrip": "Warehouse1"
            },
            {
                "id": 2,
                "descrip": "Warehouse2"
            },
            {
                "id": 3,
                "descrip": "Warehouse3"
            }
        ]
    }
}