Qodex.ai

6.2 Device info

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

Retrieves details about the device.

Response

Objects with basic information about the device specified by the GUID. Returning the user given name, id, driver (thus make and model), profile group, connection URI, supported sizes and much more.

  • Name (string) : User defined name, can be changed by the user without changing the underlying GUID or driver.
  • NetworkName (string) : Name to be presented to the user in the application, it is a combination of the Name and “@Host” to identify the RIP it is connected to. When multiple entries with the same Name exist in the network use the NetworkName instead of Name to differentiate them for the user.
  • Driver (string) : Name of the driver used, hard linked to the GUID. A change of driver will also generate a new GUID. The driver defines the make and model of the device.
  • Group (string) : The Profile Group identifies the group of drivers this driver belongs to and with which profiles can be shared.
  • InkType (string, optional) : The ink type used by the printer, empty when it is not a printer.
  • Connection (string) : The URI identifying the connection to the device. Common types are: tcp, file, usb, room
  • ROOM (bool, optional) : True when the connection is not to the printer directly but using PrintStation as DFE in between. In such a case the META2 job is passed to PrintStation for printing. PrintStation is then reporting the status of the device directly to the cloud.
  • Width (number) : Maximum width of the device including margins expressed in PF-units (1/18th of an inch).
  • Height (number) : Maximum height or length of the material supported by the device including margins expressed in PF-units (1/18th of an inch).
  • Print (bool) : True when the device can print
  • Cut (bool) : True when the device can cut contours.
  • DTG (bool, optional) : True when the device is a DTG printer.
  • Flatbed (bool, optional) : True when the device is a flatbed device, only consistently filled for cutting devices.
  • DoubleSided (bool, optional) : True when the device is equipped with an automatic duplexing device so double-sided jobs can be sent as 1 job (ref AB jobs).
  • Console (bool, optional) : This device has a DFE and jobs will first appear there and require a printer operator to print the job.
  • CutMediaDB (bool, optional) : This device is a cutter with a dynamically provided cutter media list, which is reported as virtual queues in the Queues call.
  • DeviceStatus (bool, optional) : This device supports feedback on device status. This might include loaded media size and type and ink levels.
  • ServiceUI (bool, optional) : This device provides a built-in HTML5 user-interface that can be presented inside the RIP or PrintStation.
  • Registration (integer, optional) : Bit-flag indicating which types of registrations marks are supported by this device. Currently supported flags are:
    • Camera marks : (1 << 28)
    • Fotoba : (1 << 8)
    • Graphtec : (1 << 18)
    • HP cutter : (1 << 7)
    • Mimaki : (1 << 13)
    • Mimaki v0 : (1 << 24)
    • Mimaki v2 : (1 << 22)
    • Mimaki v3 : (1 << 27)
    • Mutoh EPOS : (1 << 6)
    • Roland GX : (1 << 26)
    • Roland RPOS : (1 << 12)
    • Summa OPOS : (1 << 5)
  • MarkerGUID (string, optional) : Filled when bit-flag “Camera marks” is set in Registration. This specifies the resource GUID (see 7. Resources) of the marker definition XML to be used as default for this device.
  • Trays (array) : Array of objects for each destination trays of the device. Each tray is an object containing:
    • 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