Availability

Breeze 5

Description

Overrides the score on an item within a curriculum.

For example, you can use user-transcript-update to give a user a score for an external training. This action works only for items within a curriculum, and you need manage permission for the curriculum.

Request URL

 http://server_name/api/xml 
     ?action=user-transcript-update 
     &curriculum-id=integer 
     &sco-id=integer 
     &status=allowedValue 
     &score=integer 
     &principal-id=integer 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

curriculum-id

BIGINT

N

The ID of the curriculum.

sco-id

BIGINT

Y

The unique ID of a SCO with a score you want to override.

status

Allowed value

Y

A value showing the status of the user’s attempt to use this SCO. Allowed values are completed, incomplete, user-passed, user-failed, and not-attempted.

score

Integer

Y

An integer value that represents the score the user has attained on this SCO.

principal-id

BIGINT

Y

The ID of the user whose transcript will be overridden.

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 /> 
 </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).

Sample request

 https://example.com/api/xml?action=user-transcript-update 
     &curriculum-id=2006298444&sco-id=2006298445&status=user-passed 
     &principal-id=2006258745&score=100

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