Managing TCP/IP printer objects via URL API

Managing TCP/IP printer objects via URL

New to Printer Installer version 13.2 is the ability to manage direct IP printers by browsing to specific URLs. You can view, add, update, and delete printers in this way.

Viewing a Printer

Going to this URL will open the Administrator at the specified printer. Syntax: printers.domain.com/admin/?viewdirectip=1&printername=example1&folder=Location1,MyCompany
  • printername - The name of the printer to view.
  • folder - Optional. The folder the printer is in. If this parameter is omitted the entire tree will be searched for the matching printer.
If the printer could not be found, or multiple printers match printername, an error will be shown and the root node will be selected.

Adding a Printer

Going to this URL will open a dialog window to add a new printer. Note: This will never update an existing printer. If a printername is entered that is the same as an existing printer, a new printer with that name will be created. Syntax: printers.domain.com/admin/?adddirectip=1&printername=example1&folder=Location1,MyCompany& hostaddress=192.168.1.99&location=CopyRoom&comment=Copier&iscolor=1
  • printername - Optional. The name of the printer to be created.
  • folder - Optional. The folder the new printer should be placed in. If this parameter is omitted the user will need to choose a folder in the dialog window.
  • hostaddress - Optional. The IP address of the TCP/IP port of the printer to be created.
  • location - Optional. The text to put in the printer's Location field.
  • comment - Optional. The text to put in the printer's Comment field.
  • iscolor - Optional. Flags the printer as color. 1 for true, 0 for false.

Updating a Printer

Going to this URL will open a dialog window to update a printer. Syntax: printers.domain.com/admin/?updatedirectip=1&printername=example1&folder=Location1,MyCompany& hostaddress=192.168.1.99&location=CopyRoom&comment=Copier&iscolor=1
  • printername - The name of the printer to be updated.
  • folder - Optional. The folder the printer is in. If this parameter is omitted the entire tree will be searched for the matching printer.
  • hostaddress - Optional. The IP address of the TCP/IP port of the printer to be created.
  • location - Optional. The text to put in the printer's Location field.
  • comment - Optional. The text to put in the printer's Comment field.
  • iscolor - Optional. Flags the printer as color. 1 for true, 0 for false.
  • new_folder - Optional. The folder to move the printer to.
  • new_printername - Optional. The new name for the printer.
If the printer could not be found, or multiple printers match printername, an error will be shown. Note: Any missing parameter means to not change the current value. For example, putting "comment=" in the url would clear the field, but leaving "comment=" out of the url entirely would mean no change will be made)

Deleting a Printer

Going to this URL will open a dialog prompt to delete a printer. Syntax: printers.domain.com/admin/?deletedirectip=1&printername=example1&folder=Location1,MyCompany
  • printername - The name of the printer to delete.
  • folder - Optional. The folder the printer is in. If this parameter is omitted the entire tree will be searched for the matching printer.
If the printer could not be found, or multiple printers match printername, an error will be shown and the root node will be selected.

URL Encoding Information

  • All URL parameters are case sensitive; all parameter names are expected to be lowercase.
  • Folder parameter: Any folder passed in a URL is expected to be comma-delimited, with the path proceeding from most specific to least specific. For example, to encode a folder called MyCompany/US/NY/HQ/Floor1 the parameter would be "folder=,Floor1,HQ,NY,US,MyCompany,". The leading and trailing commas are optional. The root node is also optional. If a comma is needed as part of a folder name it must be entered as ,. For example, a folder named "London,England" would be entered as "London,England".
  • All non-alphanumeric characters must be escaped as follows:
 
Character Escape Character
space %20
< %3C
> %3E
# %23
% %25
{ %7B
} %7D
| %7C
\ %5C
^ %5E
~ %7E
[ %5B
] %5D
` %60
; %3B
/ %2F
? %3F
: %3A
@ %40
= %3D
& %26
$ %24