Locations/Users

Use these endpoints to perform configuration steps on a company's locations and browser client users.

For additional information, review the Locations/Users page.

Get a Location or Browser User

Request

Endpoint: /api/get/location/CompID/LocID

Parameters: none

Response

A JSON object with these fields:

•LocID

•Name

•Password

•IsInactive - true|false

•Type - 0=system location, 1=browser user

•AllowFrom - array of strings

•Email

•Email2

•Phone

•Printers - array of strings, as reported by client (see notes)

•Devices - object of output device records keyed by device id, as configured for the location

•IsWindows - true|false, as reported by  client

•Notes

•MFA - true|false

•EmailVerified - true|false

•Email2Verified - true|false

or

Error: message

Notes:

The Printers array contains tab-separated strings describing the printers at the remote location.  The information is supplied by the system client when it connects to the server.  The information in each line depends on the operating system.

Windows:

•Printer name

•Driver name + Port name

•Tray list, semicolon-delimited

•Color support (0=no, 1=yes)

•Collation support (0=no, 1=yes)

•Duplex support (0=no, 1=yes)

•Paper sizes

Linux:

•Printer name

•n/a

•Tray list, semicolon-delimited, hardcoded to standard CUPS media options

•n/a

•n/a

•n/a

•Paper sizes, set to Letter,Legal, A4 to accommodate most printers

Put a Location or Browser User

Request

Endpoint: /api/put/location/CompID/LocID

Parameters:

•Name

•Password

•IsInactive - 0=false, 1=true

•Type - 0=system location, 1=browser user

•AllowFrom - semicolon-delimited list

•Email

•Email2

•Phone

•Notes

•MFA - 0=false, 1=true, if 1 requires at least one email, valid for browser user locations

Notes:

Printers, Devices, and IsWindows fields as returned by the Get endpoint are considered read-only and are ignored.  Only fields you wish to change are required.

Response

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

Delete a Location or Browser User

Request

Endpoint: /api/delete/location/CompID/LocID

Parameters: none

Response

An empty response or Error: message

List Locations and Browser Users

Request

EndPoint: /api/list/locations/CompID

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 location in the company

or

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

or

Error: message