report-course-status

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Returns summary information about a course, including the number of users who have passed, failed, and completed the course, as well as the current number of enrollees. The request requires the sco-id of a course.

Connect Enterprise Manager uses this call to display Course Status in the Summary report. This report is available at Training > Shared Training > [course name] > Reports > Summary.

Request URL

http://server_name/api/xml
    ?action=report-course-status
    &sco-id=integer
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`sco-id`	Integer	Y	The unique ID of the course for which you want summary information.
`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-course-status total-course-completions=integer 
                    total-unique-course-completions=integer num-passed=integer 
                    num-failed=integer num-enrollees=integer /> 
            <date-last-taken>datetime</date-last-taken>
        </report-course-status>
</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-course-status`		Container	Summary information about a course.
	`total-course-completions`	Integer	The total number of times users have completed the course, including passing scores, failing scores, and multiple attempts by the same user.
	`total-unique-course-completions`	Integer	The number of distinct users who have completed the course, including passing and failing scores but not multiple attempts by the same user.
	`num-completed`	Integer	The number of users who have completed the course, for courses that do not have a passing score.
	`num-passed`	Integer	The number of users who have passed the course, for courses that have a passing score.
	`num-failed`	Integer	The number of users who have failed the course, for courses that have a passing score.
	`num-enrollees`	Integer	The number of users presently enrolled in the course.
`date-last-taken`		Datetime	The last time any user attempted the course but was not in server-side review mode.

Sample request

https://example.com/api/xml?action=report-course-status&sco-id=123456

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <report-course-status total-course-completions="1" 
            total-unique-course-completions="1" num-completed="0" 
            num-passed="1" num-failed="0" num-enrollees="4">
        <date-last-taken>2006-10-10T13:55:24.480-07:00</date-last-taken> 
    </report-course-status>
</results>

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/04b_act9.htm