-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData.asmx
-
MPS Version: From 5.3.0
Description
This method registers or updates a site in a provider's company. When the name of a site that does not yet exist in the company is entered, the method will register it. If the name of a site that is already registered is entered, the method will update the site's address data.
Syntax
public string ImportSite(string dealerName, string dealerUserEmail, string dealerUserPassword, int enterpriseID, string siteName, string countryName, string stateName, string cityName, string street, string neighborhood, string postalCode, int number, string additionalInfo)
Parameters
-
dealerName: Name of the provider;
-
dealerUserEmail: Email address of the provider user;
-
dealerUserPassword: Encrypted user password;
-
enterpriseID: ID of the company for which the site will be created;
-
siteName: Name of the site to be created or updated;
-
countryName: Country where the site is located;
-
stateName: State where the site is located;
-
cityName: City where the site is located;
-
street: Name of the street where the site is located;
-
neighborhood: Name of the neighborhood where the site is located;
-
postalCode: Postal code number of the site;
-
number: Number of the location where the site is located;
-
additionalInfo: Additional information about where the site is located.
Characters not allowed in parameters and the error that will be returned
|
Parameter |
Unsupported characters |
Error |
|
siteName |
,|'+ |
ERR_DATA_INVALIDSITENAME |
|
countryName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDCOUNTRYNAME |
|
stateName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDSTATENAME |
|
cityName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDCITYNAME |
|
street |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDSTREET |
|
neighborhood |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDNEIGHBORHOOD |
|
postalCode |
!@#$%¨&*=§[]{}ºª?/°;:><\/+.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDPOSTALCODE |
Return
If successful, the return is: [{“SiteID”:number}], where number is the identifier number on the newly entered site.
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.