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

Read Result(s)

Functional Overview

These functions may be used to read submission results on Turnitin.

readResult

This function takes a Turnitin Document ID and returns the data associated with it. If the object ID passed in the request does not exist or does not belong to this account then an error is returned.

Parameters

Required:
Required:
<
sourceId
//Integer. Contains the ID of the submission.
Optional:
none
//

Outputs

Grade Mark
//Integer.Returns the Overall GradeMark outcome score for the submission / result.
Result Score
//Integer.Returns the Overall Similarity percentage for this submission / result i.e combined matches found against sources overall.
Internet Similarity
//Integer.Returns the Internet Similarity percentage for this submission / result i.e matches found against internet sources.
Publication Similarity
//Integer.Returns the Publication Similarity percentage for this submission / result i.e matches found against publication sources.
Student Paper Similarity
//Integer.Returns the Student Paper Similarity percentage for this submission / result i.e matches found against student paper sources.
Translated Overall Similarity
//Integer.Returns the Translated Internet Similarity percentage for this submission / result i.e translated matches found against internet sources.
Translated Internet Similarity
//Integer.Returns the Translated Internet Similarity percentage for this submission / result i.e translated matches found against internet sources.
Translated Publication Similarity
//Integer.Returns the Translated Publication Similarity percentage for this submission / result i.e translated matches found against publication sources.
Translated Student Paper Similarity
//Integer.Returns the Translated Student Paper Similarity percentage for this submission / result i.e translated matches found against student paper sources.
Student View Last
//UTC DateTime String.Returns the DateTime in UTC timezone in the format YY-MM-DDThh:mm:ssZ indicating when the student last viewed GradeMark for this paper.
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 readResult 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/readResult"
  Content-length: 582
  Source: 12
  Authorization: OAuth oauth_nonce="87144f4cfd38a9b90f4241643ec5151e40e5ceaf",
       oauth_timestamp="1337943356",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="hLj0dl8mzY5AO%2F2ALWeIC1scU%2BE%3D",
       oauth_signature="t090y0DfAls1TkgIgXTuR4YQYrI%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>16dd3b8d-c66b-4839-a158-638b81587088</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readResultRequest>
          <ns1:sourcedId>49313814</ns1:sourcedId>
      </ns1:readResultRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>
Example readResult 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>77B77238-A656-11E1-BBEA-38C7EFE76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>16dd3b8d-c66b-4839-a158-638b81587088</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Object Result found.</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:readResultResponse xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
      <tns:resultRecord>
          <tns:sourcedGUID>
              <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
              <tns:sourcedId>49313814</tns:sourcedId>
          </tns:sourcedGUID>
          <tns:result>
              <tns:lineItemSourcedId>20028310</tns:lineItemSourcedId>
              <tns:personSourcedId>100012184</tns:personSourcedId>
              <tns:date>2012-05-22T14:41:50Z</tns:date>
              <tns:resultValue>
                  <tns:label>TestDoc1.doc</tns:label>
              </tns:resultValue>
              <tns:resultScore>
                  <tns:language>en-US</tns:language>
                  <tns:textString>100</tns:textString>
              </tns:resultScore>
              <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>GradeMark</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue/>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>InternetSimilarity</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>PublicationSimilarity</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue>0</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>StudentPaperSimilarity</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue>100</tns:fieldValue>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>TranslatedOverallSimilarity</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue/>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>TranslatedInternetSimilarity</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue/>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>TranslatedPublicationSimilarity</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue/>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>TranslatedStudentPaperSimilarity</tns:fieldName>
                      <tns:fieldType>Integer</tns:fieldType>
                      <tns:fieldValue/>
                  </tns:extensionField>
                  <tns:extensionField>
                      <tns:fieldName>StudentViewLast</tns:fieldName>
                      <tns:fieldType>DateTime</tns:fieldType>
                      <tns:fieldValue/>
                  </tns:extensionField>
              </tns:extension>
          </tns:result>
      </tns:resultRecord>
  </tns:readResultResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

readResults

This function takes a set of Turnitin paper IDs and returns the data associated with them. If any of the IDs are not found or are not associated with this Turnitin account then a partial success will be returned. If none of the IDs are found or are not associated with this Turnitin account then an error message is returned in the SOAP response.

If all of the Paper IDs supplied in the SOAP request are found then a success message is returned containing the submission / result information for each Turnitin Paper.

Parameters

Required:
<
sourceId
//Integer. Contains the ID of the submission.
Optional:
none
//

Outputs

Grade Mark
//Integer.Returns the Overall GradeMark outcome score for the submission / result.
Result Score
//Integer.Returns the Overall Similarity percentage for this submission / result i.e combined matches found against sources overall.
Internet Similarity
//Integer.Returns the Internet Similarity percentage for this submission / result i.e matches found against internet sources.
Publication Similarity
//Integer.Returns the Publication Similarity percentage for this submission / result i.e matches found against publication sources.
Student Paper Similarity
//Integer.Returns the Student Paper Similarity percentage for this submission / result i.e matches found against student paper sources.
Translated Overall Similarity
//Integer.Returns the Translated Internet Similarity percentage for this submission / result i.e translated matches found against internet sources.
Translated Internet Similarity
//Integer.Returns the Translated Internet Similarity percentage for this submission / result i.e translated matches found against internet sources.
Translated Publication Similarity
//Integer.Returns the Translated Publication Similarity percentage for this submission / result i.e translated matches found against publication sources.
Translated Student Paper Similarity
//Integer.Returns the Translated Student Paper Similarity percentage for this submission / result i.e translated matches found against student paper sources.
Student View Last
//UTC DateTime String.Returns the DateTime in UTC timezone in the format YY-MM-DDThh:mm:ssZ indicating when the student last viewed GradeMark for this paper.
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 "The class_id provided is not a valid class_id for this Turnitin account"
XXX "The class_id provided is not a valid class_id for this Turnitin account"
XXX "The class_id provided is not a valid class_id for this Turnitin account"

Example readResults 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/readResults"
  Content-length: 660
  Source: 12
  Authorization: OAuth oauth_nonce="39966ee54ece5c2d902fea67a2ebfee8d3c9a152",
       oauth_timestamp="1337943356",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="p3PTEGsDnK5MixWiBnIRNT2kv84%3D",
       oauth_signature="91LbKgS35NCI7q3N2ydU5y7RcZk%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>e7067b21-fc30-4e22-9ad2-f5a7268835f4</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readResultsRequest>
          <ns1:sourcedIdSet>
              <ns1:sourcedId>49313814</ns1:sourcedId>
              <ns1:sourcedId>49313826</ns1:sourcedId>
          </ns1:sourcedIdSet>
      </ns1:readResultsRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>
Example readResults 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>77B77184-A656-11E1-BBEA-38B8EFE76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>e7067b21-fc30-4e22-9ad2-f5a7268835f4</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>2/2 Object Results found.</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:readResultsResponse xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
      <tns:resultRecordSet>
          <tns:resultRecord>
              <tns:sourcedGUID>
                  <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
                  <tns:sourcedId>49313814</tns:sourcedId>
              </tns:sourcedGUID>
              <tns:result>
                  <tns:lineItemSourcedId>20028310</tns:lineItemSourcedId>
                  <tns:personSourcedId>100012184</tns:personSourcedId>
                  <tns:date>2012-05-22T14:41:50Z</tns:date>
                  <tns:resultValue>
                      <tns:label>TestDoc1.doc</tns:label>
                  </tns:resultValue>
                  <tns:resultScore>
                      <tns:language>en-US</tns:language>
                      <tns:textString>100</tns:textString>
                  </tns:resultScore>
                  <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>GradeMark</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>InternetSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue>0</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>PublicationSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue>0</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>StudentPaperSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue>100</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>TranslatedOverallSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>TranslatedInternetSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>TranslatedPublicationSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>TranslatedStudentPaperSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>StudentViewLast</tns:fieldName>
                          <tns:fieldType>DateTime</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                  </tns:extension>
              </tns:result>
          </tns:resultRecord>
          <tns:resultRecord>
              <tns:sourcedGUID>
                  <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
                  <tns:sourcedId>49313826</tns:sourcedId>
              </tns:sourcedGUID>
              <tns:result>
                  <tns:lineItemSourcedId>20028310</tns:lineItemSourcedId>
                  <tns:personSourcedId>100012195</tns:personSourcedId>
                  <tns:date>2012-05-22T14:44:40Z</tns:date>
                  <tns:resultValue>
                      <tns:label>TestDoc1.doc</tns:label>
                  </tns:resultValue>
                  <tns:resultScore>
                      <tns:language>en-US</tns:language>
                      <tns:textString>100</tns:textString>
                  </tns:resultScore>
                  <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>GradeMark</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>InternetSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue>0</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>PublicationSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue>0</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>StudentPaperSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue>100</tns:fieldValue>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>TranslatedOverallSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>TranslatedInternetSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>TranslatedPublicationSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>TranslatedStudentPaperSimilarity</tns:fieldName>
                          <tns:fieldType>Integer</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                      <tns:extensionField>
                          <tns:fieldName>StudentViewLast</tns:fieldName>
                          <tns:fieldType>DateTime</tns:fieldType>
                          <tns:fieldValue/>
                      </tns:extensionField>
                  </tns:extension>
              </tns:result>
          </tns:resultRecord>
      </tns:resultRecordSet>
  </tns:readResultsResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>