-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData.asmx
-
MPS Version: From 5.3.0
Description
This method returns the list of sites registered with the company specified in the call.
Syntax
public string GetSites(string dealerName, string dealerUserEmail, string dealerUserPassword, int enterpriseID, string fieldsList)
Parameters
-
dealerName: Provider name;
-
dealerUserEmail: Provider user email;
-
dealerUserPassword: Encrypted user password;
-
enterpriseID: Company ID on the MPS Portal;
-
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 |
|
SiteID |
Site identification 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 |
Identifier of the customer's stock that supplies this site |
|
StockName |
Name of the customer's stock 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 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.