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

Create CourseSection

Functional Overview

This function may be used to create a class within Turnitin

By default classes start on the day of creation. It is not required to provide a class end date. If no end date is provided, the class will default to a duration of six months. Class duration may not exceed one year.

createByProxyCourseSection

This function takes a request containing a class title and optional class end date and creates a new class associated with the Turnitin account.

If the class is successfully created then the Turnitin Class ID for the new class is returned in the SOAP response.

Parameters

Required:
title
//String. max size xxx. Contains class title for display
Optional:
timeFrame
//UTC DateTime String. Contains the end date for the class to be created. If not provided defaults to 6 months from creation date.

Outputs

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

   Content-type: text/xml;charset="utf-8"
  Accept: text/xml
  Cache-Control: no-cache
  Pragma: no-cache
  SOAPAction: "http://www.imsglobal.org/soap/lis/cmsv1p0/createByProxyCourseSection"
  Content-length: 898
  Source: 12
  Authorization: OAuth oauth_nonce="f5a6abf5f6dab0a2677683199011e6a6caeb2fa6",
       oauth_timestamp="1337786264",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="4gDID9T%2FEysAyKrytULIPOsSFJg%3D",
       oauth_signature="e%2Fv39etaqkQ7DLUd7o%2BtPXSIm84%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/cmsv1p0/wsdl11/sync/imscms_v1p0">
  <SOAP-ENV:Header>
      <ns1:imsx_syncRequestHeaderInfo>
          <ns1:imsx_version>V1.0</ns1:imsx_version>
          <ns1:imsx_messageIdentifier>f20fc105-3170-4dfe-818d-695cf13cc627</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:createByProxyCourseSectionRequest>
          <ns1:courseSectionRecord>
              <ns1:sourcedGUID>
                  <ns1:sourcedId/>
              </ns1:sourcedGUID>
              <ns1:courseSection>
                  <ns1:title>
                      <ns1:language>en-US</ns1:language>
                      <ns1:textString>Demo Class 1337786264</ns1:textString>
                  </ns1:title>
                  <ns1:timeFrame>
                      <ns1:end>2012-06-22T03:17:44Z</ns1:end>
                  </ns1:timeFrame>
              </ns1:courseSection>
          </ns1:courseSectionRecord>
      </ns1:createByProxyCourseSectionRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>
  <?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/cmsv1p0/wsdl11/sync/imscms_v1p0">
      <tns:imsx_version>V1.0</tns:imsx_version>
      <tns:imsx_messageIdentifier>A746321E-A4E9-11E1-BD36-3CF1EFE76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>f20fc105-3170-4dfe-818d-695cf13cc627</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Turnitin class added.</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:createByProxyCourseSectionResponse xmlns:tns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">
      <tns:sourcedId>20005488</tns:sourcedId>
  </tns:createByProxyCourseSectionResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>