readMembership

Method description

readMembership is the method to retrieve a single member of a single group.

Preconditions for use

You will need to know the syncID of the previously created membership.

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
<sourcedId><identifier>	The unique membership syncID for this group / person mapping	Text	Max 255 characters	M

Please refer to the WSDL for the full element structure, only key elements are described here

Response message elements

Name	Description	Data type
readMembershipResponse	Empty response element	Empty

Example

Description

I want to read the membership set with with syncID = M1

Example request message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/mms/xsd/imsMemberManMessSchema_v1p0" xmlns:ims1="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0" xmlns:ims3="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0">
    <soapenv:Header>
        <ims3:syncRequestHeaderInfo>
            <ims3:messageIdentifier>1</ims3:messageIdentifier>
        </ims3:syncRequestHeaderInfo>
    </soapenv:Header>
    <soapenv:Body>
        <ims:readMembershipRequest>
            <ims:sourcedId>
                <ims1:identifier>M1</ims1:identifier>
            </ims:sourcedId>
        </ims:readMembershipRequest>
    </soapenv:Body>
</soapenv:Envelope>

Example response message

Result: One group (G1) with one member (99998888) is returned.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Header>
        <h:syncResponseHeaderInfo>
            <messageIdentifier>1</messageIdentifier>
            <statusInfo>
                <codeMajor>success</codeMajor>
                <severity>status</severity>
                <messageIdRef>1</messageIdRef>
            </statusInfo>
        </h:syncResponseHeaderInfo>
        <o:Security s:mustUnderstand="1">
            <u:Timestamp u:Id="_0">
                <u:Created>2011-02-03T15:17:48.864Z</u:Created>
                <u:Expires>2011-02-03T15:22:48.864Z</u:Expires>
            </u:Timestamp>
        </o:Security>
    </s:Header>
    <s:Body>
        <readMembershipResponse>
            <membership>
                <groupSourcedId>
                    <identifier>G1</identifier>
                </groupSourcedId>
                <member>
                    <memberSourcedId>
                        <identifier>99998888</identifier>
                    </memberSourcedId>
                    <role>
                        <roleType>Learner</roleType>
                    </role>
                </member>
            </membership>
        </readMembershipResponse>
    </s:Body>
</s:Envelope>