-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
Method used to update information on printers.
Syntax
public string UpdatePrinter(string properties)
Setting Properties
The content of string properties must be text in JSON format containing the properties listed below. For example:
{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}
You don't need to worry about whether property names are uppercase or lowercase; 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 |
|
EnterpriseID |
Number |
Yes |
- |
- |
- |
Identification number of the company that owns the printer to be modified. Obtained via the GetEnterprises method |
|
PrinterDeviceID |
Number |
Yes |
- |
- |
- |
Identification number of the printer to be modified. Obtained via the GetPrinters method |
|
AssetNumber |
Text |
No |
- |
- |
255 |
New asset number |
|
Location |
Text |
No |
- |
Yes |
255 |
New printer location information |
|
PrinterName |
Text |
No |
- |
- |
200 |
New name for the printer |
|
PrinterContact |
Text |
No |
- |
Yes |
255 |
New contact information for the printer |
|
EnabledCounters |
Logical |
No |
- |
- |
- |
Whether or not to enable printer meter monitoring |
|
EnabledBilling |
Logical |
No |
- |
- |
- |
Whether or not to enable printer accounting monitoring |
|
IsSuspended |
Logical |
No |
- |
- |
- |
Whether or not to suspend the printer; True to suspend and False to not suspend. This field can only be changed when the printer’s monitoring is disabled (EnabledCounters = false) |
|
ReplacementFlowDisabled |
Logical |
No |
- |
- |
- |
Whether or not to disable the printer's replenishment flow; True when disabled and False when enabled, according to system rules. This field can only be changed when the printer's monitoring is active (EnabledCounters = true) |
|
IsPartnerPrinter |
Logical |
No |
- |
- |
- |
Whether the printer belongs to the partner (true) or not (false). If left blank or not specified, the printer’s registration status will remain unchanged |
|
SiteID |
Number |
Only if you are specifying the SiteDivisionID parameter |
- |
- |
- |
Enter the site ID number if you wish to assign a site to the printer.
|
|
SiteDivisionID |
Number |
No |
- |
- |
- |
Enter the department ID number if you want to assign a department to the printer. Obtained via the GetSiteDivisions method. To remove the department, simply enter the number -1 |
|
Field1¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer’s Field1 field |
|
Field2¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer’s Field2 field |
|
Field3¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer’s Field3 field |
|
Field4¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer's Field4 field |
|
Field5¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer's Field5 field |
|
Field6¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer's Field6 field |
|
Field7¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer's Field7 field |
|
Field8¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer's Field8 field |
|
Field9¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer's Field9 field |
|
Field10¹ |
Text |
No |
- |
- |
255 |
Enter a new value for the printer's Field10 field |
¹ Available only starting with version 5.10.0.
Response
If successful, the response is: [{“Updated”:true}].
Click here to learn more about the response format.
Possible error responses
Click here to see the possible errors that may be returned and learn their reasons.
Restrictions
-
To execute this method, the specified user must be an Administrator on the provider.