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

Read LineItem (Assignment)

Functional Overview

These functions may be used to retrieve information about one or more assignments that exist within Turnitin.

readLineItem

This function takes a request containing a valid assignment ID. If the assignment ID is found and is associated with the insitution account authenticated on the APi call, then an assignment object is returned containing all assignment option settings for the matching assignment. All possible options will be returned.

Parameters

Required:
sourceId
//integer. max size xxx. unique identifier for assignment
Optional:
none
//

Outputs

sourceId
//integer. max size xxx. unique identifier for assignment
Title
//string. (string between 3 and 99). The display title for the assignment.
Start Date
//UTC DateTime String. Format YY-MM-DDThh:mm:ssZ e.g 2012-0201T09:34:09Z. Submissions can be made from this date.
Due Date
//UTC DateTime String. Format YY-MM-DDThh:mm:ssZ e.g 2012-0201T09:34:09Z. Submissions can be made until this date. Defaults to Post Date if not supplied
Post Date
//UTC DateTime String. Format YY-MM-DDThh:mm:ssZ e.g 2012-0201T09:34:09Z. Outcomes will be made available to students on this date. Defaults to Due Date if not supplied
Student View Report
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether students can see the originality report.
Student Paper Check
//Boolean. (0 or 1, defaults to 1 if not set). A boolean value determines whether similarity checks are made against Turnitin's student paper content.
Internet Check
//Boolean. (0 or 1, defaults to 1 if not set). A boolean value determines whether similarity checks are made against Turnitin's web indexed content.
Journal Check
//Boolean. (0 or 1, defaults to 1 if not set). A boolean value determines whether similarity checks are made against Turnitin's journal content.
Institution Check
//Boolean. (0 or 1, defaults to 1 if not set). A boolean value determines whether similarity checks are made against this account's institutional repository.
Max Points
//Integer. (0 to 100, defaults to 100 if not set). An integer value determines the maximum grade / mark a paper can receive.
Allow Late
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether student's are allowed to submit after the Due Date.
Submit Papers To
//Integer. (0 = Not Stored Permanently, 1 = Standard Repository, 3 = Institutional Repository (if available) defaults to 1 if not set). An integer value determines the repository the student paper submissions will be stored.
Report Generation Behaviour
//Integer. (0 = Immediately, No Resubmission (Default), 1 = Immediately, Allow Resubmissions, 2 = On Due Date, Allow Resubmissions). An integer value determines how and when Originality Reports are generated.
Exclude Bibliography
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether to automatically detect and exclude bibliography entries.
Exclude Quoted
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether to automatically detect and exclude quoted material.
Small Match Exclusion Type
//Integer. (0 to 2, 0 = none (Default), 1 = By Word Count, 2 = By Percentage). An integer value determines how to treat small matches in the Originality Report, the default behaviour is to not exclude small matches.
Small Match Exclusion Threshold
//Integer. (Default 0, 0 to 100 if excluding by percentage, 0 or higher if excluding by word count). An integer value that determines the threshold to use when excluding small matches, ignored if Exclusion Type is set to 0 above.
Anonymous Marking
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value to determine whether anonymous marking is enabled for this assignment.
Erater
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether the Erater service is enabled for this assignment.
Erater Spelling
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether spelling feedback is enabled for the Erater service.
Erater Grammar
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether grammer feedback is enabled for the Erater service.
Erater Usage
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether word usage feedback is enabled for the Erater service.
Erater Mechanics
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether word mechanics feedback is enabled for the Erater service.
Erater Style
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether writing style feedback is enabled for the Erater service.
Erater Spelling Dictionary
//String. (Language ID String, Default: en, Possible Settings: en-US, en-GB, en). A language identification string for the Erater spelling dictionary, determines what dictionary to use when checking spelling.
Erater Handbook
//Integer. (Defaults to 2, Options: 1 [Advanced], 2 [High School], 3 [Middle School], 4 [Elementary], 5 [English Learners]). An integer value determines which handbook level to use when providing feedback via the Erater service.
Translated Matching
//Boolean. (0 or 1, defaults to 0 if not set). A boolean value determines whether translated matching is enabled on the assignment.
codeMajor
//string. max size xxx. returns "success" or "Failure"
codeMinor
//string. max siz xxx. returns "success", "partial success", "error"
description
//string. max siz xxx. description of successful action completed OR error encountered

Error Codes & Text

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

Example readLineItem SOAP Request
  Content-type: text/xml;charset="utf-8"
  Accept: text/xml
  Cache-Control: no-cache
  Pragma: no-cache
  SOAPAction: "http://www.imsglobal.org/soap/lis/oms1p0/readLineItem"
  Content-length: 586
  Source: 12
  Authorization: OAuth oauth_nonce="e97fa394bb71f2ad84d3045473c3dfa6faec2ca9",
       oauth_timestamp="1337860014",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="z6GEAoNTIdhU1aAZjkSD8XJ%2BZYA%3D",
       oauth_signature="sbkNy0ZgaNRjo7GzoPp2Qd6Z56c%3D"

  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
  <SOAP-ENV:Header>
      <ns1:imsx_syncRequestHeaderInfo>
          <ns1:imsx_version>V1.0</ns1:imsx_version>
          <ns1:imsx_messageIdentifier>ccbb4033-c255-41ac-81a8-f6673cecd89b</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readLineItemRequest>
          <ns1:sourcedId>20028414</ns1:sourcedId>
      </ns1:readLineItemRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>
Example readLineItem SOAP Response
  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
      <tns:imsx_syncResponseHeaderInfo xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
      <tns:imsx_version>V1.0</tns:imsx_version>
      <tns:imsx_messageIdentifier>80BF9214-A595-11E1-AFE8-ACB9EFE76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>ccbb4033-c255-41ac-81a8-f6673cecd89b</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Assignment LineItem found successfully.</tns:imsx_description>
          <tns:imsx_codeMinor>
              <tns:imsx_codeMinorField>
                  <tns:imsx_codeMinorFieldName>TargetEndSystem</tns:imsx_codeMinorFieldName>
                  <tns:imsx_codeMinorFieldValue>fullsuccess</tns:imsx_codeMinorFieldValue>
              </tns:imsx_codeMinorField>
          </tns:imsx_codeMinor>
      </tns:imsx_statusInfo>
  </tns:imsx_syncResponseHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <tns:readLineItemResponse xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
      <tns:lineItemRecord>
          <tns:sourcedGUID>
              <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
              <tns:sourcedId>20028414</tns:sourcedId>
          </tns:sourcedGUID>
          <tns:lineItem>
              <tns:label>Demo Assignment 1337860011</tns:label>
              <tns:extension>
                  <tns:extensionNameVocabulary>https://www.turnitin.com/static/resources/files/turnitinvocabularyv1p0.xml</tns:extensionNameVocabulary>
                  <tns:extensionValueVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/extensionvocabularyv1p0.xml</tns:extensionValueVocabulary>
                  <tns:extensionField>
                      <tns:fieldName>DateStart</tns:fieldName>
                      <tns:fieldType>DateTime</tns:fieldType>
                      <tns:fieldValue>2012-05-24T11:46:51Z</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>DateDue</tns:fieldName>
                      <tns:fieldType>DateTime</tns:fieldType>
                      <tns:fieldValue>2012-06-23T11:46:51Z</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>DatePost</tns:fieldName>
                      <tns:fieldType>DateTime</tns:fieldType>
                      <tns:fieldValue>2012-07-13T11:46:51Z</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>StudentViewReport</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>StudentPaperCheck</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>1</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>InternetCheck</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>1</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>JournalCheck</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>1</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>InstitutionCheck</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>1</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>MaxPoints</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue>100</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>AllowLate</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>SubmitPapersTo</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue>1</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>ReportGenerationBehaviour</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>ExcludeBibliography</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>ExcludeQuoted</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>SmallMatchExclusionType</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>SmallMatchExclusionThreshold</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>AnonymousMarking</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>Erater</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>EraterSpelling</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>EraterGrammar</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>EraterUsage</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>EraterMechanics</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>EraterStyle</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>EraterSpellingDictionary</tns:fieldName>
                      <tns:fieldType>String</tns:fieldType>
                      <tns:fieldValue/>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>EraterHandbook</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue/>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>TranslatedMatching</tns:fieldName>
                      <tns:fieldType>Boolean</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
              </tns:extension>
          </tns:lineItem>
      </tns:lineItemRecord>
  </tns:readLineItemResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

readLineItems

This function takes a set of assignment IDs. If the assignment IDs are valid and the assignments found are associated with this account and API product then basic option settings are returned. Settings returned by readLineItems are title, start date, due date and post date. To retreive the full set of options associated with an assignment the user should use readLineItem for an individual assignment. If any of the IDs are not found or do not belong to this account and API product then a partial success in returned containing only the data for the assignments that were found.

Parameters

Required:
sourceId
//integer. max size xxx. unique identifier for assignment
Optional:
none
//

Outputs

sourceId
//integer. max size xxx. unique identifier for assignment
Title
//string. (string between 3 and 99). The display title for the assignment.
Start Date
//UTC DateTime String. Format YY-MM-DDThh:mm:ssZ e.g 2012-0201T09:34:09Z. Submissions can be made from this date.
Due Date
//UTC DateTime String. Format YY-MM-DDThh:mm:ssZ e.g 2012-0201T09:34:09Z. Submissions can be made until this date. Defaults to Post Date if not supplied
Post Date
//UTC DateTime String. Format YY-MM-DDThh:mm:ssZ e.g 2012-0201T09:34:09Z. Outcomes will be made available to students on this date. Defaults to Due Date if not supplied
codeMajor
//string. max size xxx. returns "success" or "Failure"
codeMinor
//string. max siz xxx. returns "success", "partial success", "error"
description
//string. max siz xxx. description of successful action completed OR error encountered

Error Codes & Text

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

Example readLineItems SOAP Request
  Content-type: text/xml;charset="utf-8"
  Accept: text/xml
  Cache-Control: no-cache
  Pragma: no-cache
  SOAPAction: "http://www.imsglobal.org/soap/lis/oms1p0/readLineItems"
  Content-length: 664
  Source: 12
  Authorization: OAuth oauth_nonce="0147a0426338648a76fe008c596f91be6987d660",
       oauth_timestamp="1337860015",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="873A8UbQrK%2BPXvRSLAmOBpJKKfs%3D",
       oauth_signature="sP17fFRsqwpoN2HBAo%2FqqRM7u7o%3D"

  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
  <SOAP-ENV:Header>
      <ns1:imsx_syncRequestHeaderInfo>
          <ns1:imsx_version>V1.0</ns1:imsx_version>
          <ns1:imsx_messageIdentifier>4229c76b-9db4-4c9e-aa2d-5563aada1663</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readLineItemsRequest>
          <ns1:sourcedIdSet>
              <ns1:sourcedId>20028414</ns1:sourcedId>
              <ns1:sourcedId>20028415</ns1:sourcedId>
          </ns1:sourcedIdSet>
      </ns1:readLineItemsRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>
Example readLineItems SOAP Response
  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
      <tns:imsx_syncResponseHeaderInfo xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
      <tns:imsx_version>V1.0</tns:imsx_version>
      <tns:imsx_messageIdentifier>80BF9214-A595-11E1-AFE8-ACB9EFE76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>4229c76b-9db4-4c9e-aa2d-5563aada1663</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>2 / 2 Assignment LineItems found successfully.</tns:imsx_description>
          <tns:imsx_codeMinor>
              <tns:imsx_codeMinorField>
                  <tns:imsx_codeMinorFieldName>TargetEndSystem</tns:imsx_codeMinorFieldName>
                  <tns:imsx_codeMinorFieldValue>fullsuccess</tns:imsx_codeMinorFieldValue>
              </tns:imsx_codeMinorField>
          </tns:imsx_codeMinor>
      </tns:imsx_statusInfo>
  </tns:imsx_syncResponseHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <tns:readLineItemsResponse xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
      <tns:lineItemRecordSet>
          <tns:lineItemRecord>
              <tns:sourcedGUID>
                  <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
                  <tns:sourcedId>20028414</tns:sourcedId>
              </tns:sourcedGUID>
              <tns:lineItem>
                  <tns:label>Demo Assignment 1337860011</tns:label>
                  <tns:extension>
                      <tns:extensionNameVocabulary>https://www.turnitin.com/static/resources/files/turnitinvocabularyv1p0.xml</tns:extensionNameVocabulary>
                      <tns:extensionValueVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/extensionvocabularyv1p0.xml</tns:extensionValueVocabulary>
                      <tns:extensionField>
                          <tns:fieldName>DateStart</tns:fieldName>
                          <tns:fieldType>DateTime</tns:fieldType>
                          <tns:fieldValue>2012-05-24T11:46:51Z</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>DateDue</tns:fieldName>
                          <tns:fieldType>DateTime</tns:fieldType>
                          <tns:fieldValue>2012-06-23T11:46:51Z</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>DatePost</tns:fieldName>
                          <tns:fieldType>DateTime</tns:fieldType>
                          <tns:fieldValue>2012-07-13T11:46:51Z</tns:fieldValue>
                      </tns:extensionField>
                  </tns:extension>
              </tns:lineItem>
          </tns:lineItemRecord>
          <tns:lineItemRecord>
              <tns:sourcedGUID>
                  <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
                  <tns:sourcedId>20028415</tns:sourcedId>
              </tns:sourcedGUID>
              <tns:lineItem>
                  <tns:label>Demo Assignment 2 1337860013</tns:label>
                  <tns:extension>
                      <tns:extensionNameVocabulary>https://www.turnitin.com/static/resources/files/turnitinvocabularyv1p0.xml</tns:extensionNameVocabulary>
                      <tns:extensionValueVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/extensionvocabularyv1p0.xml</tns:extensionValueVocabulary>
                      <tns:extensionField>
                          <tns:fieldName>DateStart</tns:fieldName>
                          <tns:fieldType>DateTime</tns:fieldType>
                          <tns:fieldValue>2012-05-24T11:46:51Z</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>DateDue</tns:fieldName>
                          <tns:fieldType>DateTime</tns:fieldType>
                          <tns:fieldValue>2012-06-23T11:46:51Z</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>DatePost</tns:fieldName>
                          <tns:fieldType>DateTime</tns:fieldType>
                          <tns:fieldValue>2012-07-13T11:46:51Z</tns:fieldValue>
                      </tns:extensionField>
                  </tns:extension>
              </tns:lineItem>
          </tns:lineItemRecord>
      </tns:lineItemRecordSet>
  </tns:readLineItemsResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>