If you wish to create a client session key you will need to call the CreateSessionKey method. This method is available to developers from the Users.asmx Web Service and is the first step when using the MyAlerts My Alerts web service to create a client session key. The CreateSessionKey method must be called to retrieve the ClientId and SessionKey which are required in all calls to the MyAlerts My Alerts Web Services. This function is automatically called by the iShare portal.
Parameters
Name | Requirement | Description |
|---|---|---|
Username | mandatory | This is the client user name as registered with Astun Technology Ltd. |
Password | mandatory | This is the password for the client user name. |
Key | mandatory | This is the unique key supplied by Astun Technology Ltd when you register. |
Returns
| Code Block | ||||
|---|---|---|---|---|
| ||||
<CreateSessionKeyResult>
<Error>
<Code>string</Code>
<Description>string</Description>
</Error>
<Success>boolean</Success>
<ClientId>int</ClientId>
<SessionKey>string</SessionKey>
</CreateSessionKeyResult> |
Error - Code / Description
An error code and description if the call to the web service is unsuccessful and the Success if False.
...
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 ClientId and SessionKey will be provided.
ClientId
This is the unique id for the client and is used in subsequent web service calls
SessionKey
This is a unique session key for the client.
Code Examples
c#
Add a web reference to the users.asmx web service using the Visual Studio IDE.
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Users.Users uws = new Users.Users();
//Use UserName, Password and Key as defined in your data.xml file
Users.SessionKeyResult result = uws.CreateSessionKey("[UserName]", "[Password]", "[Key]");
if (result.Success)
{
Response.Write("Client Id: " + result.ClientId + "<br/>");
Response.Write("Session Key: " + result.SessionKey + "<br/>");
}
else
Response.Write("Failed to create the session key");
|
Python
In the code below, use your own path to web service and UserName, Password and Key defined in your data.xml file
...