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

LTI Document Viewer Launch

Functional Overview

These methods describe Basic LTI launch forms for opening the Turnitin Document Viewer. The Turnitin Document viewer provides access to Originality Reports and GradeMark.

Document Viewer 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.

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.

DV Launch - Originality Report

In order to launch the DV with the Originality Report active the form action must point to /api/lti/1p0/dv/report as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. Contains the User ID of the user making the request, may differ from the author.
lis_lineitem_sourceid
//Integer. Contains the Assignment ID the Turnitin Paper was submitted to.
lis_result_sourceid
//Integer. Contains the ID of the result desired for launch.
roles
//String. Contains the role type of the person making the submission, can be Learner or Instructor.
Optional:
none
//

Outputs

none
//

Error Codes & Text

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

Example DV Launch - Originality Report LTI Request
   <form action="https://www.turnitin.com/api/lti/1p0/dv/report" method="POST">
  <input type="hidden" name="lis_person_sourcedid" value="9509556" />
  <input type="hidden" name="lis_result_sourcedid" value="49313814" />
  <input type="hidden" name="roles" value="Instructor" />
  <input type="hidden" name="resource_link_id" value="e42d0f84-f2f0-409b-8114-4df7b2ab2f17" />
  <input type="hidden" name="lti_version" value="LTI-1p0" />
  <input type="hidden" name="custom_source" value="12" />
  <input type="hidden" name="oauth_nonce" value="11a6733f0d5f54a77002929836d562be92e2b756" />
  <input type="hidden" name="oauth_timestamp" value="1338295948" />
  <input type="hidden" name="oauth_consumer_key" value="49201" />
  <input type="hidden" name="oauth_signature_method" value="HMAC-SHA1" />
  <input type="hidden" name="oauth_version" value="1.0" />
  <input type="hidden" name="oauth_signature" value="5qi7aSp%2F%2BjnEXHXLp5J7ZTsiIO8%3D" />
  <input type="submit" value="Submit" />
</form>
  
none
Response

DV Launch - GradeMark

In order to launch the DV with Grade Mark active the form action must point to /api/lti/1p0/dv/grademark as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. Contains the User ID of the user making the request, may differ from the author.
lis_lineitem_sourceid
//Integer. Contains the Assignment ID the Turnitin Paper was submitted to.
lis_result_sourceid
//Integer. Contains the Result ID of the launch desired.
roles
//String. Contains the role type of the person making the submission, can be Learner or Instructor.
Optional:
none
//

Outputs

none
//

Error Codes & Text

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

Example DV Launch - Grade Mark LTI Request
  <form action="https://www.turnitin.com/api/lti/1p0/dv/grademark" method="POST">
    <input type="hidden" name="lis_person_sourcedid" value="9509556" />
    <input type="hidden" name="lis_result_sourcedid" value="49313814" />
    <input type="hidden" name="roles" value="Instructor" />
    <input type="hidden" name="resource_link_id" value="5e8054df-c1df-4e42-96d8-8322f6efda92" />
    <input type="hidden" name="lti_version" value="LTI-1p0" />
    <input type="hidden" name="custom_source" value="12" />
    <input type="hidden" name="oauth_nonce" value="11877afe202aecbc0ce650bf1c8b38baf2b22a90" />
    <input type="hidden" name="oauth_timestamp" value="1338295948" />
    <input type="hidden" name="oauth_consumer_key" value="49201" />
    <input type="hidden" name="oauth_signature_method" value="HMAC-SHA1" />
    <input type="hidden" name="oauth_version" value="1.0" />
    <input type="hidden" name="oauth_signature" value="WWQPPn9gHcXZ0Cza8CIxywOvmLk%3D" />
    <input type="submit" value="Submit" />
  </form>
Response
none

DV Launch - PeerMark

In order to launch the DV with Peer Mark active the form action must point to /api/lti/1p0/dv/peermark as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. Contains the User ID of the user making the request, may differ from the author.
lis_lineitem_sourceid
//Integer. Contains the Assignment IDthe Turnitin Paper was submitted to.
lis_result_sourceid
//Integer. Contains the result ID of the launch desired
roles
//String. Contains the role type of the person making the submission, can be Learner or Instructor.
Optional:
none
//

Outputs

none
//

Error Codes & Text

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

Example DV Launch - Peer Mark LTI Request
  <form action="https://www.turnitin.com/api/lti/1p0/dv/peermark" method="POST">
    <input type="hidden" name="lis_person_sourcedid" value="9509556" />
    <input type="hidden" name="lis_result_sourcedid" value="49313814" />
    <input type="hidden" name="roles" value="Instructor" />
    <input type="hidden" name="resource_link_id" value="66a77540-e996-401a-8518-0726c14c13d0" />
    <input type="hidden" name="lti_version" value="LTI-1p0" />
    <input type="hidden" name="custom_source" value="12" />
    <input type="hidden" name="oauth_nonce" value="a7abb5557272ab32e07ffb2937064c09695d76ff" />
    <input type="hidden" name="oauth_timestamp" value="1338295948" />
    <input type="hidden" name="oauth_consumer_key" value="49201" />
    <input type="hidden" name="oauth_signature_method" value="HMAC-SHA1" />
    <input type="hidden" name="oauth_version" value="1.0" />
    <input type="hidden" name="oauth_signature" value="NSzKCgCCBBHcH18DTUoMvdv6tp0%3D" />
    <input type="submit" value="Submit" />
  </form>
Response
none

DV Launch - No Service

In order to launch the DV with no active service the form action must point to /api/lti/1p0/dv as in the example below.

Parameters

Required:
lis_person_sourcedid
//Integer. Contains the User ID of the user making the request, may differ from the author.
lis_lineitem_sourceid
//Integer. Contains the Assignment ID the Turnitin Paper was to submitted to.
lis_result_sourceid
//Integer. Contains the result ID of the desired launch
roles
//String. Contains the role type of the person making the submission, can be Learner or Instructor.
Optional:
none
//

Outputs

none
//

Error Codes & Text

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

Example DV Launch - No Service LTI Request
   <form action="https://www.turnitin.com/api/lti/1p0/dv" method="POST">
    <input type="hidden" name="lis_person_sourcedid" value="9509556" />
    <input type="hidden" name="lis_result_sourcedid" value="49313814" />
    <input type="hidden" name="roles" value="Instructor" />
    <input type="hidden" name="resource_link_id" value="c05a62ab-cbfc-4312-9423-a3a6790a3d47" />
    <input type="hidden" name="lti_version" value="LTI-1p0" />
    <input type="hidden" name="custom_source" value="12" />
    <input type="hidden" name="oauth_nonce" value="5fd69c138ab137ae5d4529adbc15dcfe346a9d47" />
    <input type="hidden" name="oauth_timestamp" value="1338295948" />
    <input type="hidden" name="oauth_consumer_key" value="49201" />
    <input type="hidden" name="oauth_signature_method" value="HMAC-SHA1" />
    <input type="hidden" name="oauth_version" value="1.0" />
    <input type="hidden" name="oauth_signature" value="owbBOFNKSbdOnmW9i32XkkUaTcI%3D" />
  </form>
Response
none