-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData.asmx
-
MPS Version: From 5.3.0
Description
This method returns all companies owned by the provider.
Syntax
public string GetEnterprises(string dealerName, string dealerUserEmail, string dealerUserPassword, string fieldsList)
Parameters
-
dealerName: Name of the provider;
-
dealerUserEmail: Email address of the provider user;
-
dealerUserPassword: Encrypted user password;
-
fieldsList: List of fields that will be returned by the method. They must be specified separated by the character ‘;’. Example: PrinterDeviceID;SiteID;SiteName.
-
When no fields are specified, the response will contain the fields that are in bold in the table below.
-
Recognized return fields in fieldsList
|
Field name |
Description |
|
EnterpriseID |
Company identifier in the system |
|
EnterpriseName |
Company name in the system |
|
EnterpriseKey |
Company key in the system |
|
CorporateName |
Company description |
|
CNPJ |
Company tax ID |
|
AddressCountry |
Country where the company is located |
|
AddressState |
State where the company is located |
|
AddressCity |
City where the company is located |
|
AddressStreet |
Street where the company is located |
|
AddressNeighborhood |
Neighborhood where the company is located |
|
AddressPostalCode |
ZIP code where the company is located |
|
AddressNumber |
Company location number |
|
AddressAdditionalInfo |
Company address supplement |
|
IsMonitored |
Indicates whether the company is monitored |
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 with the provider.