Document ltiLaunchUrl as a possible resultData node
Currently, there is no documentation that shows how to pass an LTI launch url via grade passback. This update adds that documentation. Test plan: 1) run localhost Canvas 2) build the API docs (docker-compose run --rm web bundle exec rake doc:api) 3) navigate to the following: <your host url>/doc/api/file.assignment_tools.html 4) check for spelling, grammar, accuracy of information and that the new link works Fixes PLAT-2066 Change-Id: I028ff980e91348e0e8aa389e80fe9dac94be9df9 Reviewed-on: https://gerrit.instructure.com/99392 Reviewed-by: Andrew Butterfield <abutterfield@instructure.com> Tested-by: Jenkins QA-Review: August Thornton <august@instructure.com> Product-Review: Jesse Poulos <jpoulos@instructure.com>
This commit is contained in:
parent
e4b5d34101
commit
81ce3822ec
|
@ -106,6 +106,40 @@ Add a `resultData` node with a `url` node within it like this:
|
|||
</imsx_POXEnvelopeRequest>
|
||||
```
|
||||
|
||||
#### LTI Launch URL
|
||||
|
||||
Add a `resultData` node with a `ltiLaunchUrl` node like this:
|
||||
|
||||
```xml
|
||||
<?xml version = "1.0" encoding = "UTF-8"?>
|
||||
<imsx_POXEnvelopeRequest xmlns="http://www.imsglobal.org/services/ltiv1p1/xsd/imsoms_v1p0">
|
||||
<imsx_POXHeader>
|
||||
<imsx_POXRequestHeaderInfo>
|
||||
<imsx_version>V1.0</imsx_version>
|
||||
<imsx_messageIdentifier>999999123</imsx_messageIdentifier>
|
||||
</imsx_POXRequestHeaderInfo>
|
||||
</imsx_POXHeader>
|
||||
<imsx_POXBody>
|
||||
<replaceResultRequest>
|
||||
<resultRecord>
|
||||
<sourcedGUID>
|
||||
<sourcedId>3124567</sourcedId>
|
||||
</sourcedGUID>
|
||||
<result>
|
||||
<resultScore>
|
||||
<language>en</language>
|
||||
<textString>0.92</textString>
|
||||
</resultScore>
|
||||
<!-- Added element -->
|
||||
<resultData>
|
||||
<ltiLaunchUrl>https://some.launch.url/launch?lti_submission_id=42</ltiLaunchUrl>
|
||||
</resultData>
|
||||
</result>
|
||||
</resultRecord>
|
||||
</replaceResultRequest>
|
||||
</imsx_POXBody>
|
||||
</imsx_POXEnvelopeRequest>
|
||||
```
|
||||
|
||||
## Total Score Return Extension
|
||||
|
||||
|
|
Loading…
Reference in New Issue