-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
This method updates a site on the provider's platform. You can specify only the data to be changed.
Syntax
public string UpdateSite(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 |
Yes |
- |
- |
- |
Identification number of the company that owns the printer to be modified. Obtained via the GetEnterprises method |
|
SiteID |
Number |
Yes |
- |
- |
- |
Identifier of the site whose data will be modified. Obtained via the GetSites method |
|
SiteName |
Text |
No |
- |
- |
100 |
New site name |
|
CountryName |
Text |
No |
- |
- |
100 |
New name of the country where the site is located |
|
StateName |
Text |
No |
- |
- |
100 |
New name of the state where the site is located |
|
CityName |
Text |
No |
- |
- |
100 |
New name of the city where the site is located |
|
Street |
Text |
No |
- |
- |
255 |
New name of the street where the site is located |
|
Neighborhood |
Text |
No |
- |
- |
100 |
New name of the neighborhood where the site is located |
|
PostalCode |
Text |
No |
- |
- |
20 |
New ZIP code of the site |
|
Number |
Text |
No |
- |
- |
- |
New name of the location where the site is located |
|
AdditionalInfo |
Text |
No |
Yes |
Yes |
255 |
New additional information about where the site is located |
|
StockID |
Number |
No |
- |
- |
- |
Identifier number of the customer's stock that you want to add to the site. Obtained via the GetDealerStocks method |
Characters not allowed in parameters and the error that will be returned
|
Parameter |
Not allowed 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 |
Response
If successful, the response is: [{“Updated”:true}].
Click here to learn more about the response format.
Possible error responses
Click here to see the possible errors that may be returned and learn their reasons.
Restrictions
-
To execute this method, the specified user must be an Administrator on the provider.