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

LTI Upload Launch

Functional Overview

These methods cover Basic LTI launch forms for submitting and resubmitting files to Turnitin via a form in the user's browser or can be used to transport the file from the server and return XML.

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.

Upload Launch - Submit File

In order to launch a form to submit a file to Turnitin the form action must point to /api/lti/1p0/upload/submit as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. Contains the User ID of the user making the submission request, may differ from the author.
lis_lineitem_sourceid
//Integer. Contains the Assignment ID of the Turnitin Paper you would like to submit to.
roles
//String. Contains the role type of the person making the submission, can be Learner or Instructor, if Instructor is specified then you must include a student User ID in 'custom_paper_student'.
custom_paper_title
//String. Contains the title for the submission.
custom_paper_data
//File. A file upload form field, this field does not get included in the OAuth signature calculation.
custom_paper_student
//Integer. The ID of the submission author, required if the Role of the user making the submission is Instructor.
custom_xml_response
//Boolean. If set to true the launch response will be XML rather than HTML and will contain the submission ID of the submission.
Optional:
none
//

Outputs

none
//

Error Codes & Text

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

Example Upload Launch - Submit File LTI Request
    <form action="https://sandbox.turnitin.com/api/lti/1p0/upload/submit" method="POST" target="_blank" enctype="multipart/form-data">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="db7a5b8e-e7ce-4303-8d9a-3515fa415f63" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_lineitem_sourcedid" value="12345" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="custom_paper_title" value="Test Submission" type="hidden" />
  <input name="custom_paper_student" value="12345" type="hidden" />
  <input name="custom_xmlresponse" value="" type="hidden" />
  <input name="launch_presentation_css_url" value="" type="hidden" />
  <input name="oauth_nonce" value="79c22b02805572835d82b3769d8857f98721c947" type="hidden" />
  <input name="oauth_timestamp" value="1349448816" 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="bxY56%2BhO9MYZ8IQ7udoBh1Bz09A%3D" type="hidden" />
  <input name="custom_paper_data" type="file" />
  <input type="submit" value="Submit File" />
  </form>

Upload Launch - Submit Text

In order to launch a form to submit text to Turnitin the form action must point to /api/lti/1p0/upload/submit as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. Contains the User ID of the user making the submission request, may differ from the author.
lis_lineitem_sourceid
//Integer. Contains the Assignment ID of the Turnitin Paper you would like to submit to.
roles
//String. Contains the role type of the person making the submission, can be Learner or Instructor, if Instructor is specified then you must include a student User ID in 'custom_paper_student'.
custom_paper_title
//String. Contains the title for the submission.
custom_paper_data
//Text. Max sixe xxx. A text area form field to contain the text submission, this field does not get included in the OAuth signature calculation.
custom_paper_student
//Integer. The ID of the submission author, required if the Role of the user making the submission is Instructor.
custom_xml_response
//Boolean. If set to true the launch response will be XML rather than HTML and will contain the submission ID of the submission.
Optional:
none
//

Outputs

none
//

Error Codes & Text

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

Example Upload Launch - Submit Text LTI Request
  <form action="https://sandbox.turnitin.com/api/lti/1p0/upload/submit" method="POST" target="_blank" enctype="multipart/form-data">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="142343cc-1948-4fa6-8268-53072e9dbaf0" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_lineitem_sourcedid" value="12345" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="custom_paper_title" value="Test Submission" type="hidden" />
  <input name="custom_paper_student" value="12345" type="hidden" />
  <input name="custom_xmlresponse" value="" type="hidden" />
  <input name="launch_presentation_css_url" value="" type="hidden" />
  <input name="oauth_nonce" value="f521544c836e43e181012281b121d2392a2842d1" type="hidden" />
  <input name="oauth_timestamp" value="1349448816" 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="eiBIQ3ubZgKUm8aUCKkZ6w4gD%2Fc%3D" type="hidden" />
  <textarea name="custom_paper_data"></textarea>
  <input type="submit" value="Submit File" />
  </form>

Upload Launch - Resubmit File

In order to launch a form to resubmit a file to Turnitin the form action must point to /api/lti/1p0/upload/resubmit as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. Contains the User ID of the user making the submission request, may differ from the author.
lis_lineitem_sourceid
//Integer. Contains the Assignment ID of the Turnitin Paper you would like to submit to.
roles
//String. Contains the role type of the person making the submission, can be Learner or Instructor, if Instructor is specified then you must include a student User ID in 'custom_paper_student'.
custom_paper_title
//String. Contains the title for the submission.
custom_paper_data
//File. Max sixe xxx. A file upload form field, this field does not get included in the OAuth signature calculation.
custom_paper_student
//Integer. The ID of the submission author, required if the Role of the user making the submission is Instructor.
custom_xml_response
//Boolean. If set to true the launch response will be XML rather than HTML and will contain the submission ID of the submission.
Optional:
none
//

Outputs

none
//

Error Codes & Text

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

Example Upload Launch - Resubmit File LTI Request
  <form action="https://sandbox.turnitin.com/api/lti/1p0/upload/resubmit" method="POST" target="_blank" enctype="multipart/form-data">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="6a730f9d-a4bb-4861-b743-32dc0fa6b9d5" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_result_sourcedid" value="12345" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="custom_paper_title" value="Test Submission" type="hidden" />
  <input name="custom_paper_student" value="12345" type="hidden" />
  <input name="custom_xmlresponse" value="" type="hidden" />
  <input name="launch_presentation_css_url" value="" type="hidden" />
  <input name="oauth_nonce" value="d3481159cd856131d591a3793bd1e88290cb7d99" type="hidden" />
  <input name="oauth_timestamp" value="1349448816" 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="L8RBbxCbq5JB49kIT0INXlZgKB8%3D" type="hidden" />
  <input name="custom_paper_data" type="file" />
  <input type="submit" value="Submit File" />
  </form>

Upload Launch - Resubmit Text

In order to launch a form to resubmit a file to Turnitin the form action must point to /api/lti/1p0/upload/resubmit as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. Contains the User ID of the user making the submission request, may differ from the author.
lis_lineitem_sourceid
//Integer. Contains the Assignment ID of the Turnitin Paper you would like to submit to.
roles
//String. Contains the role type of the person making the submission, can be Learner or Instructor, if Instructor is specified then you must include a student User ID in 'custom_paper_student'.
custom_paper_title
//String. Contains the title for the submission.
custom_paper_data
//Text. Max sixe xxx. A text area form field to contain the text submission, this field does not get included in the OAuth signature calculation.
custom_paper_student
//Integer. The ID of the submission author, required if the Role of the user making the submission is Instructor.
custom_xml_response
//Boolean. If set to true the launch response will be XML rather than HTML and will contain the submission ID of the submission.
Optional:
none
//

Outputs

none
//

Error Codes & Text

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

Example Upload Launch - Resubmit Text LTI Request
  <form action="https://sandbox.turnitin.com/api/lti/1p0/upload/resubmit" method="POST" target="_blank" enctype="multipart/form-data">
  <input name="lti_version" value="LTI-1p0" type="hidden" />
  <input name="resource_link_id" value="20aa18cb-fe4b-49da-8cc1-677f43afd1b7" type="hidden" />
  <input name="lis_person_sourcedid" value="56789" type="hidden" />
  <input name="lis_result_sourcedid" value="12345" type="hidden" />
  <input name="roles" value="Instructor" type="hidden" />
  <input name="custom_source" value="16" type="hidden" />
  <input name="custom_paper_title" value="Test Submission" type="hidden" />
  <input name="custom_paper_student" value="12345" type="hidden" />
  <input name="custom_xmlresponse" value="" type="hidden" />
  <input name="launch_presentation_css_url" value="" type="hidden" />
  <input name="oauth_nonce" value="b4532150ab041baf2b8f420925e8cda7020f7380" type="hidden" />
  <input name="oauth_timestamp" value="1349448816" 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="i4Fd3jkxKlxUR5bfQDbbo%2BPXqUY%3D" type="hidden" />
  <textarea name="custom_paper_data"></textarea>
  <input type="submit" value="Submit File" />
  </form>