External User Login
If you wish to allow an external interface to login a user in one web service call you will need to call the SessionLoginUser method. This method is available to developers from the Users.asmx Web Service. Typically this is where the external interface gets the user details from an internal eServices, and rather than force the user to log in again to My Alerts, this method is used to pass those details though.
Parameters
Name | Requirement | Description |
---|---|---|
ClientUsername | mandatory | This is the client user name as registered with Astun Technology Ltd. |
ClientPassword | mandatory | This is the password for the client user name. |
ClientKey | mandatory | This is the unique key supplied by Astun Technology Ltd when you register. |
Username | mandatory | This is the unique user name for the user as stored in the My Alerts database. |
Password | mandatory | The password for the user held in the My Alerts database and is not required for Remote authentication. |
Returns
<SessionLoginUserResult> <Error> <Code>string</Code> <Description>string</Description> </Error> <Success>boolean</Success> <Cookie>string</Cookie> </SessionLoginUserResult>
Error - Code / Description
An error code and description if the call to the web service is unsuccessful and the Success if False.
1001 – Invalid Session key provided
1019 – Error creating the Session Key
1021 – User authentication failed
1022 – User not found in My Alerts database
1024 – Client authentication failed
Success
This will be either True or False. If False an error message will be provided in the Error result, if True the Cookie will be provided.
Cookie
This is the Value part of the cookie that was created. This is encrypted.