Get Session State

Product version: 10.11

Last modified: 31 July 2024

Gets the state of the session. This is used for tenant creation. Refer to Create Tenant.

Endpoint

https://<Director_IP_address>:4443/c/router

Request Example

curl

Copy

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data '{
            "action": "BrandingManagement",
            "method": "getSessionState",
            "data": ["a62608ca-facb-49be-ba44-9cc6907fb05b"],
            "type": "rpc",
            "tid": 1}'

Request Fields

Field	Type	Value(s)	Description
`action`	string	`BrandingManagement`	Action to be used
`method`	string	`getSessionState`	Method to be used
`data`	array	`["a62608ca-facb-49be-ba44-9cc6907fb05b"]`	ID of the queued session
`type`	`string`	`rpc`	Type of communication protocol
`tid`	integer	`1`	Transaction ID. Used to identify the request by both the client and the server

Response Sample

curl

Copy

{
    "action": "BrandingManagement",
    "method": "getSessionState",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
            "imagePath": [null,null,null,null],
            "state": "INITIAL",
            "lastError": null,
            "updated": null}
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
`data`	array	Data of the queued session. See the `data` table below

data

Field	Value	Description
`imagePath`	array	Tenant image upload path
`state`	enum	State of the queued session
`lastError`	string	Last error available for the queued session
`updated`	dateTime	Date and time when the queued session is updated