changeGroupsIdentifier

Method description

changeGroupsIdentifier is the method used to change the syncID of one or more existing groups in itslearning

Preconditions for use

None

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
identifierPair	An identifierPair element contains data on one group, repeat for more groups.		One <firstId> and one <secondID> element	M
identifierPair/firstId	the old *syncID* of the group to be updated	Text	Valid SyncID	M
identifierPair/secondId	the new *syncID* of the groupto be updated	Text	Valid SyncID	M

Response message elements

Name	Description	Data type
changeGroupsIdentifierResponse	Empty response element, status conveyed in SOAP header	Empty

Comments

For each <IdentifierPair in the request you will get a status in the <statusinfoSet><status> in the response. The order of the <statusInfoset><status> corresponds to the the order of the <IdentifierPair> in the request.

Example

Description

I want to change the synchronization key (syncID) of 3 groups in itslearning:

syncID AAAAA -> syncID AAA
syncID BBBBB -> syncID BBB
syncID CCCCC -> syncID CCC

Example request message

<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/common/imsMessBindSchema_v1p0">
    <soapenv:Header>
        <ims2:syncRequestHeaderInfo>
            <ims2:messageIdentifier>1234567890</ims2:messageIdentifier>
        </ims2:syncRequestHeaderInfo>
    </soapenv:Header>
    <soapenv:Body>
        <ims:changeGroupsIdentifierRequest>
            <ims:pairSourcedIdSet>
                <ims1:identifierPair>
                    <ims1:firstId>AAAAA</ims1:firstId>
                    <ims1:secondId>AAA</ims1:secondId>
                </ims1:identifierPair>
                <ims1:identifierPair>
                    <ims1:firstId>BBBBB</ims1:firstId>
                    <ims1:secondId>BBB</ims1:secondId>
                </ims1:identifierPair>
                <ims1:identifierPair>
                    <ims1:firstId>CCCCC</ims1:firstId>
                    <ims1:secondId>CCC</ims1:secondId>
                </ims1:identifierPair>
            </ims:pairSourcedIdSet>
        </ims:changeGroupsIdentifierRequest>
    </soapenv:Body>
</soapenv:Envelope>

Example response message

In the example below, the third <IdentifierPair> fails because the syncID in<IdentifierPair><SecondId> already exists in itslearning,.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Header>
        <h:syncResponseHeaderInfo>
            <messageIdentifier>1234567890</messageIdentifier>
            <statusInfoSet>
                <statusInfo>
                    <codeMajor>success</codeMajor>
                    <severity>status</severity>
                    <messageIdRef>1234567890</messageIdRef>
                </statusInfo>
                <statusInfo>
                    <codeMajor>success</codeMajor>
                    <severity>status</severity>
                    <messageIdRef>1234567890</messageIdRef>
                </statusInfo>
                <statusInfo>
                    <codeMajor>failure</codeMajor>
                    <severity>error</severity>
                    <codeMinor>
                        <codeMinorField>
                            <codeMinorName>groupmanagement</codeMinorName>
                            <codeMinorValue>idallocinusefail</codeMinorValue>
                        </codeMinorField>
                    </codeMinor>
                    <messageIdRef>1234567890</messageIdRef>
                    <description>
                        <language>en-US</language>
                        <text>Itslearning could not allocate the unique 'identifier' to the record because the identifier is already in use.</text>
                    </description>
                </statusInfo>
            </statusInfoSet>
        </h:syncResponseHeaderInfo>
        <o:Security s:mustUnderstand="1 ">
            <u:Timestamp u:Id="_0">
                <u:Created>2011-02-02T15:36:17.509Z</u:Created>
                <u:Expires>2011-02-02T15:41:17.509Z</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">
        <changeGroupsIdentifierResponse/>
    </s:Body>
</s:Envelope>