onlineUserList


URI

<portalStatistics_uri>/user/onlinelist[.<format>]

Supported methods

GET, HEAD

Parent resource

portalStatistics

Child resources

onlineUserCount

Introduction

onlineUserList resource is the list resource about number of iPortal online users. Gets the list of iPortal online users number by sending GET request.

Supported Methods:

Supported output formats: rjson, json, html, xml.

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where supermapiportal is the server name, with rjson being the output format.

http://supermapiportal:8090/iportal/manager/portalstatistics/user/onlinelist.rjson

GET request

Gets the list of iPortal online users number.

Request parameter

If the parameter is not set, returns the online user list information sorted by user name in ascending order by default; After setting the parameter, according to the set parameter to return the online user list information. The request parameter must be included in URI.

Name Type Description
orderBy Orderby Search by sorting field.
orderType OrderType Query by sorting.
currentPage int Page number.
pageSize int Page size.

Response structure

Sending GET request to onlineUserList to return the list information of online user. Consists of following fields:

Field Type Description
content List<IportalUserWithLoginInfo> Page content.
currentPage int The current page number.
pageSize int The page size.
searchParameter SearchParameter The search parameter for the current page.
total int The total record number.
totalPage int The total number of pages.

Response example

The returned rjson format representation after implementing the GET request on the onlineUserList resource http://localhost:8090/iportal/manager/portalstatistics/user/onlinelist.rjson is as follows:

{

    "content": [

        {

            "departmentId": null,

            "departmentNames": null,

            "description": null,

            "elapsedTime": 183883,

            "email": null,

            "isLocked": false,

            "joinTime": 1497430323280,

            "loginCount": 1,

            "loginTime": 1497430333117,

            "name": "admin",

            "nickname": "admin",

            "ownRoles": [

                "ADMIN",

                "SYSTEM"

            ],

            "password": null,

            "passwordLastModified": {

                "date": 14,

                "hours": 16,

                "minutes": 52,

                "month": 5,

                "seconds": 3,

                "time": 1497430323170,

                "year": 117

            },

            "passwordQuestion": null,

            "roles": [

                "ADMIN",

                "SYSTEM"

            ],

            "userGroups": []

        },

        {

            "departmentId": null,

            "departmentNames": null,

            "description": "",

            "elapsedTime": 44920,

            "email": null,

            "isLocked": false,

            "joinTime": 1497430374014,

            "loginCount": 1,

            "loginTime": 1497430472080,

            "name": "user1",

            "nickname": "user1",

            "ownRoles": [

                "PORTAL_USER"

            ],

            "password": null,

            "passwordLastModified": {

                "date": 14,

                "hours": 16,

                "minutes": 52,

                "month": 5,

                "seconds": 53,

                "time": 1497430373922,

                "year": 117

            },

            "passwordQuestion": null,

            "roles": [

                "PORTAL_USER"

            ],

            "userGroups": []

        }

    ],

    "currentPage": 1,

    "pageSize": 10,

    "searchParameter": {

        "currentPage": 1,

        "keywords": null,

        "orderBy": null,

        "orderType": "ASC",

        "pageSize": 10,

        "userNames": [

            "user1",

            "admin"

        ]

    },

    "total": 2,

    "totalPage": 1

}

If you want to get the specified online user list information, such as the login duration is sorted by descending, you need to set orderBy=ELAPSEDTIME, orderType=DESC. eg. Sending GET request to onlineUserList resource http://localhost:8090/iportal/manager/portalstatistics/user/onlinelist.rjson?orderBy=ELAPSEDTIME&orderType=DESC, the returned rjson format representation is as follows:

{

    "content": [

        {

            "departmentId": null,

            "departmentNames": null,

            "description": null,

            "elapsedTime": 395883,

            "email": null,

            "isLocked": false,

            "joinTime": 1497430323280,

            "loginCount": 1,

            "loginTime": 1497430333117,

            "name": "admin",

            "nickname": "admin",

            "ownRoles": [

                "ADMIN",

                "SYSTEM"

            ],

            "password": null,

            "passwordLastModified": {

                "date": 14,

                "hours": 16,

                "minutes": 52,

                "month": 5,

                "seconds": 3,

                "time": 1497430323170,

                "year": 117

            },

            "passwordQuestion": null,

            "roles": [

                "ADMIN",

                "SYSTEM"

            ],

            "userGroups": []

        },

        {

            "departmentId": null,

            "departmentNames": null,

            "description": "",

            "elapsedTime": 256920,

            "email": null,

            "isLocked": false,

            "joinTime": 1497430374014,

            "loginCount": 1,

            "loginTime": 1497430472080,

            "name": "user1",

            "nickname": "user1",

            "ownRoles": [

                "PORTAL_USER"

            ],

            "password": null,

            "passwordLastModified": {

                "date": 14,

                "hours": 16,

                "minutes": 52,

                "month": 5,

                "seconds": 53,

                "time": 1497430373922,

                "year": 117

            },

            "passwordQuestion": null,

            "roles": [

                "PORTAL_USER"

            ],

            "userGroups": []

        }

    ],

    "currentPage": 1,

    "pageSize": 10,

    "searchParameter": {

        "currentPage": 1,

        "keywords": null,

        "orderBy": "ELAPSEDTIME",

        "orderType": "DESC",

        "pageSize": 10,

        "userNames": [

            "user1",

            "admin"

        ]

    },

    "total": 2,

    "totalPage": 1

}

HEAD request

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.

HEAD request can be used to check if the onlineUserList resource exists, or if the onlineUserList resource can be accessed by clients. It can also determine if the onlineUserList resource supports an output format <format> if performed on a URI with <format> included.

See