replaceGroup

Method description

A method to completely replace all properties of a group. Can also be used to create a group.

Preconditions for use

You will need to know the syncID of the parent hierarchy where you want to update/add the group in itslearning.

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
<sourcedId ><identifier>	The *syncID* of the group to be updated.	Text	Max 64 chars	M
<group>	The full or partial group object to be updated. Refer to GroupManagement service and the group object for details	Object	Valid (partial) group object	M

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

Response message elements

Name	Description	Data type
replaceGroupResponse	Empty createGroupResponse element	Empty

Comments

If the syncID to update does not exist, itslearning will try to create it. Depending on the data provided, there may or may not be enough data to successfully create the group.

Example

Description

I want to insert or update a group in itslearning.

See also createGroup for more information.

Example request message

This is identical to createGroup requests, only with a different method name

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/gms/xsd/imsGroupManMessSchema_v1p0" xmlns:ims1="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0" xmlns:ims2="http://www.imsglobal.org/services/gms/xsd/imsGroupManDataSchema_v1p0"  xmlns:ims3="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0">
  <soapenv:Header>
      <ims3:syncRequestHeaderInfo>
         <ims3:messageIdentifier>1234567890</ims3:messageIdentifier>
      </ims3:syncRequestHeaderInfo>
   </soapenv:Header>
   <soapenv:Body>
      <ims:replaceGroupRequest>
          <ims:sourcedId>
            <ims1:identifier>YYY</ims1:identifier>
         </ims:sourcedId>
         <ims:group>
            <ims2:groupType>
               <ims2:scheme>ItslearningOrganisationTypes</ims2:scheme>
               <ims2:typeValue>
                   <ims2:type>Unspecified</ims2:type>
                  <ims2:level>-1</ims2:level>
               </ims2:typeValue>
            </ims2:groupType>
            <ims2:relationship>
               <ims2:relation>Child</ims2:relation>
               <ims2:sourceId>
                  <ims1:identifier>AAA</ims1:identifier>
               </ims2:sourceId>
            </ims2:relationship>
            <ims2:description>
               <ims2:descShort>English</ims2:descShort>
               <ims2:descLong>English Language Course for 13-18 yr olds</ims2:descLong>        
               <ims2:descFull>English for 13-18 yr olds</ims2:descFull>
            </ims2:description>
           <ims2:extension>
                  <ims1:extensionField>
                  <ims1:fieldName>course</ims1:fieldName>
                  <ims1:fieldType>String</ims1:fieldType>
                  <ims1:fieldValue>English course</ims1:fieldValue>
               </ims1:extensionField>
               <ims1:extensionField>
                  <ims1:fieldName>course/code</ims1:fieldName>
                  <ims1:fieldType>String</ims1:fieldType>
                  <ims1:fieldValue>ENG13/18</ims1:fieldValue>
               </ims1:extensionField>
            </ims2:extension>
         </ims:group>
      </ims:replaceGroupRequest>
   </soapenv:Body>
</soapenv:Envelope>

Example response message

This is identical to createGroup responses, only with a different method name

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <h:syncResponseHeaderInfo>
         <messageIdentifier>1234567890</messageIdentifier>
         <statusInfo>
            <codeMajor>success</codeMajor>
            <severity>status</severity>
            <messageIdRef>1234567890</messageIdRef>
         </statusInfo>
      </h:syncResponseHeaderInfo>
      <o:Security s:mustUnderstand="1">
         <u:Timestamp u:Id="_0">
            <u:Created>2011-02-03T13:35:24.387Z</u:Created>
            <u:Expires>2011-02-03T13:40:24.387Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body >
      <replaceGroupResponse />
   </s:Body>
</s:Envelope>