Availability

Breeze 5

Description

Updates the learning path for a single learning object in a curriculum. A learning object is any SCO that is added to a curriculum.

Request URL

 http://server_name/api/xml 
     ?action=learning-path-update 
     &curriculum-id=integer 
     &current-sco-id=integer 
     &target-sco-id=integer 
     &path-type=allowedValue 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

curriculum-id

BIGINT

Y

The ID of the curriculum to which this learning object belongs.

current-sco-id

BIGINT

N

The ID of the learning object that has the access you want to update.

target-sco-id

BIGINT

N

The ID of the learning object that restricts access to the current learning object (for example, a prerequisite course).

path-type

Allowed value

Y

The type of path between the target learning object and the current learning object (see path-type for allowed values).

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="ok" />  
 </results>

Response values

Element

Attribute

Type

Description

results

Container

Top-level element for the response.

status

Empty, with attributes

The status of the response.

code

Allowed value

A code indicating the response status (see status).

Sample request

 https://example.com/api/xml?action=learning-path-update 
     &curriculum-id=2006298444&current-sco-id=2007064258 
     &target-sco-id=2007035246&path-type=completion-required

Sample response

 <?xml version="1.0" encoding="utf-8" ?> 
 <results> 
     <status code="ok"/> 
 </results>

See also

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy