GET format

A lookup call to get all available formats, including their ID and description. The call will allow a single ID to be given in order to limit results to the specific format.

When accessed via a GET request this API method will return a list of all available formats. The format is a SPACE standard.

INPUT

As this method is accessed via a GET request there is no HTTP body so options can be specified via the URL.

parameter type description
id int (optional) a format id to restrict results to

OUTPUT - JSON sample

If accessing GET /api/format?id=1 the following JSON would be returned:


{
    "data": [
        {
            "id": 1,
            "description": "12 Sheets",
            "width": 3.05,
            "height": 1.52,
            "surface_area": 4.64,
            "on_route": true
        }
    ]
}

A "data" element that contains an array of formats