-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Version: From 5.5.0
Description
This method returns a list of departments registered on the site of a company specified in the call. If no company is specified, all companies from the provider will be returned. If no site is specified, all sites will be returned.
Syntax
public string GetSiteDivisions(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. Obtained via the GetEnterprises method |
|
SiteID |
Number |
No |
- |
- |
- |
ID of the company site from which you want to search for the departments. Obtained via the GetSites method |
Return fields
|
Field name |
Description |
|
EnterpriseID |
Company ID in the system |
|
EnterpriseName |
Company name |
|
SiteID |
Site ID in the system |
|
SiteName |
Site name |
|
SiteDivisionID |
Department ID in the system |
|
SiteDivisionName |
Department name |
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.