-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Version: Starting from 5.5.0
Description
Returns the statuses registered by the provider that indicate situations where the equipment is not covered by a contract. This information can be used when registering new equipment, informing the current status of the equipment in the registry.
Syntax
public string RetrieveOutOfContractStatus(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 |
Return fields
|
Field name |
Description |
|
ContractStatusID |
Identify the printer status when exiting a contract |
|
ContractStatusName |
Description of the printer status when exiting a contract |
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 on the provider.