updateGroup

Cirrus Assessment Support Team -

Method description

updateGroup is the method used to update group information in Cirrus.

Message schema

Request parameters

Name

Data type

Description

sourcedId

GUID

The syncID of the group to be updated

groupRecord

Object

The group data. See mapping details here

Response parameters

Empty.

Example

Request message

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ims="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0" xmlns:ims1="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0" xmlns:ims2="http://www.imsglobal.org/services/lis/mms2p0/wsdl11/sync/imsmms_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:updateGroupRequest>
         <ims:sourcedId>2c942c76414e43cc962f90de28116dc4</ims:sourcedId>
         <ims:groupRecord>
            <ims:sourcedGUID>
               <ims1:refAgentInstanceID>YourSystemName</ims1:refAgentInstanceID>
               <ims1:sourcedId>2c942c76414e43cc962f90de28116dc4</ims1:sourcedId>
            </ims:sourcedGUID>
            <ims:group>
               <ims:groupType>
                  <ims:typevalue>
                     <ims:type>
                        <ims1:textString>Group</ims1:textString>
                     </ims:type>
                  </ims:typevalue>
               </ims:groupType>
               <ims:org>
                  <ims:orgName>
                     <ims1:textString>Course A Group C</ims1:textString>
                  </ims:orgName>
               </ims:org>
               <ims:extension>
                  <ims1:extensionField>
                     <ims1:fieldName>OrganisationAdress</ims1:fieldName>
                     <ims1:fieldType>String</ims1:fieldType>
                     <ims1:fieldValue>London</ims1:fieldValue>
                  </ims1:extensionField>
               </ims:extension>
            </ims:group>
         </ims:groupRecord>
      </ims:updateGroupRequest>
   </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/gms2p0/updateGroupResponse</a:Action>
      <h:imsx_syncResponseHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0" xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_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-23T07:29:19.192Z</u:Created>
            <u:Expires>2015-07-23T07:34:19.192Z</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">
      <updateGroupResponse xmlns="http://www.imsglobal.org/services/lis/gms2p0/wsdl11/sync/imsgms_v2p0"/>
   </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