api.addNewUser

Triggers the process of adding a new user account defined by a given username. Assuming the user exists in the OS/Network/Domain user directory, the account will be created with the correct initial settings as defined by the rules set up in the admin interface under the Group's section. Calling this method is equivalent to triggering the "new user" event when a new user performs printing for the first time.

api.isUserExists

Test to see if a user exists in the system/database.

api.addNewUsers

Calling this method will start a specialized user and group synchronization process optimized for tracking down and adding any new users that exist in the OS/Network/Domain user directory and not in the system. Any existing user accounts will not be modified. A group synchronization will only be performed if new users are actually added to the system.

api.performGroupSync

Start the process of synchronizing the system's group membership with the OS/Network/Domain's group membership. The call to this method will start the synchronization process. The operation will commence and complete in the background.

api.performUserAndGroupSync

Start a full user and group synchronization. This is equivalent to pressing on the "Synchronize Now" button in the admin user interface. The behavior of the sync process, such as deleting old users, is determined by the current system settings as defined in the admin interface. A call to this method will commence the sync process and the operation will complete in the background.

api.performUserAndGroupSyncAdvanced

An advanced version of the user and group synchronization process providing control over the sync behavior. A call to this method will commence the sync process and the operation will complete in the background.

api.adjustUserAccountBalance

Adjust a user's account balance by an adjustment amount. An adjustment may be positive (add to the user's account) or negative (subtract from the account).

api.adjustUserAccountBalanceByGroup

Adjust the account balance for all users in a group by an adjustment amount. An adjustment may be positive (add to the user's account) or negative (subtract from the account).

api.setUserAccountBalance

Set the balance on a user's account to a set value. This is conducted as a transaction.

api.deleteExistingUser

Delete/remove an existing user from the user list. Use this method with care. Calling this will perminently delete the user account from the user list (print and transaction history records remain).

api.getUserAccountBalance

Get the user's current account balance.

api.getUserPrintStatsJobCount

Get the user's current printing statistics job count as an integer.

api.getUserPrintStatsPageCount

Get the user's current printing statistics page count as an integer.

api.disablePrintingForUser

Disable printing for a user for selected period of time.

api.enablePrintingForUser

Enable printing for a user with printing disabled.

api.setUserRestriction

Set a user's restriction status. (Restricted or Unrestricted)

api.addNewSharedAccount

Create a new shared account with the given name.

api.isSharedAccountExists

Test to see if a shared account exists in the system/database.

api.deleteExistingSharedAccount

Delete a shared account from the system. Use this method with care. Deleting a shared account will permanently delete it from the shared account list (print history records will remain).

api.getSharedAccountAccountBalance

The current account balance associated with a shared account.

api.adjustSharedAccountAccountBalance

Adjust a shared account's account balance by an adjustment amount. An adjustment may be positive (add to the account) or negative (subtract from the account).

api.setSharedAccountAccountBalance

Set the balance on a shared account to a set value. This is conducted as a transaction.

api.setSharedAccountRestriction

Set the restriction status on a shared account.

api.addSharedAccountAccessUser

Allow the given user access to the given shared account without using a pin.

api.removeSharedAccountAccessUser

Revoke the given user's access to the given shared account.

api.setSharedAccountAccessUsers

Set access to the given shared account to the given users (a comma separated list). Any users who currently have access but do not exist in the list will have their access revoked.

api.addSharedAccountAccessGroup

Allow the given group access to the given shared account without using a pin.

api.removeSharedAccountAccessGroup

Revoke the given group's access to the given shared account.

api.setSharedAccountAccessGroups

Set access to the given shared account to the given groups (a comma separated list). Any groups who currently have access but do not exist in the list will have their access revoked.

api.batchImportSharedAccounts

Import the shared accounts contained in the given tab separated import file (located on the server).

api.disablePrinter

Disable a printer for select period of time.

api.enablePrinter

Enable a disabled printer.

api.resetPrinterCounts

Reset the counts (pages and job counts) associated with a printer.

api.resetUserCounts

Reset the counts (pages and job counts) associated with a user account.

api.performOnlineBackup

Instigate an online backup. This process is equivalent to pressing the manual backup button in the web based admin interface. The data is exported into the server/data/backups directory as a timestamped, zipped XML file.