GET frame-type

A lookup call to get all available frame types, including their ID and description. The call will allow a single ID to be given in order to return the description.

When accessed via a GET request this API method will return a list of all frame types.

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 string (optional) a frame type code to restrict results to

OUTPUT - JSON sample

If accessing GET /api/frame-type?id=4 the following JSON would be returned:

{
    "data": [{
        "id": 4,
        "description": "Digital (moving image)",
        "on_route": true
    }]
}
        

A "data" element that contains an array of frame types defined as follows:

id - string - the unique identifier used within Code Allocator to reference the frame type

description - string - a description of the frame type suitable for display to a user

on_route - boolean - true if the frame type is on route or false if not