GetPrinters

  • Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData.asmx

  • MPS Version: From 5.3.0

Description

This method returns a list of all printers in the company specified in the call.

Syntax

public string GetPrinters(string dealerName, string dealerUserEmail, string dealerUserPassword, int enterpriseID, string fieldsList)

Parameters

  • dealerName: Provider name;

  • dealerUserEmail: Provider user email;

  • dealerUserPassword: Encrypted user password;

  • enterpriseID: Company ID on the MPS Portal;

  • fieldsList: List of fields that will be returned by the method. They must be specified separated by the character ‘;’. Example: PrinterDeviceID;SiteID;SiteName.

    • When no fields are specified, the response will contain the fields that are in bold in the table below.

Recognized return fields in fieldsList

Field name

Description

PrinterDeviceID

Printer identifier in the system. The identifier is only valid for the company specified in the call, as the same identifier may be repeated in another company

SiteID

Identifier of the site to which the printer belongs

SiteName

Name of the site to which the printer belongs

SiteDivisionID

Identifier of the department to which the printer belongs (-1 for printers that do not have a defined department)

SiteDivisionName

Name of the department to which the printer belongs (Leave blank for printers that do not belong to a department)

PrinterName

Printer name

BrandName

Printer manufacturer name

ModelName

Printer model name

SerialNumber

Printer serial number

AddressName

Printer IP address

AddressMac

Printer MAC

Location

Physical location of the printer

Engaged

Indicates whether the printer is under contract, True for printers under contract and False for printers not under contract

EnabledBilling

Indicates whether page accounting is enabled for the printer, True when enabled and False when disabled

EnabledCounters

Indicates whether counter monitoring is enabled for this printer, True when enabled and False when disabled

ContractNumber

Contract number defined for the printer

AssetNumber

Asset number defined for the printer

ContactData

Printer contact information

Click here to learn more about the format of the returns.

Possible errors returned

Click here to check the possible errors that may be returned and learn about their reasons.

Restrictions

  • To execute this method, the user must be an Administrator with the provider.