Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 7, Adobe Connect 8, Adobe Connect 9
Know a user’s progress in a curriculum via API.
Availability
Adobe Connect Enterprise 6
Description
Returns information about a user’s progress in a curriculum.
The response includes a row element for each course in the curriculum, which has information such as access to the course, whether credit was granted, the user’s score, the unique url-path to the course, and so on.
Request URL
http://server_name/api/xml ?action=report-curriculum-taker &user-id=integer &sco-id=integer &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
user-id |
BIGINT |
Y |
The ID of the user whose scores you want to check. |
|
sco-id |
BIGINT |
Y |
The unique ID of the curriculum for which you want a summary. |
|
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 /> <report-curriculum-taker> <sco transcript-id=integer path-type=allowedValue asset-id=integer sco-id=integer depth=integer folder-id=integer type=integer icon=allowedValue lang=allowedValue max-retries=integer source-sco-id=integer source-sco-type=allowedValue status=allowedValue score=integer certificate=integer max-score=integer attempts=integer> <access>allowedValue</access> <credit-granted>boolean</credit-granted> <name>string</name> <url-path>string</url-path> <date-modified>datetime</date-modified> <override>boolean</override> </sco> </report-curriculum-taker> </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). |
|
| report-curriculum-taker | Container |
Information about the user’s performance in the entire curriculum. |
|
| sco | Container |
Information about the user’s work with one course or curriculum. |
|
| transcript-id | BIGINT |
The ID of the user’s transcript for the course or curriculum. |
|
| path-type | Allowed value |
The learning path a user must take before attempting this course or curriculum (see path-type for allowed values). |
|
| asset-id | BIGINT |
The version of the course or curriculum the user attempted to complete. The asset-id is incremented each time the course or curriculum has new content uploaded. |
|
| sco-id | BIGINT |
The unique ID of the course or curriculum. |
|
| depth | Integer |
A course’s level below the curriculum in the navigation hierarchy. For a curriculum, 0; for a course one level below the curriculum, 1. |
|
| folder-id | Integer |
The ID of the folder that contains the course or curriculum. For a course, the ID of a curriculum; for a curriculum, the ID of a user. |
|
| type | Integer |
The type of the course or curriculum (see type for allowed values). |
|
| icon | Allowed value |
The type of icon that identifies the course or curriculum in Adobe Connect Central (see icon for values). |
|
| lang | Allowed value |
The language associated with the course or curriculum (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 the SCO used as a template for the course or curriculum. |
|
| source-sco-type | Integer |
The type of SCO used as a template for the course or curriculum (see type for values). |
|
| status | Allowed value |
The status of the user’s attempt to use the course or curriculum. For courses, allowed values are completed, incomplete, user-passed, user-failed, and not-attempted. For curriculums and folders, allowed values are completed and incomplete. |
|
| score | Integer |
The score the user earned on the course or curriculum. |
|
| certificate | BIGINT |
The ID of the user’s certificate. |
|
| max-score | Integer |
The maximum score possible for the course or curriculum. |
|
| attempts | Integer |
The number of times the user has attempted the course or curriculum. |
|
| access | Allowed value |
The level of access the user has to the course or curriculum (see access for allowed values). |
|
| credit-granted | Boolean |
A value indicating whether credit was granted for the course or curriculum. |
|
| name | String |
The name of the learning object or curriculum. |
|
| url-path | String |
The part of the URL after the domain name that uniquely identifies the object on the server. |
|
| date-modified | Datetime |
The date and time the SCO was last modified, in ISO 8601 format. |
|
| override | Boolean |
A value indicating whether the transcript for the SCO has been adjusted. |
Sample request
https://example.com/api/xml?action=report-curriculum-taker &user-id=2006258748&sco-id=2006298444
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <report-curriculum-taker> <sco transcript-id="2006905613" path-type="prereq-none" asset-id="2006334911" sco-id="2006334909" depth="0" folder-id="2006258747" type="content" icon="producer" lang="en" max-retries="" source-sco-id="" source-sco-type="" status="user-failed" score="0" certificate="" max-score="0" attempts="5"> <access>access-open</access> <credit-granted>false</credit-granted> <name>Test Quiz</name> <url-path>/quiz/</url-path> <date-created>2006-06-30T15:24:34.897-07:00</date-created> <date-modified>2006-05-16T15:22:25.703-07:00</date-modified> <date-taken>2006-06-30T15:24:34.897-07:00</date-taken> <override>false</override> </sco> </report-curriculum-taker> </results>
