Sorting Lst output

Specify column used for sorting

Description: Order the output by one of the columns in the output, instead of simply returning the data in the order coming from the database table.

Application: even though a client application might be perfectly capable of receiving all of the output and then applying the sort order internally, in some cases it makes sense to let the database server take care of ordering the output.

Implementation: URL/{category}/lst/?sort={column_name}

Default: if ‘?sort=’ is used, the output is returned by default in ascending order. See below for descending order.

Example:

For example, to sort the output of the list of known agencies by the agency ID:

Method: 
    GET http://api.example.com/agc/lst?sort=agencyId

Descending order

Description: If the output is sorted by one of the columns, an optional query parameter ‘desc’ can be used to specify that the sort order should be descending. Omitting the ‘desc’ parameter or specifying ‘desc=0’ (zero) will cause the output to be in ascending order.

Implementation: URL/{category}/lst/?sort={column_name}&desc=1

Example:

For example, to sort the output of known agencies by the agency ID, in descending order:

Method: 
    GET http://api.example.com/agc/lst?sort=agencyId&desc=1

Limit number of rows

Description: Instead of returning all available rows, an optional query parameter ‘limit’ can be used to return a specific number of rows.

Application: One application of the ‘limit’ parameter, in combination with the sort={} and desc=1 parameters, is to retrieve only the most recently created item of the category.

Implementation: URL/{category}/lst/?sort={column_name}&limit=1

Example:

For example, to retrieve only the most recently created agency:

Method: 
    GET http://api.example.com/agc/lst?sort=agencyId&desc=1&limit=1