sco-shortcuts

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Provides information about the folders relevant to the current user. These include a folder for the user's current meetings, a folder for the user's content, as well as folders above them in the navigation hierarchy.

To determine the URL of a SCO, concatenate the url-path returned by sco-info, sco-contents, or sco-expanded-contents with the domain-name returned by sco-shortcuts. For example, you can concatenate these two strings:

http://test.server.com (the domain-name returned by sco-shortcuts)
/f2006123456/ (the url-path returned by sco-info, sco-contents, or sco-expanded-contents)

The result is this URL:

http://test.server.com/f2006123456/

You can also call sco-contents with the sco-id of a folder returned by sco-shortcuts to see the contents of the folder.

Request URL

http://server_name/api/xml
    ?action=sco-shortcuts
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`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=code /> 
    <shortcuts> 
        <sco tree-id=integer sco-id=integer type=allowedValue> 
            <domain-name>string</domain-name> 
        </sco>
        ...
    </shortcuts>
</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).
`shortcuts`		Container	Information about all of the folders that relate to the current user.
`sco`		Container	Information about one of the current user's folders.
	`tree-id`	Integer	The ID of the navigation tree that contains the folder. Several folders might have the same `tree-id`.
	`sco-id`	Integer	The unique ID of the folder.
	`type`	Allowed value	The type of the folder. Allowed values are shown in the following table.
`domain-name`		String	The domain name of the folder.

The values that can be returned in the type attribute of the sco element (for this call only, sco-shortcuts) identify Connect Enterprise folders. Each folder type maps to a folder in Adobe Connect Enterprise Manager and requires certain permission levels to access, described in the following table.

Value of type	Description
`account-custom`	Customized content for an account, such as a customized login page, banner, and so on.
`content`	The Shared Content folder. Requires Administrator privilege or Manage permission.
`courses`	The Shared Training folder. Requires Administrator privilege or Manage permission.
`events`	The Shared Events folder. Requires Administrator privilege or Manage permission.
`meetings`	The Shared Meetings folder. Requires Administrator privilege or Manage permission.
`my-courses`	The My Training folder. By default, the individual user has Manage permission.
`my-content`	The My Content folder. By default, the individual user has Manage permission.
`my-events`	The My Events folder. By default, the individual user has Manage permission.
`my-meetings`	The My Meetings folder. By default, the individual user has Manage permission.
`my-meeting-templates`	The My Templates folder. By default, the individual user has Manage permission.
`seminars`	The Shared Seminars folder. Requires Administrator privilege or Manage permission.
`shared-meeting-templates`	The Shared Templates folder. Inherits permissions from Shared Meetings.
`user-content`	Contain the user content folders.
`user-courses`	Contain the user courses folders.
`user-events`	Contain the user events folders.
`user-meetings`	Contain the user meeting folders.

Sample request

http://example.com/api/xml?action=sco-shortcuts

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <shortcuts>
        <sco tree-id="4930295" sco-id="2006258748" type="my-courses">
            <domain-name>http://example.com</domain-name> 
        </sco>
        <sco tree-id="4930293" sco-id="2006258749" type="my-events">
            <domain-name>http://example.com</domain-name> 
          </sco>
            ...
    </shortcuts>
</results>