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

Read LineItemIds For CourseSection

Functional Overview

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

readLineItemIdsForCourseSection

This function takes a class ID and returns the IDs for all assignments associated with that class. If the class ID is not found or is not associated with this account and API product then an error message is returned in the response.

Parameters

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

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

CodeText
XXX "description"
XXX "description"
XXX "description"

Example readLineItemIdsForCourseSection 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/readLineItemIdsForCourseSection"
    Content-length: 638
    Source: 12
    Authorization: OAuth oauth_nonce="3485b6b3f06f28f35e06a3003973f946b9c5cbba",
         oauth_timestamp="1337860018",
         oauth_consumer_key="49201",
         oauth_signature_method="HMAC-SHA1",
         oauth_version="1.0",
         oauth_body_hash="HRSFUgUJJ7OveSjEKx76wKBBoPM%3D",
         oauth_signature="At5AxCDIGKjna%2FfFcis6kZRzMHQ%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>da70b843-e3fe-49b9-a403-649951a8a9fa</ns1:imsx_messageIdentifier>
        </ns1:imsx_syncRequestHeaderInfo>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <ns1:readLineItemIdsForCourseSectionRequest>
            <ns1:sectionSourcedId>20005116</ns1:sectionSourcedId>
        </ns1:readLineItemIdsForCourseSectionRequest>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
Example readLineItemIdsForCourseSection 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>da70b843-e3fe-49b9-a403-649951a8a9fa</tns:imsx_messageRefIdentifier>
            <tns:imsx_description>87 Assignment LineItems 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:readLineItemIdsForCourseSectionResponse xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
        <tns:sourcedIdSet>
            <tns:sourcedId>20028414</tns:sourcedId>
            <tns:sourcedId>20028412</tns:sourcedId>
            <tns:sourcedId>20028410</tns:sourcedId>
            <tns:sourcedId>20028408</tns:sourcedId>
            <tns:sourcedId>20028406</tns:sourcedId>
            <tns:sourcedId>20028404</tns:sourcedId>
            <tns:sourcedId>20028402</tns:sourcedId>
            <tns:sourcedId>20028400</tns:sourcedId>
            <tns:sourcedId>20028396</tns:sourcedId>
            <tns:sourcedId>20028394</tns:sourcedId>
            <tns:sourcedId>20028392</tns:sourcedId>
            <tns:sourcedId>20028390</tns:sourcedId>
            <tns:sourcedId>20028388</tns:sourcedId>
            <tns:sourcedId>20028386</tns:sourcedId>
            <tns:sourcedId>20028384</tns:sourcedId>
            <tns:sourcedId>20028382</tns:sourcedId>
            <tns:sourcedId>20028380</tns:sourcedId>
            <tns:sourcedId>20028378</tns:sourcedId>
            <tns:sourcedId>20028376</tns:sourcedId>
            <tns:sourcedId>20028374</tns:sourcedId>
            <tns:sourcedId>20028372</tns:sourcedId>
            <tns:sourcedId>20028370</tns:sourcedId>
            <tns:sourcedId>20028368</tns:sourcedId>
            <tns:sourcedId>20028366</tns:sourcedId>
            <tns:sourcedId>20028364</tns:sourcedId>
            <tns:sourcedId>20028362</tns:sourcedId>
            <tns:sourcedId>20028344</tns:sourcedId>
            <tns:sourcedId>20028342</tns:sourcedId>
            <tns:sourcedId>20028340</tns:sourcedId>
            <tns:sourcedId>20027910</tns:sourcedId>
            <tns:sourcedId>20027908</tns:sourcedId>
            <tns:sourcedId>20027906</tns:sourcedId>
            <tns:sourcedId>20027904</tns:sourcedId>
            <tns:sourcedId>20027902</tns:sourcedId>
            <tns:sourcedId>20027900</tns:sourcedId>
            <tns:sourcedId>20027898</tns:sourcedId>
            <tns:sourcedId>20027896</tns:sourcedId>
            <tns:sourcedId>20027894</tns:sourcedId>
            <tns:sourcedId>20027892</tns:sourcedId>
            <tns:sourcedId>20027890</tns:sourcedId>
            <tns:sourcedId>20027888</tns:sourcedId>
            <tns:sourcedId>20027886</tns:sourcedId>
            <tns:sourcedId>20027882</tns:sourcedId>
            <tns:sourcedId>20027880</tns:sourcedId>
            <tns:sourcedId>20027876</tns:sourcedId>
            <tns:sourcedId>20027874</tns:sourcedId>
            <tns:sourcedId>20027872</tns:sourcedId>
            <tns:sourcedId>20027869</tns:sourcedId>
            <tns:sourcedId>20027867</tns:sourcedId>
            <tns:sourcedId>20027864</tns:sourcedId>
            <tns:sourcedId>20027861</tns:sourcedId>
            <tns:sourcedId>20027858</tns:sourcedId>
            <tns:sourcedId>20027856</tns:sourcedId>
            <tns:sourcedId>20027854</tns:sourcedId>
            <tns:sourcedId>20027852</tns:sourcedId>
            <tns:sourcedId>20027850</tns:sourcedId>
            <tns:sourcedId>20027848</tns:sourcedId>
            <tns:sourcedId>20027846</tns:sourcedId>
            <tns:sourcedId>20027844</tns:sourcedId>
            <tns:sourcedId>20027842</tns:sourcedId>
            <tns:sourcedId>20027840</tns:sourcedId>
            <tns:sourcedId>20027838</tns:sourcedId>
            <tns:sourcedId>20027836</tns:sourcedId>
            <tns:sourcedId>20027834</tns:sourcedId>
            <tns:sourcedId>20027832</tns:sourcedId>
            <tns:sourcedId>20027830</tns:sourcedId>
            <tns:sourcedId>20027828</tns:sourcedId>
            <tns:sourcedId>20027826</tns:sourcedId>
            <tns:sourcedId>20027824</tns:sourcedId>
            <tns:sourcedId>20027822</tns:sourcedId>
            <tns:sourcedId>20027820</tns:sourcedId>
            <tns:sourcedId>20027819</tns:sourcedId>
            <tns:sourcedId>20027818</tns:sourcedId>
            <tns:sourcedId>20027817</tns:sourcedId>
            <tns:sourcedId>20027816</tns:sourcedId>
            <tns:sourcedId>20027815</tns:sourcedId>
            <tns:sourcedId>20027814</tns:sourcedId>
            <tns:sourcedId>20027813</tns:sourcedId>
            <tns:sourcedId>20027812</tns:sourcedId>
            <tns:sourcedId>20027811</tns:sourcedId>
            <tns:sourcedId>20027810</tns:sourcedId>
            <tns:sourcedId>20027809</tns:sourcedId>
            <tns:sourcedId>20027808</tns:sourcedId>
            <tns:sourcedId>20027806</tns:sourcedId>
            <tns:sourcedId>20027805</tns:sourcedId>
            <tns:sourcedId>20027804</tns:sourcedId>
            <tns:sourcedId>20027803</tns:sourcedId>
        </tns:sourcedIdSet>
    </tns:readLineItemIdsForCourseSectionResponse>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>