readMembership

Cirrus Assessment Support Team -

Method description

readMembership is the method used to read link information between person and group.

Message schema

Request parameters

Name

Data type

Description

sourcedId

GUID

The syncID of the membership to be read

Response parameters

Name

Data type

Description

membershipRecord

Object

The membership data. See mapping details here

Example

Request message

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ims="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0" xmlns:ims1="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
   <soap:Header>
      <ims:imsx_syncRequestHeaderInfo>
         <ims1:imsx_version>V1.0</ims1:imsx_version>
         <ims1:imsx_messageIdentifier>0123456789</ims1:imsx_messageIdentifier>
      </ims:imsx_syncRequestHeaderInfo>
   </soap:Header>
   <soap:Body>
      <ims:readMembershipRequest>
         <ims:sourcedId>72974e1299c54db0b4eeaf88b8700097</ims:sourcedId>
      </ims:readMembershipRequest>
   </soap:Body>
</soap:Envelope>

Response message

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <a:Action s:mustUnderstand="1">http://www.imsglobal.org/soap/lis/mms2p0/readMembershipResponse</a:Action>
      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0" xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
         <imsx_version xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">V1.0</imsx_version>
         <imsx_statusInfo xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
            <imsx_codeMajor>success</imsx_codeMajor>
            <imsx_severity>status</imsx_severity>
            <imsx_codeMinor>
               <imsx_codeMinorField>
                  <imsx_codeMinorFieldName>TargetEndSystem</imsx_codeMinorFieldName>
                  <imsx_codeMinorFieldValue>fullsuccess</imsx_codeMinorFieldValue>
               </imsx_codeMinorField>
            </imsx_codeMinor>
         </imsx_statusInfo>
      </h:imsx_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>2015-07-27T07:12:32.645Z</u:Created>
            <u:Expires>2015-07-27T07:17:32.645Z</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">
      <readMembershipResponse xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">
         <membershipRecord>
            <sourcedGUID>
               <refAgentInstanceID xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">Cirrus</refAgentInstanceID>
               <sourcedId xmlns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">72974e1299c54db0b4eeaf88b8700097</sourcedId>
            </sourcedGUID>
            <membership>
               <collectionSourcedId>fc364f8901374520b3ba80d1965bc5bf</collectionSourcedId>
               <membershipIdType>group</membershipIdType>
               <member>
                  <personSourcedId>fbdccaf5f5854a84be77731ab33166a5</personSourcedId>
               </member>
            </membership>
         </membershipRecord>
      </readMembershipResponse>
   </s:Body>
</s:Envelope>

Comments 0

Cirrus uses Zendesk to provide our Help Center services. Check out Zendesk's Terms of Service and Privacy Policy, as they govern your use of these services.

Powered by Zendesk