Common Parameters

Grid parameters

API calls which end in /grid, with the exception of epg/event/grid, have a common set of parameters:

• start First entry to include. Default is the first.
• limit Number of entries to include. Default is 50 - use a large number to get all.
• filter A JSON object describing the filter(s) to be applied. See Grid Filters below for syntax.
• sort Name of the field to sort the records by. A case-sensitive sort is used.
• dir if sort is specified then dir=desc produces a reverse sort.

Grid filters

A filter can be applied to the output using a JSON object. The syntax is:

filter=[
            {
                "field" : "<fieldname>"
                "type"  : "string|numeric|boolean"
                "value" : "<value>"
                "comparison" : "gt|lt|eq"
             }, ...
        ]

The "comparison" field is only used with numeric data; booleans must match exactly while for strings a regular expression match is used.

Load parameters

API calls which end in /load have a common set of parameters:

• meta If > 0 an extra data structure is output, mostly related to the format of the GUI screen where the information is presented. Default is 0.
• list Allows the output to be filtered. Not understood.