Read CourseSection(s)

Functional Overview

This functions may be used to retrieve information about classes that exist within Turnitin.

readCourseSection

This function takes a request containing a Turnitin Class ID and returns the title and class end date for that class. If the Class ID is not associated with a class on this Turnitin account or the Class ID is not found then an error is returned in the SOAP response.

Parameters

Required:

sourceId: //string. max size xxx. unique identifier for class

Optional:

none: //

Outputs

sourceId: //integer. max size xxx. unique identifier for class
title: //string. max size xxx. title of class
timeFrame: //date. format xxxx. end date of 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

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

Example readCourseSection 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/cmsv1p0/readCourseSection"
  Content-length: 597
  Source: 12
  Authorization: OAuth oauth_nonce="484f508287d64a8a084f2e3d8ef58772156458bf",
       oauth_timestamp="1337786265",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="jrPVpfWVVB%2FscymTz494GrcObJQ%3D",
       oauth_signature="%2Boy1ZgyCh5CVAwxSTtymMZ%2BMgrA%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>28ea3d60-b34d-4f4e-b997-063a904cceb7</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readCourseSectionRequest>
          <ns1:sourcedId>20005488</ns1:sourcedId>
      </ns1:readCourseSectionRequest>
  </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>28ea3d60-b34d-4f4e-b997-063a904cceb7</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Class CourseSection successfully 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:readCourseSectionResponse xmlns:tns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">
      <tns:courseSectionRecord>
          <tns:sourcedGUID>
              <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
              <tns:sourcedId>20005488</tns:sourcedId>
          </tns:sourcedGUID>
          <tns:courseSection>
              <tns:title>
                  <tns:language>en-US</tns:language>
                  <tns:textString>Demo Class 1337786264</tns:textString>
              </tns:title>
              <tns:timeFrame>
                  <tns:end>2012-06-22T03:17:44Z</tns:end>
              </tns:timeFrame>
          </tns:courseSection>
      </tns:courseSectionRecord>
  </tns:readCourseSectionResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example readCourseSectionResponse

  <?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>28ea3d60-b34d-4f4e-b997-063a904cceb7</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Class CourseSection successfully 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:readCourseSectionResponse xmlns:tns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">
      <tns:courseSectionRecord>
          <tns:sourcedGUID>
              <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
              <tns:sourcedId>20005488</tns:sourcedId>
          </tns:sourcedGUID>
          <tns:courseSection>
              <tns:title>
                  <tns:language>en-US</tns:language>
                  <tns:textString>Demo Class 1337786264</tns:textString>
              </tns:title>
              <tns:timeFrame>
                  <tns:end>2012-06-22T03:17:44Z</tns:end>
              </tns:timeFrame>
          </tns:courseSection>
      </tns:courseSectionRecord>
  </tns:readCourseSectionResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

readCourseSections

This function takes a request containing a set of Turnitin Class IDs and returns the titles and class end dates for those classes. If any of the Class IDs are not associated with a class on this Turnitin account or are not found then a partialsuccess is returned containing the data that could be returned. If none of the class IDs are associated with this account or are not found then an error is returned in the SOAP response.

If all classes with the Class IDs in the request are found and are associated with this Turnitin account then the class data associated with these Class IDs is returned in the SOAP response.

Parameters

Required:

sourceId: //string. max size xxx. unique identifier for class

Optional:

none: //

Outputs

sourceId: //integer. max size xxx. unique identifier for class
title: //string. max size xxx. title of class
timeFrame: //date. format xxxx. end date of 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

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

Example readCourseSections 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/cmsv1p0/readCourseSections"
  Content-length: 675
  Source: 12
  Authorization: OAuth oauth_nonce="0bb1f06a7bd45424cb7b792d5ae66ab4ae6bc6da",
       oauth_timestamp="1337786266",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="OtzfvLMA0kyqbasQW2n66sKb3zY%3D",
       oauth_signature="ExN6TWZXel5ZiuYve4PHhG8sgfA%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>cfbc769e-431a-4e1a-b5f6-c8dc0283c4c2</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readCourseSectionsRequest>
          <ns1:sourcedIdSet>
              <ns1:sourcedId>20005488</ns1:sourcedId>
              <ns1:sourcedId>20005489</ns1:sourcedId>
          </ns1:sourcedIdSet>
      </ns1:readCourseSectionsRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example readCourseSections 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/cmsv1p0/wsdl11/sync/imscms_v1p0">
      <tns:imsx_version>V1.0</tns:imsx_version>
      <tns:imsx_messageIdentifier>A7E31EC6-A4E9-11E1-BD36-B001F0E76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>cfbc769e-431a-4e1a-b5f6-c8dc0283c4c2</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Returned 2 of 2 classes.</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:readCourseSectionsResponse xmlns:tns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">
      <tns:courseSectionRecordSet>
          <tns:courseSectionRecord>
              <tns:sourcedGUID>
                  <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
                  <tns:sourcedId>20005488</tns:sourcedId>
              </tns:sourcedGUID>
              <tns:courseSection>
                  <tns:title>
                      <tns:language>en-US</tns:language>
                      <tns:textString>Demo Class 1337786264</tns:textString>
                  </tns:title>
                  <tns:timeFrame>
                      <tns:end>2012-06-22T03:17:44Z</tns:end>
                  </tns:timeFrame>
              </tns:courseSection>
          </tns:courseSectionRecord>
          <tns:courseSectionRecord>
              <tns:sourcedGUID>
                  <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
                  <tns:sourcedId>20005489</tns:sourcedId>
              </tns:sourcedGUID>
              <tns:courseSection>
                  <tns:title>
                      <tns:language>en-US</tns:language>
                      <tns:textString>Demo Class 1337786264</tns:textString>
                  </tns:title>
                  <tns:timeFrame>
                      <tns:end>2012-06-22T03:17:44Z</tns:end>
                  </tns:timeFrame>
              </tns:courseSection>
          </tns:courseSectionRecord>
      </tns:courseSectionRecordSet>
  </tns:readCourseSectionsResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>