Rest Interface Guide

Session management

The session management capabilities of the API allow application developers to manage sessions and includes the following REST calls:

logOn

Function

Log in

Description

This request starts a session.

Type

POST

URL Format

.../sessions/[user name]

Java API

Method Name

Class Name

logOn

com.quark.qpp.service.facadeClass SessionFacade

Parameters

Name

Type

Description

op=logon

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

password=[password]

string

Users password (Mandatory).

asusername=[name]

string

If password is set to the super admin password, you can perform actions as a different user by supplying that user name here. (Optional)

machinename=[name]

string

Lets you pass the name of the computer from which you have logged in. (Optional) If this value is not provided then the machinename is set as localhost for this session.

appname=[name]

string

Lets you pass the name of the application from which you have logged in. (Optional) If this value is not provided then the appname is set as Rest Client for this session.

Returns

Returns a sessionInfo object in XML format. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/sessions/Admin?op=logon&password=Admin

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>   <sessionInfo>
    <sessionId>30609864-6dd2-4eba-9031-c80ef56f3a45</sessionId>
    <userId>1</userId>
    <userName>Admin</userName>
    <timeCreated>2013-04-10T07:32:06Z</timeCreated>
    <lastAccessedTime>2013-04-10T07:32:06Z</lastAccessedTime>
    <machineName>localhost</machineName>
    <applicationName>Rest Client</applicationName>
    <timeZoneOffset>+05:30</timeZoneOffset>
  </sessionInfo>

getSession

Function

Get information about a specific session

Description

This request returns information about a specific session.

Type

GET

URL Format

.../sessions/[session ID]

Java API

Method Name

Class Name

getSession

com.quark.qpp.service.facade Class SessionFacade

Parameters

This request requires no input parameters

Returns

Returns a sessionInfo object in XML format. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/sessions/30609864-6dd2-4eba-9031-c80ef56f3a45

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <sessionInfo>
   <sessionId>30609864-6dd2-4eba-9031-c80ef56f3a45</sessionId>
   <userId>1</userId>
   <userName>Admin</userName>
   <timeCreated>2013-04-10T07:32:06Z</timeCreated>
   <lastAccessedTime>2013-04-10T07:32:06Z</lastAccessedTime>
   <machineName>localhost</machineName>
   <applicationName>Rest Client</applicationName>
   <timeZoneOffset>+05:30</timeZoneOffset>
  </sessionInfo>

getAllSessions

Function

Get all sessions

Description

This request returns a list of all the active sessions.

Type

GET

URL Format

.../sessions

Java API

Method Name

Class Name

getAllSessions

com.quark.qpp.service.facade Class SessionFacade

Parameters

This request requires no input parameters

Returns

Returns a sessionInfoList object containing an array of active sessions in XML format. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/sessions

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <sessionInfoList>
    <sessionInfo>
      <sessionId>e1a89f4c-aa30-488d-9e0e-e067e3431be4</sessionId>
      <userId>1</userId>
      <userName>Admin</userName>
      <timeCreated>2013-04-10T06:11:56Z</timeCreated>
      <lastAccessedTime>2013-04-10T13:02:57+05:30</lastAccessedTime>
      <machineName>0:0:0:0:0:0:0:1</machineName>
      <applicationName>Quark Publishing Platform Web Client</applicationName>
      <timeZoneOffset>+05:30</timeZoneOffset>
    </sessionInfo>
    ....
  </sessionInfoList>

keepSessionAlive

Function

Keep a specific session alive

Description

This request keeps the current session alive. The maximum idle time for a session is 60 seconds, which can be updated in the {qpp_home}/serverApp.properties file.

Type

GET

URL Format

.../sessions/

Java API

Method Name

Class Name

keepSessionAlive

com.quark.qpp.service.facade Class SessionFacade

Parameters

Name

Type

Description

op=keepalive

string

The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id.

Returns

Returns a sessionInfo object in XML format. See the table in the "Request/Response parameter formats" chapter.

Examples

URL:

http://serverName:serverPort/rest/service/sessions?op=keepalive

Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <sessionInfo>
    <sessionId>30609864-6dd2-4eba-9031-c80ef56f3a45</sessionId>
    <userId>1</userId>
    <userName>Admin</userName>
    <timeCreated>2013-04-10T07:32:06Z</timeCreated>
    <lastAccessedTime>2013-04-10T07:32:06Z</lastAccessedTime>
    <machineName>localhost</machineName>
    <applicationName>Rest Client</applicationName>
    <timeZoneOffset>+05:30</timeZoneOffset>
  </sessionInfo>

terminateSession

Function

Delete a session

Description

This request terminates the session with the given sessionID.

Type

POST

URL Format

.../sessions/[session ID]

Java API

Method Name

Class Name

terminateSession

com.quark.qpp.service.facade Class SessionFacade

Parameters

Name

Type

Description

op=delete

string

The op parameter allows you to specify which operation is to be performed. (Mandatory) This operation will run only for a valid session id.

Returns

A status of 200 is returned in response to a successful request execution.

Examples

URL:

http://serverName:serverPort/rest/service/sessions/fee9ea88-68cc-47b9-a576-dab6ad0181eb?op=delete

getMaxIdleTime

Function

Get the maximum idle time for all sessions

Description

This request returns the value for maximum idle time setting for all sessions in seconds. User can update the value for the session.maxIdle property by editing the (qpp_home/conf) serverApp.properties file.

Type

GET

URL Format

.../sessions

Java API

Method Name

Class Name

getMaxIdleTime

com.quark.qpp.service.facade Class SessionFacade

Parameters

Name

Type

Description

op=maxidletime

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

Returns

Returns the maximum idle time set for sessions (for example, 60 seconds (Default)).

Examples

URL:

http://serverName:serverPort/rest/service/sessions?op=maxidletime

Result:

60

validatePassword

Function

Validate a password

Description

This request validates a password for a user.

Type

POST

URL Format

.../sessions/[user name]

Java API

Method Name

Class Name

validatePassword

com.quark.qpp.service.facade Class SessionFacade

Parameters

Name

Type

Description

op=validate

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)

password=[password]

string

Password to be validated. (Mandatory)

Returns

Returns a string value of true or false.

Examples

URL:

http://serverName:serverPort/rest/service/sessions/Admin?op=validate&password=Admin

Result:

True/False

logOff

Function

Log out

Description

This request ends the session that you are currently logged into.

Type

POST

URL Format

.../sessions/[session ID]

Java API

Method Name

Class Name

logOff

com.quark.qpp.service.facade Class SessionFacade

Parameters

Name

Type

Description

op=logoff

string

The op parameter allows you to specify which operation is to be performed. (Mandatory)This operation will run only for a valid session id.

Returns

A status of 200 is returned in response to a successful request execution.

Examples

URL:

http://serverName:serverPort/rest/service/sessions/fee9ea88-68cc-47b9-a576-dab6ad0181eb?op=logoff