MES Stateless API

GetSessions Method

Save PDF

GetSessions Method

Save PDF

Last UpdatedNov 06, 2025
2 minute read

The GetSessions() method retrieves the records from the Sessn table that match the specified filter parameters.

Syntax

'Declaration
 
Public Shared Function GetSessions( _
   ByVal sessionId As Nullable(Of Integer), _
   ByVal clientType As Nullable(Of Integer), _
   ByVal userId As String _
) As DataSet

'Usage
 
Dim sessionId As Nullable(Of Integer)
Dim clientType As Nullable(Of Integer)
Dim userId As String
Dim value As DataSet
 
value = Session.GetSessions(sessionId, clientType, userId)

public static DataSet GetSessions( 
   Nullable<int> sessionId,
   Nullable<int> clientType,
   string userId
)

Parameters

sessionId

Optional filter parameter. Holds the session ID and thus the user who is making this method call.

clientType

Optional filter parameter. An enumeration that identifies the client type.

userId

Optional filter parameter. The ID of the user who is logging onto the session.

Return Value

Returns a DataSet that contains all the records in the Sessn table satisfy the specified filters. If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
session_id	An integer that is the ID of the session and thus the user who is making this method call.
client_type	An enumeration that identifies the client type being used on this session.
session_start	A date/time that is the start time in the client’s local time.
last_heartbeat	A date/time that is the last time the heartbeat was refreshed, in client’s local time.
user_id	A string that is the ID of the active user on the session.
client_address	A string that is the socket address for event notifications.
reqd_events	A string that is the XML string identifying the events to be informed of.

MES Stateless API