Read Membership IDs For Collection

Functional Overview

This function may be used to retrieve the instructors and enrolled students for a course in Turnitin.

readMembershipIdsForCollection

This function takes a class ID and returns all membership information associated with it. If the class ID is found and is associated with this account and API product then the membership IDs for all relationships with this class are returned in the response message.

If the class ID is not found or is not associated with this account and API product then an error is returned in the SOAP response message.

Parameters

Required:

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

Optional:

none: //

Outputs

sourceId: //integer. max size xxx. unique identifier for users (instructors and students)
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 readMembershipIdsForCollection 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/mms2p0/readMembershipIdsForCollection"
    Content-length: 759
    Source: 12
    Authorization: OAuth oauth_nonce="c639f0ee5fe029972687d8c917eced28fff4f3b4",
         oauth_timestamp="1337867280",
         oauth_consumer_key="49201",
         oauth_signature_method="HMAC-SHA1",
         oauth_version="1.0",
         oauth_body_hash="6LVUdW6DCIpYHNDJNeKUeZOHGQ4%3D",
         oauth_signature="%2BQ9BlOFxXhrq2mV0%2BRJWQU2DXpA%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/mms2p0/wsdl11/sync/imsmms_v2p0" xmlns:ns2="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>9aa07a34-8332-444e-9b07-db2c89923a60</ns1:imsx_messageIdentifier>
        </ns1:imsx_syncRequestHeaderInfo>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <ns1:readMembershipIdsForCollectionRequest>
            <ns1:groupSourcedId>20005116</ns1:groupSourcedId>
            <ns1:collection>courseSection</ns1:collection>
        </ns1:readMembershipIdsForCollectionRequest>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>

Example readMembershipIdsForCollection 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/mms2p0/wsdl11/sync/imsmms_v2p0">
        <tns:imsx_version>V1.0</tns:imsx_version>
        <tns:imsx_messageIdentifier>FB913478-A59C-11E1-86A0-ACB9EFE76FDE</tns:imsx_messageIdentifier>
        <tns:imsx_statusInfo>
            <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
            <tns:imsx_severity>status</tns:imsx_severity>
            <tns:imsx_messageRefIdentifier>9aa07a34-8332-444e-9b07-db2c89923a60</tns:imsx_messageRefIdentifier>
            <tns:imsx_description>14 Membership Objects 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:readMembershipIdsForCollectionResponse xmlns:tns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">
        <tns:sourcedIdSet>
            <tns:sourcedId>18650</tns:sourcedId>
            <tns:sourcedId>18648</tns:sourcedId>
            <tns:sourcedId>18646</tns:sourcedId>
            <tns:sourcedId>18644</tns:sourcedId>
            <tns:sourcedId>18643</tns:sourcedId>
            <tns:sourcedId>18642</tns:sourcedId>
            <tns:sourcedId>18641</tns:sourcedId>
            <tns:sourcedId>18640</tns:sourcedId>
            <tns:sourcedId>18639</tns:sourcedId>
            <tns:sourcedId>18638</tns:sourcedId>
            <tns:sourcedId>18637</tns:sourcedId>
            <tns:sourcedId>18636</tns:sourcedId>
            <tns:sourcedId>18635</tns:sourcedId>
            <tns:sourcedId>18634</tns:sourcedId>
        </tns:sourcedIdSet>
    </tns:readMembershipIdsForCollectionResponse>
    </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>