PUT frame

Used to update a frame. Validation will ensure that the user calling this method not only has write permissions but has permission to edit the specific frame (i.e. belongs to the frame’s media owner).

This method is identical to POST /api/frame except that your input JSON must contain a FrameID element specifying the frame that you wish to update.

Each attribute type/value will be validated to ensure that the data is valid. See the section on errors for how errors are represented.

INPUT

As this method is accessed via a PUT request the raw body must be set to JSON as described below. Note that this is sample input for the Roadside environment type and as such the attributes sufficiently cover the required values.

[{
    "FrameID": 2000000000,
    "LocationDescription": "Some place",
    "SalesCode": "19A",
    "OnRoute": 1,
    "Format": {
        "SpaceFormatID": 1,
        "Width": 0.56,
        "Height": 0.24,
        "SurfaceArea": 0.13
    },
    "FrameType": 1,
    "Faces": 1,
    "Illumination": 1,
    "Environment": {
        "Type": "roadside",
        "Attributes": [{
                "Type": "Address",
                "Value": "address value"
            },
            {
                "Type": "PostCode",
                "Value": "SM12EA"
            },
            {
                "Type": "WorldGeodeticCoordinate",
                "Value": "49.76680500,-7.49999999"
            }
        ]
    }
}]
        

The table below details the fields used in this example.

parameter type description
FrameID int (required) the frame identifier representing the frame to update

FrameID is the only extra input to this method and you'll find definitions for the rest within POST /api/frame

OUTPUT

If accessing PUT /api/frame with the body set to the sample JSON above then the following JSON would be exactly the same as the output defined for GET /api/frame and POST /api/frame

PUT calls will contain two additional attributes present in the frame results.

  • FrameChanged boolean value indicating whether the frame was updated

  • NewFrameIDGenerated boolean value indicating whether a new frame identifier was issued