-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Version: Starting from 5.5.0
Description
Creates a printer within the company's contract flow.
-
If the printer already exists and has been removed, it is reinserted¹ and ensured that it is part of the contract flow;
-
If the printer already exists and is not part of a contract flow, it is inserted into the flow. In such cases, if there is only one contract in the company, the printer will be automatically inserted into the contract.
-
If the printer is in a contract flow, its asset number will be updated, if provided;
-
The printer contact will always be updated, if provided.
-
¹ The removed printer is only reinserted starting with version 5.11.0.
Syntax
public string RegisterContractPrinter(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 |
|
EnterpriseID |
Number |
Yes |
- |
- |
- |
Company identification number. Obtained using the GetEnterprises method |
|
PrinterDeviceName |
Text |
Yes |
- |
- |
- |
Printer name |
|
SerialNumber |
Text |
Yes |
- |
- |
- |
Printer serial number |
|
BrandName |
Text |
Yes |
- |
- |
- |
Manufacturer's name |
|
ModelName |
Text |
Yes |
- |
- |
- |
Printer model |
|
AssetNumber |
Text |
No |
Yes |
- |
255 |
Asset number |
|
IsPartnerPrinter |
Logical |
Yes |
- |
- |
- |
If the printer belongs to the partner. Enter the true value or false value. |
|
PrinterContact |
Text |
No |
- |
Yes |
255 |
Printer contact |
Return
If successful, the return is: [{“PrinterDeviceID”:number}], where number is the identifier number of the inserted printer.
Click here to learn more about the return format.
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 specified user must be an Administrator at the provider.