CheckAdministrator
This method processes an administrator name and a password and checks whether there is an administrator with the administrator name, and if so, whether the password is theirs. The status code is returned and indicates whether the administrator name exists, and if so whether the password is correct or not. Any other error occurs, a SOAP fault message will be returned.
The password must be sent in plain text.
Parameters
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
|
Administrator_Name |
The name of the administrator to be verified |
String |
N |
|
Password |
Administrator's password. The password must be in plain text. |
String |
Y |
Response
| Output name | Description | Data type |
|---|---|---|
|
Status |
0 - The administrator exists and the password is correct 1 - The administrator exists and the password is incorrect 2 - The administrator does not exist |
Integer |
|
Administrator_ID |
If the administrator exists, their Administrator_ID is passed back. |
String |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.