Availability

Adobe Connect Pro 7

Description

Returns information about a SCO at a specified URL path. The URL path is the unique identifier after the domain name in the URL to the SCO. For example, if you have a meeting with the custom URL http://example.com/teammeeting, the URL path is /teammeeting. If you pass the full URL path, Connect returns the status code "no data".

Request URL

 http://server_name/api/xml 
     ?action=sco-by-url 
     &url-path=url

Parameters

Name

Required

Description

url-path

Y

The unique identifier after the domain name in the URL to the SCO.

Filters

You cannot filter or sort the response.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue /> 
    <owner-principal type="allowedValue" principal-id="number" account-id="number" has-children="Boolean" is-hidden="Boolean" is-primary="Boolean"> 
        <ext-login></ext-login> 
        <login></login> 
        <name></name> 
        <email></email> 
    </owner-principal> 
-    <sco sco-id="number" account-id="number" display-seq="number" folder-id="number" icon="string" lang="string" max-retries="number" source-sco-id="number" type="allowedValue" version="number"> 
        <url-path></url-path> 
        <date-begin></date-begin> 
        <date-created></date-created> 
        <date-modified></date-modified> 
        <name></name> 
    </sco> 
</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).

owner-principal

 

Container

Contains information about a principal.

 

type

Allowed value

The type of principal (see type for values).

 

principal-id

BIGINT

The ID of the principal.

 

account-id

BIGINT

The ID of the account the principal belongs to.

 

has-children

Boolean

Whether the principal has children. Groups have children and users don’t, so this attribute indicates whether the principal is a group.

 

is-hidden

Boolean

Whether the principal is hidden (true) or not (false) in Connect Central or your application.

 

is-primary

Boolean

Whether the principal is a built-in group (true) or not (false).

ext-login

 

String

The login ID sent from an external network. By default, the same value as login.

login

 

String

The login name of the user who is logged in to the server, often the user’s e-mail address.

name

 

String

The name of the user who is logged in to the server.

e-mail

 

String

The e-mail address of the user who is logged in to the server.

sco  

Container

One object within the folder.

 

sco-id

Integer

The unique ID of an object.

 

account-id

Integer

The unique ID of an account.

 

display-seq

Integer

The sequence in which Adobe Connect Central or your application displays the field.

 

folder-id

Integer

The ID of a folder.

 

icon

Allowed value

The name of the icon that visually identifies this object.

 

lang

String

The language in which information about the SCO is displayed (see lang for values).

 

max-retries

Integer

The maximum number of times a user can retake the course or curriculum. If a user can take the course 3 times, max-retries is 2.

  source-sco-id

BIGINT

The unique ID of a content SCO used in a course or curriculum.

  type

Allowed value

The type of the object (see type for values).

  version

BIGINT

A sequential ID for the session, starting at 1.

url-path  

String

The unique identifier after the domain name in the URL to the SCO.

date-begin  

Datetime

The beginning date of a course or meeting (returned for a course or meeting only).

date-created  

Datetime

The date a course or meeting was created (returned for a course or meeting only).

date-modified  

Datetime

The date the object was last modified.

name  

String

The name of the object on the server.

Sample request

http://example.com/api/xml?action=sco-by-url&url-path=/p18656190/

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code="ok" /> 
    <owner-principal type="content" principal-id="824622254" account-id="824592506" has-children="false" is-hidden="false" is-primary="false"> 
        <ext-login>jdoe@adobe.com</ext-login> 
        <login>jdoe@adobe.com</login> 
        <name>Jane Doe</name> 
        <email>jdoe@adobe.com</email> 
    </owner-principal> 
-    <sco sco-id="825344405" account-id="824592506" display-seq="0" folder-id="824622258" icon="curriculum" lang="en" max-retries="" source-sco-id="" type="curriculum" version="0"> 
        <url-path>/p18656190/</url-path> 
        <date-begin>2009-09-15T13:30:00.000-07:00</date-begin> 
        <date-created>2009-09-15T13:32:45.683-07:00</date-created> 
        <date-modified>2009-09-15T13:32:45.683-07:00</date-modified> 
        <name>Test Curriculum</name> 
    </sco> 
</results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy