6.9 Loaded media

GET http://{{rip_ip}}:5438/devices/{{device_id}}/loadedmedia

Retrieves the currently loaded media size, media type and empty state on each tray. If the device has built- in methods for measuring the loaded media size it will be queried if the device is on-line when the /query is appended.

Response

  • Name (string) : Name of the mediasource
  • Empty (bool, optional) : true when the mediasource is empty, default false
  • Default (bool, optional) : true when this mediasource is set as the default output target.
  • MediaType (string, optional) : Name of the currently loaded media type. When not available it is unknown or absent.
  • 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.

Errors

  • 404 Not Found : {"Message":"Device not found"}