api.isUserExists

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

api.getUserAccountBalance

Get the user's current account balance.

api.getUserProperty

Gets a user property. Properties include the user's full name, department, email, notes, office and restriction status among others.

api.getUserProperties

Get multiple user properties at once. Properties include the user's full name, department, email, notes, office and restriction status among others.

api.setUserProperty

Sets a user property. Properties include the user's full name, department, email, notes, office, password (for internal users) and restriction status among others.

api.setUserProperties

Set multiple user properties at once. Properties include the user's full name, department, email, notes, office, password (for internal users) and restriction status among others.

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.adjustUserAccountBalanceIfAvailable

Adjust a user's account balance if there is enough credit available.

api.adjustUserAccountBalanceIfAvailableLeaveRemaining

Adjust a user's account balance if there is enough credit available to leave the given amount available in 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.adjustUserAccountBalanceByGroupUpTo

Adjust the account balance for all users in a group by an adjustment amount, but not above the given limit. 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.setUserAccountBalanceByGroup

Set the balance for each member of a group to the given value.

api.resetUserCounts

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

api.reapplyInitialUserSettings

Re-applies initial settings on the user. Initial user settings are based on group membership.

api.disablePrintingForUser

Disable printing for a user for selected period of time.

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.renameUserAccount

Rename a user account. Useful when the user has been renamed in the domain / directory, so that usage history can be maintained for the new username. This should be performed in conjunction with a rename of the user in the domain / user directory, as all future usage and authentication will need to use the new username.

api.getUserGroups

Retrieves all groups a single user is a member of.

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.addNewInternalUser

Creates and sets up a new internal user account.

In PaperCut NG all internal usernames must only contain characters that can be printed (e.g. not newline) and must not contain /, \ or @.

api.lookUpUserNameByIDNo

Looks up the user with the given user id number and returns their user name. If no match was found an empty string is returned.

api.lookUpUserNameByCardNo

Looks up the user with the given user card number and returns their user name. If no match was found an empty string is returned.

api.addAdminAccessUser

Add a user as an admin with default admin rights.

api.removeAdminAccessUser

Remove an admin user from the list of admins.

api.addAdminAccessGroup

Add a group as an admin group with default admin rights.

api.removeAdminAccessGroup

Remove a group from the list of admin groups.

api.setUserAccountSelectionAutoSelectSharedAccount

Sets a user's account selection to charge to a single shared account.

api.setUserAccountSelectionAutoChargePersonal

Sets a user's account selection to automatically charge to personal account

api.setUserAccountSelectionStandardPopup

Sets a user's account selection to standard account selection popup.

api.listUserAccounts

List all user accounts (sorted by username) starting at offset and ending at limit. This can be used to enumerate all user accounts in 'pages'. When retrieving a list of all user accounts, the recommended page size / limit is 1000. Batching in groups of 1000 ensures efficient transfer and processing.

E.g.:

    listUserAccounts("authToken", 0, 1000) - 
    returns users 0 through 999
    listUserAccounts("authToken", 1000, 1000) - 
    returns users 1000 through 1999
    listUserAccounts("authToken", 2000, 1000) - 
    returns users 2000 through 2999
                                

api.getTotalUsers

Gets a count of all the users in the system.

api.listSharedAccounts

List all shared accounts (sorted by account name) starting at offset and ending at limit. This can be used to enumerate all shared accounts in 'pages'. When retrieving a list of all accounts, the recommended page size / limit is 1000. Batching in groups of 1000 ensures efficient transfer and processing.

E.g.:

    listSharedAccounts("authToken", 0, 1000) - 
    returns shared accounts 0 through 999
    listSharedAccounts("authToken", 1000, 1000) - 
    returns shared accounts 1000 through 1999
    listSharedAccounts("authToken", 2000, 1000) - 
    returns shared accounts 2000 through 2999
                                

api.listUserSharedAccounts

List all shared accounts the user has access to (sorted by account name), starting at offset and ending at limit. This can be used to enumerate the accounts in 'pages'. When retrieving a list of all accounts, the recommended page size / limit is 1000. Batching in groups of 1000 ensures efficient transfer and processing.

You may optionally specify TRUE to list accounts even if the user is currently not configured to charge to a shared account.

E.g.:

    listUserSharedAccounts("authToken", "username", 0, 1000) - 
    returns shared accounts 0 through 999
    listUserSharedAccounts("authToken", "username", 1000, 1000) - 
    returns shared accounts 1000 through 1999
    listUserSharedAccounts("authToken", "username", 2000, 1000) - 
    returns shared accounts 2000 through 2999
    listUserSharedAccounts("authToken", "username", 0, 1000, TRUE) - 
    returns shared accounts 0 through 999 even if "username" is not configured to charge to a shared account.
                                

api.isSharedAccountExists

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

api.setSharedAccountAccountBalance

Sets a shared account's current account balance.

api.getSharedAccountAccountBalance

Gets a shared account's current account balance.

api.setSharedAccountProperty

Sets a shared account property. Properties include access groups, balance, comment options, disabled status, notes, pin and restriction status among others.

api.setSharedAccountProperties

Sets multiple shared account properties at once. Properties include access groups, balance, comment options, disabled status, notes, pin and restriction status among others.

api.getSharedAccountProperty

Gets a shared account property. Properties include access groups, balance, comment options, disabled status, notes, pin and restriction status among others.

api.getSharedAccountProperties

Gets multiple shared account properties at once. Properties include access groups, balance, comment options, disabled status, notes, pin and restriction status among others.

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.addNewSharedAccount

Create a new shared account with the given name.

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.addSharedAccountAccessUser

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

api.renameSharedAccount

Rename an existing shared account.

api.deleteExistingSharedAccount

Delete a shared account from the system. Use this method with care. Calling this will permanently delete it from the shared account list.

api.addSharedAccountAccessGroup

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

api.removeSharedAccountAccessUser

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

api.removeSharedAccountAccessGroup

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

api.getPrinterProperty

Gets a printer property. Available properties include: disabled, print-stats.job-count, print-stats.page-count.

api.setPrinterProperty

Sets a printer property.

api.listPrinters

List all printers (sorted by printer name), starting at offset and ending at limit. This can be used to enumerate the printers in 'pages'. When retrieving a list of all printers, the recommended page size / limit is 1000. Batching in groups of 1000 ensures efficient transfer and processing.

E.g.:

    listPrinters("authToken", 0, 1000) - 
    returns printers 0 through 999
    listPrinters("authToken", 1000, 1000) - 
    returns printers 1000 through 1999
    listPrinters("authToken", 2000, 1000) - 
    returns printers 2000 through 2999
                                

api.setPrinterCostSimple

Set a page cost using the Simple Charging Model.

api.getPrinterCostSimple

Get the page cost if, and only if, the printer is using the Simple Charging Model.

api.resetPrinterCounts

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

api.addPrinterGroup

Add a printer to a single printer group.

api.setPrinterGroups

Set the printer groups a printer belongs to, overwriting any existing group.

api.enablePrinter

Enables a printer.

api.disablePrinter

Disable a printer for select period of time.

api.deletePrinter

Delete a printer. Use the special text "[All Printers]" to delete all printers on the specified server.

api.renamePrinter

Rename a printer. This can be useful after migrating a print queue or print server (i.e. the printer retains its history and settings under the new name). Note that in some cases case sensitivity is important, so care should be taken to enter the name exactly as it appears in the OS.

api.addPrinterAccessGroup

Add a user group to the printer's access group list.

api.removePrinterAccessGroup

Remove a user group from the printer's access group list.

api.addNewGroup

Add a new group to system's group list.

api.RemoveGroup

Remove a group.

api.listUserGroups

List all groups (sorted by group name), starting at offset and ending at limit. This can be used to enumerate the groups in 'pages'. When retrieving a list of all groups, the recommended page size / limit is 1000. Batching in groups of 1000 ensures efficient transfer and processing.

E.g.:

    listUserGroups("authToken", 0, 1000) - 
    returns groups 0 through 999
    listUserGroups("authToken", 1000, 1000) - 
    returns groups 1000 through 1999
    listUserGroups("authToken", 2000, 1000) - 
    returns groups 2000 through 2999
                                

api.isGroupExists

Test to see if a group exists in the system.

api.addUserToGroup

Adds a user to a specified group. Changes the group membership within the application, not in the OS/Network/Domain user directory.

api.removeUserFromGroup

Removes a user from a specified group. Changes the group membership within the application, not in the OS/Network/Domain user directory.

api.setGroupQuota

Set the group quota allocation settings on a given group.

api.getGroupQuota

Get the group quota allocation settings on a given group.

api.useCard

Redeem a card and place the credit on the user's 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.

api.performGroupSync

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

api.performUserAndGroupSync

Start a full user and group synchronization. This is equivalent to pressing the Synchronize Now button in the admin interface. No existing users will be removed. Whether or not full details for existing users will be updated depends on the current user/group sync 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 settings. A call to this method will commence the sync process and the operation will complete in the background.

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.getTaskStatus

Return the status (completed flag and a status message) associated with a backgrounded task such as a sync operation started by the performGroupSync API. This method returns a struct (hashtable/map) containing elements with keys completed and message. This method may be polled to determine if a sync has completed.

api.batchImportSharedAccounts

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

api.batchImportUsers

Import the users contained in the given tab-delimited import file (located on the server). See the section called “Batch User Data Import and Update” for a description of the file format.

api.batchImportInternalUsers

Import the internal users contained in the given tab-delimited import file (located on the server). See the section called “Batch Internal User Import and Update” for details of the required file format.

api.batchImportUserCardIdNumbers

Import the user card/ID numbers and PINs contained in the given tab-delimited import file.

api.createUserClientAccountsFile

Saves a file containing shared accounts data for the user client. See the manual for more information on how this feature can be used. The file will be saved on the server to the location: [app-path]\server\data\client\client-accounts.dat

If this file already exists it will be over-written.

api.getConfigValue

Gets the value of a configuration settings.

api.setConfigValue

Sets the value of a configuration setting. NOTE: Take care updating config values. You may cause serious problems which can only be fixed by reinstallation of the application. Use the setConfigValue API at your own risk.

api.processJob

Takes the details of a job and logs and charges as if it were a "real" job. Jobs processed via this method are not susceptible to filters, pop-ups, hold/release queues etc., they are simply logged. See the user manual section "Importing Print Job Details" for more information and the format.