Read ResultIDs For LineItem

Functional Overview

This function may be used to retrieve the IDs for all papers submitted to an assignment in Turnitin.

readResultIdsForLineItem

This function takes an assignment ID and returns the paper IDs for all submissions that have been made to that assignment, if the assignment is not associated with this Turnitin account and API product an error is returned.

If the assignment ID is found and is associated with this account and API product then a successful SOAP response message is returned containing all of the paper IDs that have been submitted to this assignment.

Parameters

Required:

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

Optional:

none: //

Outputs

sourceId: //integer. max size xxx. unique identifier for document/paper
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 readResultIdsForLineItem 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/readResultIdsForLineItem"
    Content-length: 626
    Source: 12
    Authorization: OAuth oauth_nonce="09f291348fef5c62a9797be62d914ea894bcf69d",
         oauth_timestamp="1337943358",
         oauth_consumer_key="49201",
         oauth_signature_method="HMAC-SHA1",
         oauth_version="1.0",
         oauth_body_hash="7E9q5L6amTiLrvGDn95GzgqB%2FI8%3D",
         oauth_signature="z1jWJaqntUx1wTBcgRAFzlgL4cc%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>a0383f1f-2262-43d7-a152-1dbf36b820ea</ns1:imsx_messageIdentifier>
        </ns1:imsx_syncRequestHeaderInfo>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <ns1:readResultIdsForLineItemRequest>
            <ns1:lineItemSourcedid>20028310</ns1:lineItemSourcedid>
        </ns1:readResultIdsForLineItemRequest>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>

Example readResultIdsForLineItem 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>77B77184-A656-11E1-BBEA-38B8EFE76FDE</tns:imsx_messageIdentifier>
        <tns:imsx_statusInfo>
            <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
            <tns:imsx_severity>status</tns:imsx_severity>
            <tns:imsx_messageRefIdentifier>a0383f1f-2262-43d7-a152-1dbf36b820ea</tns:imsx_messageRefIdentifier>
            <tns:imsx_description>26 Object Results 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:readResultIdsForLineItemResponse xmlns:tns="http://www.imsglobal.org/services/lis/oms1p0/wsdl11/sync/imsoms_v1p0">
        <tns:sourcedIdSet>
            <tns:sourcedId>49313810</tns:sourcedId>
            <tns:sourcedId>49313811</tns:sourcedId>
            <tns:sourcedId>49313812</tns:sourcedId>
            <tns:sourcedId>49313813</tns:sourcedId>
            <tns:sourcedId>49313815</tns:sourcedId>
            <tns:sourcedId>49313816</tns:sourcedId>
            <tns:sourcedId>49313817</tns:sourcedId>
            <tns:sourcedId>49313818</tns:sourcedId>
            <tns:sourcedId>49313819</tns:sourcedId>
            <tns:sourcedId>49313820</tns:sourcedId>
            <tns:sourcedId>49313821</tns:sourcedId>
            <tns:sourcedId>49313822</tns:sourcedId>
            <tns:sourcedId>49313823</tns:sourcedId>
            <tns:sourcedId>49313824</tns:sourcedId>
            <tns:sourcedId>49313826</tns:sourcedId>
            <tns:sourcedId>49313827</tns:sourcedId>
            <tns:sourcedId>49313828</tns:sourcedId>
            <tns:sourcedId>49313829</tns:sourcedId>
            <tns:sourcedId>49313830</tns:sourcedId>
            <tns:sourcedId>49313831</tns:sourcedId>
            <tns:sourcedId>49313832</tns:sourcedId>
            <tns:sourcedId>49313833</tns:sourcedId>
            <tns:sourcedId>49313834</tns:sourcedId>
            <tns:sourcedId>49313835</tns:sourcedId>
            <tns:sourcedId>49313836</tns:sourcedId>
            <tns:sourcedId>49313837</tns:sourcedId>
        </tns:sourcedIdSet>
    </tns:readResultIdsForLineItemResponse>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>