-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
This method registers a new department at a specific site belonging to a provider's company.
Syntax
public string ImportSiteDivision(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 |
- |
- |
- |
Company ID number. Obtained via the GetEnterprises method |
|
SiteID |
Number |
Yes |
- |
- |
- |
ID number of the site where the department will be registered. Obtained via the GetSites method |
|
SiteDivisionName |
Text |
Yes |
- |
- |
100 |
Name of the department to be registered |
Characters not allowed in parameters and the error that will be returned
|
Parameter |
Unallowed characters |
Error |
|
siteDivisionName |
,|'+ |
ERR_DATA_INVALIDSITEDIVISIONNAME |
Return Value
If successful, the return value is: [{“SiteDivisionID”:number}], where number is the identifier number for the new department entered.
Click here to learn more about the return format.
Possible errors returned
Click here to view 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.