GetLoginStatus

This call will return information of current user after successful handled session from the login operation. See the description of returned information below. This call must be encrypted.

Input parameters

Input-SessionId: The current session id as base64-string. This type is mandatory.
Input-Count: The current call-count of the session. This must be a numeric value. This type is mandatory.

SOAP implementation

Content type

text/xml; charset="utf-8";

Header

Action "http://www.pointsharp.com/netid/server/portal/IServiceSoap/GetLoginStatus"

Request

<s:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <GetLoginStatus xmlns="http://www.pointsharp.com/netid/server/portal">
            <Info>
                <SessionId></SessionId>
                <Count>1</Count>
            </Info>
        </GetLoginStatus>
    </s:Body>
</s:Envelope>

Response

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <GetLoginStatusResponse xmlns="http://www.pointsharp.com/netid/server/portal">
            <GetLoginStatusResult>
                <Count>1</Count>
                <Id>1</Id>
                <ImageId>35</ImageId>
                <Name>John Doe</Name>
                <OrganizationName>Contoso Ltd</OrganizationName>
                <IsLoggedIn>True</IsLoggedIn>
                <IdleExpiration>1200</IdleExpiration>
                <DateTime>2023-02-22 07:14:03 UTC</DateTime>
                <TaskCounter>0</TaskCounter>
                <UsageList>
                    <ListObj>
                        <PresentationInfo>User</PresentationInfo>
                    </ListObj>
                    <ListObj>
                        <PresentationInfo>Token</PresentationInfo>
                    </ListObj>
                    <ListObj>
                        <PresentationInfo>Self</PresentationInfo>
                        <ActivityList>
                            <ActivityObj>
                                <Method>GetObject</Method>
                                <Type>User</Type>
                                <Id>1</Id>
                            </ActivityObj>
                        </ActivityList>
                    </ListObj>
                    <ListObj>
                        <PresentationInfo>AuditLog</PresentationInfo>
                    </ListObj>
                </UsageList>
                <OrganizationList>
                    <ListObj>
                        <Id>9</Id>
                        <PresentationInfo>Pointsharp AB</PresentationInfo>
                        <AdditionalInfo>Style=black,#000000,#FFFFFF,#999999;#232C2E;#D21041;#FFFFFF</AdditionalInfo>
                        <ActivityList>
                            <ActivityObj>
                                <Method>CreateTask</Method>
                                <Type>555</Type>
                                <Id>9</Id>
                            </ActivityObj>
                        </ActivityList>
                    </ListObj>
                </OrganizationList>
                <Status>
                    <Code>Success</Code>
                    <Description>Success</Description>
                </Status>
            </GetLoginStatusResult>
        </GetLoginStatusResponse>
    </s:Body>
</s:Envelope>

REST implementation

Content type

application/json; charset="utf-8";

Method

POST

URI

/api/login/status/get

Request

{
  "SessionId": "",
  "Count": "1"
}

Response

{
  "Count": "1",
  "Id": "1",
  "ImageId": "35",
  "Name": "John Doe",
  "OrganizationName": "Contoso Ltd",
  "IsLoggedIn": "True",
  "IdleExpiration": "1200",
  "DateTime": "2023-02-22 07:14:03 UTC",
  "TaskCounter": "0",
  "UsageList": [
    {
      "PresentationInfo": "User"
    },
    {
      "PresentationInfo": "Token"
    },
    {
      "PresentationInfo": "Self",
      "ActivityList": [
        {
          "Method": "GetObject",
          "Type": "User",
          "Id": "21"
        }
      ]
    },
    {
      "PresentationInfo": "AuditLog"
    }
  ],
  "OrganizationList": [
    {
      "Id": "9",
      "PresentationInfo": "Pointsharp AB",
      "AdditionalInfo": "Style=black,#000000,#FFFFFF,#999999;#232C2E;#D21041;#FFFFFF",
      "ActivityList": [
        {
          "Method": "CreateTask",
          "Type": "555",
          "Id": "9"
        }
      ]
    }
  ],
  "Status": {
    "Code": "Success",
    "Description": "Success"
  }
}

Output parameters

Output-Id

The unique id of current user.

Output-ImageId

The unique id of the image of the user.

Output-Name

The name of the user.

Output-OrganizationName

The current name of the organization.

Output-IsLoggedIn

The condition if the user is logged in or not (true/false).

Output-IdleExpiration

An indication when current session of the user will be expired and automatically logged out.

Output-DateTime

Date and time, as UTC, when the user was logged in into the system.

Output-TaskCounter

A numeric counter of available tasks for the user.

Output-UsageList

A list of available main usages that the user has access to. Available types: User, Token, EndEntity, Report, AuditLog, DiagnosticLog, Self and Admin.

Output-UsageList:ActivityList

A list of available activities that can be used.

Method: The method for available call against the API.
Type: The type for the call.
Id: The id of the entity of the call.

In this example: The usage "Self" has an activity that tells the client to get (Method:GetObject) the current user (Type:User) (Id:21) for self administration.

Output-OrganizationList

A list of available organizations for the user to access behalf the home organization of the user.

Id: The id of the organization.
PresentationInfo: Usually the name of the organization depending on configuration.
AdditionalInfo: The style information of the organization for making the client to update the colors and fonts when accessing.

Output-OrganizationList:ActivityList

A list of available activities that can be used.

Method: The method for available call against the API.
Type: The type for the call.
Id: The id of the entity of the call.

In this example: The organization item has an activity that tells the client to create a task (Method:CreateTask) with task type id 555 (Type:555) of the organization (Id:9). This operation will create a predefined task that will switch the organization from the current organization (Contoso Ltd) to another requested organization (Pointsharp AB). Note that the task type id is variable depending on configuration.

Output-Status

The generic status object of the call.