GetAdministratorByName
This method processes an administrator name and returns a list giving the full details of the administrator if the administrator ID exists in the database. If the administrator doesn't exist in the repository, a SOAP fault message will be returned.
Note: The GetAdministratorByName method doesn't return any roles assigned to an administrator.
Parameters
Input name | Description | Data type | Optional field? |
---|---|---|---|
Administrator_Name |
The Administrator_ID is the number of the administrator to be retrieved, as stored in the database. |
String |
N |
Response
Output name | Description | Data type |
---|---|---|
Administrator_ID |
The Administrator_ID |
String |
Administrator_Name |
The login name of this administrator |
String |
Profile_Name |
The user profile record from which this administrator's rights are inherited |
String |
Authenticate_Ext |
Reserved for future use |
Integer |
|
This administrator's email address |
String |
URL |
Not currently used by the Perception software |
String |
Troubleshooting
For information about any error codes returned when using this method, see Error codes.