GetPlainCountersData

  • Web Service URL: https://[SERVER_ADDRESS]/CountersWS/CountersData.asmx

  • MPS Version: From 5.5.0

Description

This method returns a record for each printer, reporting the first and last counters of each type registered in the printers and without any processing, according to the filters specified.

Syntax

public string GetPlainCountersData(string dealerName, string dealerUserEmail, string dealerUserPassword, string dateTimeStart, string dateTimeEnd, int maxLimitDaysEarlier, string enterpriseName, string serialNumber, string siteName, string siteDivisionName, bool engaged, string fieldsList)

Parameters

  • dealerName: Name of the provider;

  • dealerUserEmail: Email address of the provider user;

  • dealerUserPassword: Encrypted user password;

  • dateTimeStart: Start date for which you want to retrieve the counters (format yyyy-MM-dd HH:mm:ss);

  • dateTimeEnd: End date for which you want to retrieve the counters (format yyyy-MM-dd HH:mm:ss);

  • maxLimitDaysEarlier: Maximum number of days to consider;

  • enterpriseName: Name(s) of the company(ies) from which the printer counters will be retrieved. A single company can be specified to retrieve only the counters for printers belonging to that company; it can be left blank to retrieve printer counters without filtering by company; or a list of companies separated by semicolons (;) can be specified to retrieve only the counters for printers belonging to those companies. Example: Comp1;Comp2;Comp3;

  • serialNumber: Serial number(s) of the printer(s) from which the counters will be retrieved. A single serial number can be entered to search only for counters for the printer containing this serial number; it can be left blank to retrieve counters without filtering by serial number; or a list of numbers separated by semicolons (;) can be entered to search only for counters for printers containing the serial numbers entered. Example: SNImp1;SNImp1;SNImp1;

  • siteName: Name(s) of the site(s) where printer counters will be retrieved. You can enter a single site to retrieve only the counters for printers belonging to that site; you can leave it blank to retrieve printer counters without filtering by site; or you can enter a list of sites separated by semicolons (;) to retrieve only the counters for printers belonging to those sites. Example: Site1;Site2;Site3;

  • siteDivisionName: Name(s) of the department(s) where printer counters will be retrieved. You can enter a single department to search only for printer counters belonging to that department; it can be left blank to bring up counters without filtering by your department; or you can enter a list of departments separated by semicolons (;) to search only for printer counters belonging to those departments. Example: Depart1;Depart2;Depart3;

  • engaged: When set to true, it brings only the counters of contract printers, including printers with no movement in the specified period. When set to false, it brings up the counters for all printers;

  • fieldsList: List of fields that will be returned by the method. They must be specified by separating them with the character ‘;’. Example: PrinterDeviceName;SerialNumber;AddressName.

Fields recognized in fieldsList

Field name

Description

EnterpriseName

Company name

EnterpriseID

Company identification number

PrinterDeviceName

Printer name

PrinterModelName

Printer model

PrinterDeviceID

Printer identification number

SerialNumber

Printer serial number

AddressName

Printer IP address

BrandName

Printer manufacturer

Location

Printer location

SiteName

Site to which the printer belongs

SiteDivisionName

Department to which the printer belongs or - for printers that do not belong to any department

EnabledCounters

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

Engaged

True for contract printers and False for non-contract printers

IsSuspended

Indicates whether the printer is suspended

ContractNumber

Contract number defined for the printer

AssetNumber

Asset number defined for the printer

CounterTypeName

Name of the counter type

FirstDateTimeRead

Initial counter reading date

LastDateTimeRead

Final counter reading date

FirstCounterTotal

First total counter in the specified period

LatestCounterTotal

Last total counter in the specified period

FirstCounterMono

First mono counter in the specified period

LatestCounterMono

Last mono counter in the specified period

FirstCounterColor

First color counter in the specified period

LatestCounterColor

Last color counter in the specified period

Example of return received

Click here to learn more about the format of returns.

Possible errors returned

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

Restrictions

The method only returns the counters of the printers that the user is allowed to view, that is, the user must monitor the company or site to which the printer whose counters they want to view belongs.