report-user-trainings-taken

Availability

Connect Enterprise Web Services 6

Description

Returns a list of all courses and curriculums a user has taken, whether or not the user has completed the training. Each course or curriculum is returned in a separate row element and has the most recent transcript of the user's scores.

Request URL

http://server_name/api/xml
    ?action=report-user-trainings-taken
    &principal-id=integer
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`principal-id`	Integer	Y	The ID of a user for whom you want a list of trainings.
`session`	String	N	The value of the `BREEZESESSION` cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

You can filter or sort the response on any element or attribute it contains.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code=allowedValue /> 
    <report-user-trainings-taken>
        <row transcript-id=integer max-retries=integer sco-id=integer
                    type=allowedValue icon=allowedValue status=allowedValue
                    certificate=integer score=integer permission-id=allowedValue
                    attempts=allowedValue>
            <name>string</name> 
            <description>string</description> 
            <url-path>string</url-path> 
            <date-taken>datetime</date-taken> 
            <from-curriculum>boolean</from-curriculum> 
        </row>
        ...
    </report-user-trainings-taken>
</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).
	`type`	Allowed value	The type of the SCO. Allowed values are `user-content`, `content`, and `my-content`.
`report-user-trainings-taken`		Container	A list of all trainings the user has attempted.
`row`		Container	Information about one course or curriculum the user has taken, whether or not passed.
	`transcript-id`	Integer	The ID of the record of the user's most recent score on this training.
	`max-retries`	Integer	The maximum number of times the user can repeat the training.
	`sco-id`	Integer	The ID of the training SCO.
	`type`	Allowed value	The type of the training SCO (see allowed values at type).
	`icon`	Allowed value	The type of icon that identifies the course or curriculum in Enterprise Manager. Provides information about the course or curriculum in addition to its `type` (see allowed values at icon).
	`status`	Allowed value	The status of the user's work with the SCO. Allowed values for a course or presentation are `user-passed`, `user-failed`, `completed`, `incomplete`, `not-attempted`, and `review`. A curriculum or folder can only be `completed` or `incomplete`.
	`certificate`	Integer	The ID of the record that shows the user passed or completed the training.
	`score`	Integer	The score the user earned on the most recent attempt at the training.
	`permission-id`	Allowed value	The permission the user has been assigned to access the course or curriculum (see permission-id for allowed values).
	`attempts`	Integer	The number of attempts the user has made at this training.
`name`		String	The name of the training SCO.
`description`		String	The description of the training SCO.
`url-path`		String	The unique identifier of the SCO that appears in its URL after the domain name.
`date-taken`		Datetime	The date the user interacted with the training SCO (viewed a presentation, took a quiz, and so on).
`from-curriculum`		Boolean	A value indicating whether this course was taken as part of a curriculum.

Sample request

https://example.com/api/xml?action=report-user-trainings-taken
        &principal-id=2006258745&principal-id=4797406

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <report-user-trainings-taken>
        <row transcript-id="2006745722" max-retries="" sco-id="2006745673"
                    type="content" icon="course" status="user-passed"
                    certificate="2006745722" score="0" permission-id=""
                    attempts="1">
            <name>All About Web Communities</name> 
            <description>test</description> 
            <url-path>/p33096345/</url-path> 
            <date-taken>2006-06-12T15:06:02.947-07:00</date-taken> 
            <from-curriculum>false</from-curriculum> 
        </row>
        ...
    </report-user-trainings-taken>
</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/04c_act8.htm