-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Version: Starting from 5.5.0
Description
Retrieves all contracts that are with the provider. Only returns contracts for which the user has permission in the specified company.
Syntax
public string RetrieveContracts(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 |
No |
- |
- |
- |
Company identification number. Obtained using the GetEnterprises method. |
Return fields
|
Field name |
Descrição |
|
ContractID |
Contract identifier in the system |
|
ContractAlias |
Contract identification name (nickname) |
|
ContractNumber |
Contract number |
|
EnterpriseID |
Company identifier in the system |
|
EnterpriseName |
Company name in the system |
|
ContractPrinters |
Quantity of equipment expected to be contracted under the contract |
|
Actived¹ |
Indicates whether the contract is active, returning true or false |
¹ This field has been restored starting with version 5.11.0.
Click here to learn more about the format of returns.
Example of a 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
To execute this method, the user must be an Administrator with the provider.