Output Devices

Use these endpoints to perform configuration steps on a location's output devices.

For additional information, review the Output Devices page.

Get an Output Device

Request

Endpoint: /api/get/device/CompID/LocID/DevID

Parameters: none

Response

A JSON object with these fields:

•DevID

•Name

•IsInactive - true|false

•Type - 0=printer, 1=file, 2=command, 3=viewer, 4=network printer

•Target - printer name, path specification, ip/hostname or UNC path

•Notes

•Formats - string array of supported format names (pdf, pcl, pcl6, ps, txt, any)

•DefaultProps - object keyed by property names

•Filter - server command line to process jobs with before sending output

•AutoGenerated - true|false indicates if device record was generated automatically

or

Error: message

Put an Output Device

Request

Endpoint: /api/put/device/CompID/LocID/DevID

Parameters:

•Name

•IsInactive - 0=false, 1=true

•Type - 0=printer, 1=file, 2=command, 3=viewer, 4=network printer

•Target - printer name, path specification, ip/hostname or UNC path

•Notes

•Formats - string array of supported format names (pdf, pcl, pcl6, ps, txt, any) for types 0 and 4, separated by semicolons

•DefaultProps - semicolon-delimited list of name=value pairs (see notes)

•Filter - server command line to process jobs before sending output

Notes:

Default Properties can include values for:

•color - 1=monochrome, 2=color

•copies 1-99

•collate 1=collate copies

•duplex 1=simplex, 2=vertical, 3=horizontal

•orientation 1=portrait, 2=landscape

•priority 1-99

•scale 0=fit, 1=shrink to fit, 2=actual size

•tray - set to name of known tray as reported by the system client in Location Printers field

•size=value, set to a value supported by the driver and reported by the system client

•custsize - to set overriding options for paper size, and for Linux, other media selections

•bmp - set to 300 or 600 to turn on Windows bitmap printing of PDF files

•Other names can be used for file path or command line substitution parameters

Filters use tags %i for the input file, %o for the output file to be delivered, and %e for an error message file

Type of 3 (viewer) is not currently supported by the system client.

Response

A JSON object representing the new record, or Error: message.

Delete an Output Device

Request

Endpoint: /api/delete/device/CompID/LocID/DevID

Parameters: none

Response

An empty response or Error: message

List Output Devices

Request

EndPoint: /api/list/devices/CompID

EndPoint: /api/list/devices/CompID/LocID

Parameters:

•csv|tsv - override response format to one of these, set to any value or simply present

Response

A JSON object containing objects for each output device in the location, or for devices at all locations if no LocID segment is provided.  When listing for all locations, the keys in the JSON object are in the format "locid:devid".  If a LocID segment is provided, keys are "devid".

or

A comma-separated-values or tab-separated-values list if csv or tsv parameters are supplied.

or

Error: message