-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
This method returns a list of registered sites for a specific company or all sites for all companies in the partner network, if no company is specified.
Syntax
public string GetSites(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 |
|
EnterpriseID |
Number |
No |
- |
- |
- |
Company ID number. Obtained via the GetEnterprises method |
|
FieldsList |
Text |
No |
Yes |
Yes |
- |
List of fields to 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 shown in bold in the table below |
Return fields recognized in FieldsList
|
Field name |
Description |
|
EnterpriseID |
Company ID in the system |
|
EnterpriseName |
Company name |
|
SiteID |
Site ID in the system |
|
SiteName |
Site name |
|
IsDefault |
Indicates whether this is the company's default site. True for the site defined as default and False for all other sites |
|
StockID |
ID of the customer warehouse that supplies this site |
|
StockName |
Name of the customer warehouse that supplies this site |
|
AddressCountry |
Country where the site is located |
|
AddressState |
State where the site is located |
|
AddressCity |
City where the site is located |
|
AddressStreet |
Street where the site is located |
|
AddressNeighborhood |
Neighborhood where the site is located |
|
AddressPostalCode |
ZIP code where the site is located |
|
AddressNumber |
Site location number |
|
AddressAdditionalInfo |
Site address supplement |
Click here to learn more about the response format.
Possible errors returned
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 on the provider.