MENU
    GetSessionId API
    • 1 Minute to read
    • Dark
    • PDF

    GetSessionId API

    • Dark
    • PDF

    Article summary

    Retrieves the session id for the current user session.

    Syntax

    SessionId = api.getSessionId()
    Shell

    Usage

    Use the GetSessionId to retrieve the session id for the current user session. Upon invocation, the Web Service returns the session id of the current user session. The Client application can then use methods on the session id and retrieve information. The Client application must be logged in with sufficient access rights to retrieve the session id.

    Response

    SessionId

    The GetSessionId method call returns session id of the current user session.

    Sample Code

    Private Sub getSessionId()
    Dim api As New HostAPI()
    Dim strSessionId As String = ""
    Try
    'Call the web method to retrieve the current session ID
    		strSessionId = api.getSessionId()
    		Console.WriteLine(strSessionId)
    Catch ex As Exception
    End Try
    End Sub
    Shell

    Was this article helpful?