-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Version: From 5.5.0
Description
This method returns closing volume data by print location.
Syntax
public string RetrieveClosingConsolidatedByPrintLocalAndVolume(string properties)
Assembling properties
The content of string properties must be text in JSON format containing the properties below. For example:
{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}
There is no need to worry about uppercase or lowercase property names, as the Web Service is Case-Insensitive.
Properties accepted by the method
|
Property |
Type |
Required |
Allows null |
Allows empty |
Maximum size |
Description |
|
DealerName |
Text |
Yes |
- |
- |
- |
Provider name |
|
DealerUserEmail |
Text |
Yes |
- |
- |
- |
Provider user email |
|
DealerUserPassword |
Text |
Yes |
- |
- |
- |
Encrypted user password |
|
ClosingID |
Número |
Yes |
- |
- |
- |
Closing identifier number |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
List of fields that will be returned by the method. They must be specified separated by the character ‘;’. Example: PrinterName;ModelName;SerialNumber |
Recognized return fields in FieldsList
|
Field name |
Description |
|
PrinterName |
Printer name |
|
BrandName |
Manufacturer name |
|
ModelName |
Printer model name |
|
SerialNumber |
Printer serial number |
|
AddressName |
Printer IP address |
|
AssetNumber |
Asset number defined for the printer |
|
SiteName |
Name of the site to which the printer belongs |
|
SiteDivisionName |
Name of the department to which the printer belongs (blank for printers that do not belong to a department) |
|
FullPrinterName |
Display name of the printer in MPS |
|
ServiceName |
Name of the print service that was calculated at closing |
|
ClosingStartDate |
Start date of the closing period |
|
ClosingFinishDate |
End date of the closing period |
|
PrintLocationName |
Name of the Printer Location where this volume was calculated |
|
Location |
Physical location of the printer |
|
ServiceVolume |
Volume of pages printed |
|
AprovingAccount |
Name of the user who confirmed the printer closing data |
|
AprovingComment |
User comment on the printer confirmation in this closing |
|
AprovingEmail |
Email address of the user who confirmed the printer |
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
To execute this method, the user specified must be an Administrator at the provider.