readMembershipsForGroup

Method description

readMembershipsForGroup is the method to retrieve all memberships that include given group

Preconditions for use

You will need to know the syncID for the group you want to read memberships for.

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
<groupSourcedID><identifier>	The group SyncID for the memberships to read	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
<membershipIdPairSet>	Wrapper for a list of <membershipIdPair> elements (multiple membership sets may apply to the same group)
<membershipIdPair>	Wrapper for a set of one <sourcedId><identifier> element and one <membership> element.
<sourcedId><identifier>	A unique identifier for this set of group / person mappings	Text
<membership>	Wrapper element for one <groupSourcedId ><identifier> element and one or more <member> elements
<membership><groupSourcedId ><identifier>	The syncID for the group in which the requested person is a member	Text
<membership><member><memberSourcedId ><identifier>	The syncID for the person	Text
<membership><member><role><roleType>	The role of the person in the group.	Text

If the membership does not have any syncID in itslearning at the time you do the request, a syncID for the membership is autogenerated and stored on the membership in itslearning. This syncID will have the format 'itsla-<GUID>'.

This allows itslearning to return memberships that were created through the UI, and that the external system would not know about.

Also note that persons may be returned that have an empty ID. These are users created through the UI that have not been given a syncID.

Example

Description

I want to read all memberships related to hierarchy group with syncID = 'DDD'

Group with syncID = 'DDD' has 15 members in itslearning:

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:readMembershipsForGroupRequest>
            <ims:groupSourcedId>
                <ims1:identifier>DDD</ims1:identifier>
            </ims:groupSourcedId>
        </ims:readMembershipsForGroupRequest>
    </soapenv:Body>
</soapenv:Envelope>

Example response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <s:Header>
        <h:syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0" xmlns="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <messageIdentifier>1</messageIdentifier>
            <statusInfoSet>
                <statusInfo>
                    <codeMajor>success</codeMajor>
                    <severity>status</severity>
                    <messageIdRef>1</messageIdRef>
                </statusInfo>
            </statusInfoSet>
        </h:syncResponseHeaderInfo>
        <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <u:Timestamp u:Id="_0">
                <u:Created>2013-07-26T08:40:37.092Z</u:Created>
                <u:Expires>2013-07-26T08:45:37.092Z</u:Expires>
            </u:Timestamp>
        </o:Security>
    </s:Header>
    <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <readMembershipsForGroupResponse xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManMessSchema_v1p0">
            <membershipIDPairSet>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-b1efdf3a-bd7b-4ca0-9bcc-71ad16a8dd00</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-a4470638-bd5a-4851-b8d7-d952d101bf2a</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-88b63599-b16e-4839-97af-f9fc581fba28</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-0f50f55a-7507-4e2e-97bb-ad21fad7635d</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-2ad40644-2304-4d0d-891f-790517b3ce1c</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-07c27dcf-d66a-4cd8-8f2b-11b362a3923f</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-39986b90-7275-4240-a11a-1f4681a5bc1f</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-0ed4b357-2a9d-441f-aa1f-3b45d93ae3f8</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId>
                                <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">aStu155</identifier>
                            </memberSourcedId>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-e991b191-3dc7-44c2-9eab-3b730e1682b9</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-0371aa79-193e-49e1-9924-dbc060a203aa</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-20a060f4-a8f1-4dcd-a2b5-c5c6e6a3accb</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-4947f130-3869-44dd-8551-8053739d2995</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-d660566c-6419-4cab-96f7-97c7c4f66992</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-677b5414-23c1-4087-b1b3-bb1db18a3592</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
                <membershipIdPair>
                    <sourcedId>
                        <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">itsla-0dce9cf0-cd6e-403a-922c-4739bcfd8286</identifier>
                    </sourcedId>
                    <membership>
                        <groupSourcedId xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <identifier xmlns="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0">DDD</identifier>
                        </groupSourcedId>
                        <member xmlns="http://www.imsglobal.org/services/mms/xsd/imsMemberManDataSchema_v1p0">
                            <memberSourcedId/>
                            <role>
                                <roleType>Learner</roleType>
                            </role>
                        </member>
                    </membership>
                </membershipIdPair>
            </membershipIDPairSet>
        </readMembershipsForGroupResponse>
    </s:Body>
</s:Envelope>