Create LineItem (Assignment)

Functional Overview

This function may be used to create a new assignment within Turnitin. Assignments are created within the context of a course. If the course ID provided with the call does not exist within the institution account, the an error will be returned with the SOAP response.

createByProxyLineItem

This function takes a collection of assignment settings and creates a new Turnitin assignment. If the call is successful the Turnitin assignment ID associated with the newly created assignment is returned in the SOAP response message.

Parameters

Required:

sourceId: //integer. max size xxx. unique identifier for class to serve as parent 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

Optional:

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.

Outputs

sourceId: //integer. max size xxx. unique identifier for 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

Code	Text
XXX	"description"
XXX	"description"
XXX	"description"

Example createByProxyLineItem 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/createByProxyLineItem"
  Content-length: 1671
  Source: 12
  Authorization: OAuth oauth_nonce="37aacdf53c9742a01521ad1038d66c289494ab94",
       oauth_timestamp="1337860011",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="h3X%2FNrP6fwlo%2BvJZFNS2Ssaoot0%3D",
       oauth_signature="DcI2HjS6eAnC9Ic5uWQuYRne13g%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>79ee36df-f972-45db-b7c3-89f472e37370</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:createByProxyLineItemRequest>
          <ns1:lineItemRecord>
              <ns1:sourcedGUID>
                  <ns1:sourcedId/>
              </ns1:sourcedGUID>
              <ns1:lineItem>
                  <ns1:context>
                      <ns1:contextIdentifier>20005116</ns1:contextIdentifier>
                      <ns1:contextType>courseSection</ns1:contextType>
                  </ns1:context>
                  <ns1:label>Demo Assignment 1337860011</ns1:label>
                  <ns1:extension>
                      <ns1:extensionNameVocabulary>http://www.turnitin.com/static/source/media/turnitinvocabularyv1p0.xml</ns1:extensionNameVocabulary>
                      <ns1:extensionValueVocabulary>http://www.imsglobal.org/vdex/lis/omsv1p0/extensionvocabularyv1p0.xml</ns1:extensionValueVocabulary>
                      <ns1:extensionField>
                          <ns1:fieldName>DateStart</ns1:fieldName>
                          <ns1:fieldType>DateTime</ns1:fieldType>
                          <ns1:fieldValue>2012-05-24T11:46:51Z</ns1:fieldValue>
                      </ns1:extensionField>
                      <ns1:extensionField>
                          <ns1:fieldName>DateDue</ns1:fieldName>
                          <ns1:fieldType>DateTime</ns1:fieldType>
                          <ns1:fieldValue>2012-06-23T11:46:51Z</ns1:fieldValue>
                      </ns1:extensionField>
                      <ns1:extensionField>
                          <ns1:fieldName>DatePost</ns1:fieldName>
                          <ns1:fieldType>DateTime</ns1:fieldType>
                          <ns1:fieldValue>2012-07-13T11:46:51Z</ns1:fieldValue>
                      </ns1:extensionField>
                  </ns1:extension>
              </ns1:lineItem>
          </ns1:lineItemRecord>
      </ns1:createByProxyLineItemRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example createByProxyLineItem 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>79ee36df-f972-45db-b7c3-89f472e37370</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Assignment LineItem successfully created.</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:createByProxyLineItemResponse xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
      <tns:sourcedId>20028414</tns:sourcedId>
  </tns:createByProxyLineItemResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>