-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
This method returns all companies owned by the provider.
Syntax
public string GetEnterprises(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 |
|
CNPJ |
Text |
No |
- |
- |
- |
Company Company Registration Number. This only needs to be provided if you want to filter by Company Registration Number |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
List of fields that will be returned by the method. They must be specified separated by a semicolon (;). Example: PrinterDeviceID;SiteID;SiteName. If no fields are specified, the response will contain the fields shown in bold in the table below |
Return fields recognized in FieldsList
|
Field name |
Description |
|
EnterpriseID |
Company ID in the system |
|
EnterpriseName |
Company name in the system |
|
EnterpriseKey |
Company key in the system |
|
CorporateName |
Company description |
|
CNPJ |
Company Company Registration Number |
|
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 |
Return
Click here to learn more about the return format.
Possible return errors
Click here to see the possible errors that may be returned and learn the reasons behind them.
Restrictions
-
To execute this method, the specified user must be an Administrator at the provider or in charge of a company.