Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

If you wish to return the session key for a user in the MyAlerts database you will need to call the GetUserSessionKey method.

GetUserSessionKey

Input Parameters

The GetUserSessionKey method needs the following parameters:

ClientId

This is the id for the client that was returned by the CreateSessionKey method.

SessionKey

This is the SessionKey for the client that was returned by the CreateSessionKey method.

UserId

This is the unique user id for the user as stored in the MyAlerts database.

Returned Parameters

The following parameters will be returned:

Syntax
<GetUserSessionKeyResult>
	<Error>
		<Code>string</Code>
		<Description>string</Description>
	</Error>
	<SessionKey>string</SessionKey>
	<Success>boolean</Success>
	<UserId>int</UserId>
</GetUserSessionKeyResult>

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

Success

This will be either True or False. If False an error message will be provided in the Error result, if True the user session key will be returned.

SessionKey

This is the session key for this user.

UserId

This is the user id for the user.

  • No labels