Qodex.ai

9.7 Get Device Loaded Media Size

GET https://{{domain}}/api/v2/device/{{DeviceGUID}}/loadedmedia

Retrieves the currently loaded media size on each tray.

Request

Query string parameters:

  • DeviceGUID (guid, required)

Response

JSON object

  • MediaSize (object) : Media size of the currently loaded media.
    • Name (string) : Name of the media size.
    • Transverse (bool, optional) : True when the sheet is physically rotated in the device, compared to its definition.
    • Roll (bool) : True when it is a media size is a roll, else it is a cut sheet.
    • Width (number) : The width including margins expressed in PF-units (1/18th of an inch).
    • Height (number) : The height including margins expressed in PF-units (1/18th of an inch).
    • Margins (array, optional) : Array of numbers describing the non-printable margins in the order: Left, Right, Top, Bottom.
  • Tray (object) : Object describing the in which the media size is loaded:
    • Name (string) : The name of the tray
    • Roll (bool) : True when it is a roll tray else it is accepting cut sheet
    • Width (number) : Maximum width of the material supported by this tray including margins expressed in PF-units (1/18th of an inch).
    • Height (number) : Maximum height or length of the material supported by this tray including margins expressed in PF-units (1/18th of an inch).
    • Margins (array, optional) : Array of number describing the non-printable margins in the order: Left, Right, Top, Bottom

Ex:

200 OK :
{
    "MediaSize": {
        "Name": "Custom",
        "Roll": true,
        "Width": 305.999298095703125,
        "Height": 31181.103515625,
        "Margins": [ 2.12, 2.12, 2.12, 2.12 ]
    },
    "Tray": {
        "Name": "Roll",
        "Roll": true,
        "Width": 306,
        "Height": 31181.103515625,
        "Margins": [ 2.12, 2.12, 2.12, 2.12 ]
    } 
}

RESPONSES

status: OK

{"MediaSize":{"Height":141732.28125,"Name":"320 roll","Roll":true,"Width":2267.716552734375},"MediaSource":{"Height":141732.28125,"Name":"Roll","Roll":true,"Width":2267.716552734375}}