Export callbacks for LTI tools during Content Migration

[justinball]

We're interested in using the callbacks available during content migration listed in this documentation:

Importing Extended Tool Configurations - Canvas LMS REST API Documentation 

The configuration for setting up callbacks looks like this:

<cartridge_basiclti_link xmlns:blti="http://www.imsglobal.org/xsd/imsbasiclti_v1p0" xmlns:lticm="http://www.imsglobal.org/xsd/imslticm_v1p0" xmlns:lticp="http://www.imsglobal.org/xsd/imslticp_v1p0" xmlns="http://www.imsglobal.org/xsd/imslticc_v1p0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0p1.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd">
  <blti:extensions platform="canvas.instructure.com">
    <lticm:options name="content_migration">
      <lticm:property name="export_start_url">https://example.com/export/</lticm:property>
      <lticm:property name="import_start_url">https://example.com/import/</lticm:property>
    </lticm:options>
  </blti:extensions>
</cartridge_basiclti_link>‍‍‍‍‍‍‍‍

We've done that with our tool. Now we're trying to figure out what the JSON object should look like mentioned in this portion of the documentation:

If any action needs to performed by the tool it MUST respond with a success HTTP status code and the body MUST include two urls, one for checking the progress of the export and one to retrieve the JSON to be returned to the tool upon import. In the event there is nothing to be exported respond with an empty JSON object as the body or a 4xx status code. Any status codes aside from 200 and 201 in responses will be treated as though there is nothing to be returned upon import.

Is there an example of the JSON object that we should respond with?

Thanks!

Justin

[DeletedUser]

Yes, there are two example responses available. The first is in the documentation you linked to in your post, immediately after the section you quoted titled "Example Export Start Response". The second is in the automated testing code we use to ensure this feature is functioning properly in Canvas (canvas-lms/content_migration_service_spec.rb at cea9158bb1d788dd4876fd4283e54ae20f9d6295 · instructu... ).

[christensen_cor]

That portion seems to be in the documentation, but what about the JSON object for that fetch_url?

 and one to retrieve the JSON to be returned to the tool upon import.

[DeletedUser]

Oh, I can see where that's not really clear. The response from the fetch_url should be whatever JSON your tool needs to complete a course copy when Canvas starts the import process, the only expectation from Canvas is that it is valid JSON because we do process it a bit to inject assignment ids if you need them.

As an example, the tool I was working on in conjunction with putting this together returns the following:

{ 
    "export_id": "bf508c5a-fb61-4910-8ef3-862966967060", 
    "assignments": [ 
        {"opaque_id": "cc102111-fc68-4fa6-8531-42ea35aea040", "$canvas_assignment_id": 42} 
    ] 
}‍
‍‍‍‍‍‍

Our requirements were that we keep most of the info on the server so we're storing a lot more but, you can send the full content of the assignment if you want (there currently isn't a size limit but we may start enforcing one if it becomes an issue).