learning-path-info

Availability

Breeze 5; Connect Enterprise Web Services 6

Description

Returns a list of learning paths for a learning object that belongs to a curriculum.

A learning object is any SCO that has been added to a curriculum. A learning path is determined by rules that establish whether a learner can proceed to the next learning object.

You can create a learning path by establishing prerequisite requirements, completion requirements, or preassessment requirements. For example, a learning path might be the rule that the class Welcome to AcmeCo must be completed before Managing Projects at AcmeCo.

A call to learning-path-info lists modules within a curriculum and their paths to each other. To see the complete contents of a curriculum, including content, meetings, and so on, call sco-expanded-contents.

Request URL

http://server_name/api/xml
    ?action=learning-path-info
    &curriculum-id=integer
    &sco-id=integer
    &filter-definition=value
    &sort-definition=value
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`curriculum-id`	Integer	Y	The ID of the curriculum the learning object belongs to.
`sco-id`	Integer	Y	The ID of the curriculum module (course, presentation, or similar) for which you want a learning path.
`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 /> 
    <learning-paths> 
        <learning-path curriculum-id=integer current-sco-id=integer 
                target-sco-id=integer path-type=allowedValue> 
            <name>string</name> 
        </learning-path> 
    </learning-paths> 
</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).
`learning-paths`		Container	Information about learning paths in a curriculum.
	`curriculum-id`	Integer	The numeric ID of the curriculum.
	`current-sco-id`	Integer	The learning object for which you want a path.
	`target-sco-id`	Integer	The ID of the learning object that restricts access to the current learning object (for example, a prerequisite learning object).
	`path-type`	Allowed value	The type of path between the target and current learning objects (for example, whether completion of the target is required as a prerequisite). See path-type for allowed values.
`name`		String	The name of the target learning object.

Sample request

https://example.com/api/xml?action=learning-path-info&sco-id=2006334909
        &curriculum-id=2006298444

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <learning-paths>
        <learning-path curriculum-id="2006298444" current-sco-id="2006298444" 
                target-sco-id="2006298445" path-type="completion-required">
            <name>Security at AcmeCo</name> 
        </learning-path>
    </learning-paths>
</results>