This API is under construction. Some of the details documented here may change.

LTI Download Paper

Functional Overview

These functions may be used to download documents and GradeMark information from Turnitin.

Download launches require form fields for a lis_result_sourcedid (paper id), a lis_person_sourcedid (user id) and roles (only the first role will be respected in the Turnitin Basic LTI profile) which can be either Learner (student) or Instructor. There are also download launches for bulk download calls, on these launches you specify the lis_lineitem_sourcedid (assignment id) for the assignment.

Along with the resource / user identifiers you must include the required oauth parameters. The OAuth parameters are used to sign the request and authenticate the call and a custom_source field to identify the API product the call is being made to.

For each Turnitin resource there is a launch url that the action of the form must point to.

The Turnitin resource launch calls are based on the IMS Basic LTI 1.0 standard.

Download Launch - Original File

In order to launch download a student paper in it's original file format the form action must point to /api/lti/1p0/download/orig as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. max size xxx. Contains the User ID of the user making the request.
lis_result_sourcedid
//Integer. max size xxx. Contains the Submission ID of the paper to download.
role
//String. max size xxx. Contains the role type of the person requesting the messages window.
Optional:
none
//

Outputs

none
//

Error Codes & Text

CodeText
XXX "description"
XXX "description"
XXX "description"

Example Download Launch - Original File LTI Request
<form action="https://sandbox.turnitin.com/api/lti/1p0/download/orig" method="POST" target="_blank" enctype="application/x-www-form-urlencoded">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="5959ad64-b00c-4fc1-b8f6-a400dce8831c" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_result_sourcedid" value="1234" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="oauth_nonce" value="c6740c14c346f0b397370dc351698d8954274ad3" type="hidden" />
  <input name="oauth_timestamp" value="1349452029" type="hidden" />
  <input name="oauth_consumer_key" value="1234" type="hidden" />
  <input name="oauth_signature_method" value="HMAC-SHA1" type="hidden" />
  <input name="oauth_version" value="1.0" type="hidden" />
  <input name="oauth_signature" value="l9jX%2BuJEjwrgdd%2FNlJVyJ3Iilcs%3D" type="hidden" />
  <input type="submit" value="Download Original Submission File" />
  </form>

Download Launch - PDF File

In order to launch download a student paper in PDF format the form action must point to /api/lti/1p0/download/pdf as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. max size xxx. Contains the User ID of the user making the request.
lis_result_sourcedid
//Integer. max size xxx. Contains the Submission ID of the paper to download.
role
//String. max size xxx. Contains the role type of the person requesting the messages window.
Optional:
none
//

Outputs

none
//

Error Codes & Text

CodeText
XXX "description"
XXX "description"
XXX "description"

Example Download Launch - PDF File LTI Request
  <form action="https://sandbox.turnitin.com/api/lti/1p0/download/pdf" method="POST" target="_blank" enctype="application/x-www-form-urlencoded">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="df0cbd24-3379-4f51-9cfd-bd95bdd8462b" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_result_sourcedid" value="1234" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="oauth_nonce" value="101e5ab3a0b1faffa922788812ee27e2fbe6f5a3" type="hidden" />
  <input name="oauth_timestamp" value="1349452029" type="hidden" />
  <input name="oauth_consumer_key" value="1234" type="hidden" />
  <input name="oauth_signature_method" value="HMAC-SHA1" type="hidden" />
  <input name="oauth_version" value="1.0" type="hidden" />
  <input name="oauth_signature" value="pEA2AoVecakEt%2BgtkZZLj2F0lOc%3D" type="hidden" />
  <input type="submit" value="Download Default PDF" />
  </form>

Download Launch - PDF GradeMark File

In order to launch download a student paper in PDF format with GradeMark Markup information in the file the form action must point to /api/lti/1p0/download/grademark as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. max size xxx. Contains the User ID of the user making the request.
lis_result_sourcedid
//Integer. max size xxx. Contains the Submission ID of the paper to download.
role
//String. max size xxx. Contains the role type of the person requesting the messages window.
Optional:
none
//

Outputs

none
//

Error Codes & Text

CodeText
XXX "description"
XXX "description"
XXX "description"

Example Download Launch - PDF GradeMark File LTI Request
  <form action="https://sandbox.turnitin.com/api/lti/1p0/download/grademark" method="POST" target="_blank" enctype="application/x-www-form-urlencoded">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="4f87e3fb-8822-432c-b6da-75796e0a7f6b" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_result_sourcedid" value="1234" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="oauth_nonce" value="af2feb3e8cc297e4e1d1baf4766f882b677a9ee9" type="hidden" />
  <input name="oauth_timestamp" value="1349452029" type="hidden" />
  <input name="oauth_consumer_key" value="1234" type="hidden" />
  <input name="oauth_signature_method" value="HMAC-SHA1" type="hidden" />
  <input name="oauth_version" value="1.0" type="hidden" />
  <input name="oauth_signature" value="1%2BOLJorS7NAFP5qauOjpSPYhBZ4%3D" type="hidden" />
  <input type="submit" value="Download GradeMark PDF" />
  </form>

Download Launch - ZIP Original Files

In order to launch download a zip file of the original submitted files, the form action must point to /api/lti/1p0/download/origzip as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. max size xxx. Contains the User ID of the user making the request.
lis_lineitem_sourcedid
//Integer. max size xxx. Contains the Assignment ID of the papers to download.
role
//String. max size xxx. Contains the role type of the person requesting the messages window.
Optional:
none
//

Outputs

none
//

Error Codes & Text

CodeText
XXX "description"
XXX "description"
XXX "description"

Example Download Launch - ZIP Original Files LTI Request
  <form action="https://sandbox.turnitin.com/api/lti/1p0/download/origzip" method="POST" target="_blank" enctype="application/x-www-form-urlencoded">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="f744d868-8403-4261-92de-1e3689b1d405" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_lineitem_sourcedid" value="1234" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="oauth_nonce" value="c67fb06b026598d1062e32fc95448673047df104" type="hidden" />
  <input name="oauth_timestamp" value="1349452029" type="hidden" />
  <input name="oauth_consumer_key" value="1234" type="hidden" />
  <input name="oauth_signature_method" value="HMAC-SHA1" type="hidden" />
  <input name="oauth_version" value="1.0" type="hidden" />
  <input name="oauth_signature" value="RBBitk6yyfRatfTbERQtZq76xEk%3D" type="hidden" />
  <input type="submit" value="Download Original File Zip" />
  </form>

Download Launch - ZIP GradeMark Files

In order to launch download a zip file of the GradeMark PDF files, the form action must point to /api/lti/1p0/download/gradezip as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. max size xxx. Contains the User ID of the user making the request.
lis_lineitem_sourcedid
//Integer. max size xxx. Contains the Assignment ID of the papers to download.
role
//String. max size xxx. Contains the role type of the person requesting the messages window.
Optional:
none
//

Outputs

none
//

Error Codes & Text

CodeText
XXX "description"
XXX "description"
XXX "description"

Example Download Launch - ZIP GradeMark Files LTI Request
   <form action="https://sandbox.turnitin.com/api/lti/1p0/download/gradezip" method="POST" target="_blank" enctype="application/x-www-form-urlencoded">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="fcaf3e54-3fae-45de-9437-8a7f871755c4" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_lineitem_sourcedid" value="1234" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="oauth_nonce" value="ddeb0a7894dbecfcc5f20b9abd041948e0dd2db8" type="hidden" />
  <input name="oauth_timestamp" value="1349452029" type="hidden" />
  <input name="oauth_consumer_key" value="1234" type="hidden" />
  <input name="oauth_signature_method" value="HMAC-SHA1" type="hidden" />
  <input name="oauth_version" value="1.0" type="hidden" />
  <input name="oauth_signature" value="2FeD8Z8HtoSaUxC8qKoveZeJ47s%3D" type="hidden" />
  <input type="submit" value="Bulk Download GradeMark PDFs" />
  </form>

Download Launch - XLS Spreadsheet Report File

In order to launch download an XLS spreadsheet file containing data about the submissions in the inbox, the form action must point to /api/lti/1p0/download/xls as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. max size xxx. Contains the User ID of the user making the request.
lis_lineitem_sourcedid
//Integer. max size xxx. Contains the Assignment ID of the papers to download.
role
//String. max size xxx. Contains the role type of the person requesting the messages window.
Optional:
none
//

Outputs

none
//

Error Codes & Text

CodeText
XXX "description"
XXX "description"
XXX "description"

Example Download Launch - XLS Spreadsheet Report File LTI Request
  <form action="https://sandbox.turnitin.com/api/lti/1p0/download/xls" method="POST" target="_blank" enctype="application/x-www-form-urlencoded">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="6b9e7667-f1e3-4f55-bdf2-a5df2f82e892" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_lineitem_sourcedid" value="1234" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="oauth_nonce" value="8d6d2c8c56f4c86957f74de760e0acd9ccc17c97" type="hidden" />
  <input name="oauth_timestamp" value="1349452029" type="hidden" />
  <input name="oauth_consumer_key" value="1234" type="hidden" />
  <input name="oauth_signature_method" value="HMAC-SHA1" type="hidden" />
  <input name="oauth_version" value="1.0" type="hidden" />
  <input name="oauth_signature" value="k2JJ%2BebzetbQ0U8LgIOJ%2FRkVbTU%3D" type="hidden" />
  <input type="submit" value="Download XLS Submission Report" />
  </form>