createByProxyMembership

Cirrus Assessment Support Team -

Method description

createByProxyMembership is the method used to add person as member to a specified group. The difference with createMembership method is that you don't need to provide syncId.

Message schema

Request parameters

Name

Data type

Description

membershipRecord

Object

The membership object. See mapping details here

Response parameters

Name

Data type

Description

sourcedId

GUID

The syncId of a new membership object

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" xmlns:ims2="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_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:createByProxyMembershipRequest>
         <ims:membershipRecord>
            <ims:sourcedGUID>
               <ims1:refAgentInstanceID>YourSystemName</ims1:refAgentInstanceID>
               <ims1:sourcedId>00000000000000000000000000000000</ims1:sourcedId>
            </ims:sourcedGUID>
            <ims:membership>
               <ims:collectionSourcedId>
                   fc364f8901374520b3ba80d1965bc5bf
               </ims:collectionSourcedId>
               <ims:membershipIdType>group</ims:membershipIdType>
               <ims:member>
                  <ims:personSourcedId>fbdccaf5f5854a84be77731ab33166a5</ims:personSourcedId>
               </ims:member>
            </ims:membership>
         </ims:membershipRecord>
      </ims:createByProxyMembershipRequest>
   </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/createByProxyMembershipResponse</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-24T12:50:37.946Z</u:Created>
            <u:Expires>2015-07-24T12:55:37.946Z</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">
      <createByProxyMembershipResponse xmlns="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_v2p0">
         <sourcedId>cd5640d5f78841b48bc9c314f976e791</sourcedId>
      </createByProxyMembershipResponse>
   </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