updateGroup

Method description

A method to update one or more 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
updateGroupResponse	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 update the title for the existing hierarchy group with syncID ZZZ in itslearning: from title 'English' to title 'New title for English"

Example request message

You need to add a <relationship> element to the request with correct syncID of the parent hierarchy, even though this does not change.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/common/imsMessBindSchema_v1p0" xmlns:ims1="http://www.imsglobal.org/services/gms/xsd/imsGroupManMessSchema_v1p0" xmlns:ims2="http://www.imsglobal.org/services/common/imsCommonSchema_v1p0" xmlns:ims3="http://www.imsglobal.org/services/gms/xsd/imsGroupManDataSchema_v1p0">
    <soapenv:Header>
        <ims:syncRequestHeaderInfo>
            <ims:messageIdentifier>1234567890</ims:messageIdentifier>
        </ims:syncRequestHeaderInfo>
    </soapenv:Header>
    <soapenv:Body>
        <ims1:updateGroupRequest>
            <ims1:sourcedId>
                <ims2:identifier>ZZZ</ims2:identifier>
            </ims1:sourcedId>
            <ims1:group>
                <ims3:relationship>
                    <ims3:relation>Parent</ims3:relation>
                    <ims3:sourceId>
                        <ims2:identifier>AAA</ims2:identifier>
                    </ims3:sourceId>
                </ims3:relationship>
                <ims3:description>
                    <ims3:descShort>New title for 'English'</ims3:descShort>
                </ims3:description>
            </ims1:group>
        </ims1:updateGroupRequest>
    </soapenv:Body>
</soapenv:Envelope>

Example response message

<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:48:32.942Z</u:Created>
                <u:Expires>2011-02-03T13:53:32.942Z</u:Expires>
            </u:Timestamp>
        </o:Security>
    </s:Header>
    <s:Body>
        <updateGroupResponse/>
    </s:Body>
</s:Envelope>