Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 9
Fetch basic information about the current user and the Adobe Connect account, including the value of the BREEZESESSION cookie.
Availability
Breeze 4
Description
Returns basic information about the current user and the Adobe Connect server or Adobe Connect hosted account, including the value of the BREEZESESSION cookie.
If you call common-info without logging in, the response does not contain user and account elements, because the server cannot identify a user. However, even without logging in, common-info returns a BREEZESESSION cookie value.
The response also contains host, local-host, and admin-host elements. If Adobe Connect is hosted on a cluster, host is the cluster name; local-host is the name of the server in the cluster that executes the call to common-info; and admin-host is the name of the secure host on a cluster that supports SSL. Your application can use the value of admin-host to convert HTTP URLs to more secure HTTPS URLs.
Request URL
http://server_name/api/xml ?action=common-info &domain=string &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
domain |
String |
N |
A domain name identifying a Adobe Connect hosted account. Use to get information about your hosted account. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
Results cannot be filtered or sorted.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> <common locale=allowedValue time-zone-id=integer> <cookie>string</cookie> <date>datetime</date> <host>url</host> <local-host>hostname</local-host> <admin-host>hostname</admin-host> <url>/api/xml?action=common-info</url> <version>string</version> <account account-id=integer /> <user user-id=integer type="user"> <name>string</name> <login>string</login> </user> <user-agent>string</user-agent> </common> </results>
Response values
Element |
Attribute |
Type |
Description |
|---|---|---|---|
| results | Container |
All results the action returns. |
|
| status | Empty, with attributes |
The status of the response. |
|
| code | Allowed value |
A code indicating the response status (see status). |
|
| common | Container |
Common information about your connection to the server. |
|
| locale | Allowed value |
A setting that defines how Adobe Connect Central or your application displays information to a user (see lang for values). |
|
| time-zone-id | Allowed value |
A code that defines the user’s time zone (see time-zone-id for values). |
|
| cookie | String |
The value of the BREEZESESSION cookie (a string the server returns identifying this user for this login session). |
|
| date | Datetime |
The date and time the call to common-info was made, in ISO 8601 format. |
|
| host | String |
If Adobe Connect runs on a server, the URL of the fully qualified host name of the server. If a cluster, the name that identifies the cluster. |
|
| local-host | String |
The name of the computer that executed the action (on a single server, the same as host; on a cluster, the name of the server that executed the action). |
|
| admin-host | String |
The name of the secure host on a cluster that supports SSL. |
|
| url | String |
The part of the URL making this call that identifies the action name. |
|
| version | String |
The server version name and number. |
|
| account | Empty, with attribute |
Information about the account the user belongs to. Returned if you are logged in to Adobe Connect or are making the call on a Adobe Connect hosted account. |
|
| account-id | BIGINT |
The ID of the account the user belongs to. |
|
| user | Container |
Information about the user who established a session with the server. Returned only if the user making the call is logged in. |
|
| user-id | BIGINT |
The ID of the user who established a session with the server. |
|
| type | Allowed value |
The type of principal who has a session (usually user; see allowed values for principals at type). |
|
| name | String |
The full name of the user who established a session with the server. |
|
| login | String |
The login name of the user who is logged in to the server, often the user’s e-mail address. |
|
| user-agent | String |
The identifier of the web browser or client that established a session with the server. |
Sample request
https://example.com/api/xml?action=common-info
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <common locale="en" time-zone-id="4"> <cookie>breezsi4dundh5srw2fq6</cookie> <date>2006-09-08T11:17:04.470-07:00</date> <host>https:example.com</host> <local-host>localserver17</local-host> <admin-host>securehost.com</admin-host> <url>/api/xml?action=common-info</url> <version>connect_6000</version> <account account-id="624520" /> <user user-id="2006258745" type="user"> <name>Joy Smith</name> <login>joy@acme.com</login> </user> <user-agent>Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)</user-agent> </common> </results>