Discover CourseSectionIDs

Functional Overview

This function may be used to retrieve the sourceIds for courses created for an institution account within Turnitin.

discoverCourseSectionIds

This function takes a search string and searches the Turnitin account and API product for a class where the search string partially matches a class title. If no classes are found using this search string then an error response is returned.

If any classes are found and are associated with this Turnitin account then the Turnitin Class IDs are returned in the SOAP response. A maximum of 100 results will be returned.

Parameters

Required:

title: //string. max size xxx. title to be used to search for courses

Optional:

none: //

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

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

Example discoverCourseSectionIds 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/discoverCourseSectionIds"
  Content-length: 628
  Source: 12
  Authorization: OAuth oauth_nonce="57c35cffa019387f188d352bfe0278f9413b8e58",
       oauth_timestamp="1337786269",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="7Il4USE%2B7mzcMUaB7iScx5hebKs%3D",
       oauth_signature="v5YUJVQiQYRdTsHiMZvTAD4UO6U%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>de133700-9f4d-473d-888b-60ee9b99fc0c</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:discoverCourseSectionIdsRequest>
          <ns1:queryObject>Demo Class 1337786264</ns1:queryObject>
      </ns1:discoverCourseSectionIdsRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example discoverCourseSectionIds 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>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>de133700-9f4d-473d-888b-60ee9b99fc0c</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Found 1 of 1 class sourcedId/s.</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:discoverCourseSectionIdsResponse xmlns:tns="http://www.imsglobal.org/services/lis/cmsv1p0/wsdl11/sync/imscms_v1p0">
      <tns:sourcedIdSet>
          <tns:sourcedId>20005489</tns:sourcedId>
      </tns:sourcedIdSet>
  </tns:discoverCourseSectionIdsResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>