UserService
UserService Description: ASMX, WSDL
Authenticate:
ASMX,
XML
Description: Check if user is valid.
| Parameters: |
| none |
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| Boolean |
|
AuthenticateAdministrator:
ASMX,
XML
Description: Check if user is valid and at what level. None=0, Account=1, Site=2, Server=3
| Parameters: |
| none |
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| Administrator |
|
Exists:
ASMX,
XML
Description: Check if a user exists.
| Parameters: |
| Name |
Type |
Description |
| Email |
String |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| Boolean |
|
ExistsByID:
ASMX,
XML
Description: Check if a user exists with UserID.
| Parameters: |
| Name |
Type |
Description |
| UserID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| Boolean |
|
List:
ASMX,
XML
Description: List users with email addresses like search email.
| Parameters: |
| Name |
Type |
Description |
| SearchEmail |
String |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| UserDataset.UserDataTable |
XSD |
Load:
ASMX,
XML
Description: Load user record with email address.
| Parameters: |
| Name |
Type |
Description |
| Email |
String |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| UserDataset.UserDataTable |
XSD |
LoadByID:
ASMX,
XML
Description: Load user record with ID.
| Parameters: |
| Name |
Type |
Description |
| UserID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| UserDataset.UserDataTable |
XSD |
LoadListNames:
ASMX,
XML
Description: Load valid accounts for the logged in user.
| Parameters: |
| none |
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| ListDataset.ListDataTable |
XSD |
Update:
ASMX,
XML
Description: Update a user record.
| Parameters: |
| Name |
Type |
Description |
| User |
UserDataset.UserDataTable |
XSD |
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| UserDataset.UserDataTable |
XSD |