changeGroupIdentifier

Method description

changeGroupIdentifier is the method used to change the syncID of an existing group in itslearning

Preconditions for use

None

Message Schema

This method is not visible in WDSL!

Input parameters / request message elements

Name

Description

Data type

Allowed values

M/O

<sourcedId><identifier>

the old syncID of the group to be updated

Text

Valid SyncID

M

<newsourcedId><identifier>

the new syncID of the group to be updated

Text

Valid SyncID

M

Response message elements

Name

Description

Data type

changeGroupIdentifierResponse

Empty response element, status conveyed in SOAP header

Empty

Example

Description

I want to change the synchronization key (syncID) of a hierarchy group in itslearning:

  1. syncID AAAAA -> syncID AAA

    images/download/attachments/18251827/worddava5fd24ea143909ef4b2330ecebccdaed.png

Example request message

<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">
<soapenv:Header>
<ims:syncRequestHeaderInfo>
<ims:messageIdentifier>id1</ims:messageIdentifier>
</ims:syncRequestHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims1:changeGroupIdentifierRequest>
<ims1:sourcedId>
<ims2:identifier>AAAAA</ims2:identifier>
</ims1:sourcedId>
<ims1:newSourcedId>
<ims2:identifier>AAA</ims2:identifier>
</ims1:newSourcedId>
</ims1:changeGroupIdentifierRequest>
</soapenv:Body>
</soapenv:Envelope>

Example response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<s:Header>
<h:syncResponseHeaderInfo>
<messageIdentifier>id1</messageIdentifier>
<statusInfo>
<codeMajor>success</codeMajor>
<severity>status</severity>
<messageIdRef>id1</messageIdRef>
</statusInfo>
</h:syncResponseHeaderInfo>
<o:Security s:mustUnderstand="1">
<u:Timestamp u:Id="_0">
<u:Created>2011-02-16T16:02:04.160Z</u:Created>
<u:Expires>2011-02-16T16:07:04.160Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
<changeGroupIdentifierResponse/>
</s:Body>
</s:Envelope>