report-my-training

Availability

Connect Enterprise Web Services 6

Description

Returns a list of all courses and curriculums a user or group is enrolled in. If you do not use a principal-id, the list is for the current user. If you add a principal-id, the list is for the principal you specify.

The response contains a list of row elements. In the list, courses have the attributes type=content and icon=course, while curriculums have type=curriculum and icon=curriculum.

Request URL

http://server_name/api/xml
    ?action=report-my-training
    &principal-id=integer
    &filter-definition=value
    &sort-definition=value
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`principal-id`	Integer	N	The unique ID of a user or group whose courses and curriculums you want to list. If you do not specify a value, the response is for the current user.
`filter-definition`	Filter definition	N	A filter to reduce the volume of the response.
`sort-definition`	Sort definition	N	A sort to return results in a certain sequence.
`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-my-training>
        <row sco-id=integer type=allowedValue icon=allowedValue 
                    permission-id=allowedValue>
            <name>string</name> 
            <url>string</url> 
            <date-created>datetime</date-created> 
            <date-modified>datetime</date-modified> 
            <date-begin>datetime</date-begin> 
            <url-path>string</url-path> 
            <expired>boolean</expired> 
            <completed>boolean</completed> 
        </row>
        ...
    </report-my-training>
</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-my-training`		Container	The entire list of courses and curriculums the user is enrolled in.
`row`		Container	Information about one course or curriculum the user is enrolled in.
	`sco-id`	Integer	The unique ID of the course or curriculum.
	`type`	Allowed value	The type of the object (see type for allowed values).
	`icon`	Allowed value	The icon that identifies the object in Connect Enterprise Manager (see icon for allowed values). If `type` is `content`, the `icon` value describes the content.
	`permission-id`	Allowed value	The permission the principal has on the object (see permission-id for allowed values).
`name`		String	The name of the course or curriculum.
`description`		String	The course or curriculum description.
`url`		String	The part of the URL to the course or curriculum that includes the domain name and unique name, without `http://` or `https://`.
`date-created`		Datetime	The date and time the course or curriculum was created.
`date-modified`		Datetime	The date and time the course or curriculum was last modified.
`date-begin`		Datetime	The start date and time of the course or curriculum, either past or future.
`date-end`		Datetime	The end date or time of the course or curriculum, either past or future.
`sco-tag`		String	A non-unique identifier for the course or curriculum as shown in the user interface, for example, ECON101.
`url-path`		String	The unique name of the course or curriculum in its URL.
`expired`		Boolean	A value indicating whether the end date of the course or curriculum has passed (`true` if it has, `false` if not).
`completed`		Boolean	A value indicating whether the user or group has completed the course.

Sample request

https://example.com/api/xml?action=report-my-training
        &principal-id=2006258745

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <report-my-training>
        <row sco-id="2006298431" type="content" icon="course" 
                permission-id="view">
            <name>Intro to Psychology</name> 
            <url>example.com/psychology/</url> 
            <date-created>2006-05-03T10:21:46.810-07:00</date-created> 
            <date-modified>2006-05-03T10:22:30.803-07:00</date-modified> 
            <date-begin>2006-05-03T10:15:00.000-07:00</date-begin> 
            <url-path>/psychology/</url-path> 
            <expired>false</expired> 
            <completed>true</completed> 
        </row>
        <row sco-id="2006745669" type="curriculum" icon="curriculum" 
                permission-id="view">
            <name>A Day in the Life</name> 
            <url>example.com/day/</url> 
            <date-created>2006-06-12T14:47:59.903-07:00</date-created> 
            <date-modified>2006-06-12T14:47:59.903-07:00</date-modified> 
            <date-begin>2006-06-12T14:45:00.000-07:00</date-begin> 
            <url-path>/day/</url-path> 
            <expired>false</expired> 
            <completed>false</completed> 
        </row>
    </report-my-training>
</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_ac18.htm