Interface ISessionService

The Session Service allows to sign into the Ayuda platform and manage the session lifetime.

Namespace: Ayuda.BMS.Services.Interfaces

Remarks

This web service can be accessed using an address similar to the following: https://[AYUDA DEPLOYMENT URL]/BMSWebService/SessionService.asmx

Methods

GetAppSettingsClient(Guid)

Gets the application settings client.

Declaration

DataSet GetAppSettingsClient(Guid sessionID)

Parameters

Type	Name	Description
System.Guid	sessionID	Session ID returned by the SignIn method.

Returns

Type	Description
System.Data.DataSet	DataSet.

GetSessionInformation(Guid)

Gets the session information.

Declaration

SessionInformationDataSet GetSessionInformation(Guid sessionID)

Parameters

Type	Name	Description
System.Guid	sessionID	Session ID returned by the SignIn method.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SessionInformationDataSet	SessionInformationDataSet.

IsSessionAlive(Guid)

Determines whether the session is still active.

Declaration

bool IsSessionAlive(Guid sessionID)

Parameters

Type	Name	Description
System.Guid	sessionID	Session ID returned by the SignIn method.

Returns

Type	Description
System.Boolean	true if the session is active; otherwise, false.

IsUserAllowedToRunConnector(Connector, String, String)

Determines whether the user is allowed to run a connector.

Declaration

bool IsUserAllowedToRunConnector(Connector connector, string username, string password)

Parameters

Type	Name	Description
Ayuda.BMS.Shared.Connector	connector	The connector.
System.String	username	The username.
System.String	password	The password.

Returns

Type	Description
System.Boolean	true if the user is allowed to run connector; otherwise, false.

SignIn(String, String, Connector, String)

Signs the user in.

Declaration

Guid SignIn(string username, string password, Connector connector, string connectorVersion)

Parameters

Type	Name	Description
System.String	username	The username.
System.String	password	The password.
Ayuda.BMS.Shared.Connector	connector	The connector.
System.String	connectorVersion	The connector version.

Returns

Type	Description
System.Guid	Session ID.

SignInConnector(Connector, String, String, String)

Signs into a connector.

Declaration

SessionInformationDataSet SignInConnector(Connector connector, string username, string password, string connectorVersion)

Parameters

Type	Name	Description
Ayuda.BMS.Shared.Connector	connector	The connector.
System.String	username	The username.
System.String	password	The password.
System.String	connectorVersion	The connector version.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SessionInformationDataSet	SessionInformationDataSet.

SignInWebUser(String, String, Connector, String, String)

Signs the web user in.

Declaration

Guid SignInWebUser(string username, string password, Connector connector, string webUserName, string connectorVersion)

Parameters

Type	Name	Description
System.String	username	The username.
System.String	password	The password.
Ayuda.BMS.Shared.Connector	connector	The connector.
System.String	webUserName	Name of the web user.
System.String	connectorVersion	The connector version.

Returns

Type	Description
System.Guid	Session ID.

SignOut(Guid)

Signs the session out.

Declaration

void SignOut(Guid sessionID)

Parameters

Type	Name	Description
System.Guid	sessionID	Session ID returned by the SignIn method.

UpdateHeartbeat(Guid)

Updates the heartbeat.

Declaration

bool UpdateHeartbeat(Guid sessionID)

Parameters

Type	Name	Description
System.Guid	sessionID	Session ID returned by the SignIn method.

Returns

Type	Description
System.Boolean	true if session is active, false otherwise.

UpdateLastActivity(Guid)

Updates the last activity.

Declaration

void UpdateLastActivity(Guid sessionID)

Parameters

Type	Name	Description
System.Guid	sessionID	Session ID returned by the SignIn method.

UpdatePOPWebsiteUsage(Guid, Guid, String)

Updates the pop website usage.

Declaration

void UpdatePOPWebsiteUsage(Guid sessionID, Guid campaignID, string username)

Parameters

Type	Name	Description
System.Guid	sessionID	Session ID returned by the SignIn method.
System.Guid	campaignID	The campaign identifier.
System.String	username	The username.