deleteGroups

Method description

This method will delete the groups with the given syncIDs and all corresponding memberships

Preconditions for use

You will need to know the syncIDs of the group you want to delete.

Message Schema

Input parameters / request message elements

Name

Description

Data type

Allowed values

M/O

sourcedIdSet

Wrapper element for list of identifiers

Identifier elements

M

sourcedIdSet/identifier

ID of the group to delete

Text

M

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

Response message elements

Name

Description

Data type

deleteGroupsResponse

Empty response element, status carried in SOAP header

Empty

Comments

All child and descendant groups of the groups you delete, will also be deleted.

Courses connected to the groups you delete will not be deleted, but will be disconnected from the deleted groups. Hence, they will act as manually created courses in itslearning.

Deleting a will automatically delete memberships for the group (including children and descendants)

Example

Description

I want to delete the following groups in itslearning:

  • syncID AAA

  • syncID RRR (has already been deleted=

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: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:deleteGroupsRequest>
<ims:sourcedIdSet>
<ims1:identifier>AAA</ims1:identifier>
<ims1:identifier>RRR</ims1:identifier>
</ims:sourcedIdSet>
</ims:deleteGroupsRequest>
</soapenv:Body>
</soapenv:Envelope>

Example response message

For each <identifier> 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 <identifier> in the request.

<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>1234567890</messageIdentifier>
<statusInfoSet>
<statusInfo>
<codeMajor>success</codeMajor>
<severity>status</severity>
<messageIdRef>1234567890</messageIdRef>
</statusInfo>
<statusInfo>
<codeMajor>success</codeMajor>
<severity>warning</severity>
<codeMinor>
<codeMinorField>
<codeMinorName>groupmanagement</codeMinorName>
<codeMinorValue>alreadydeleted</codeMinorValue>
</codeMinorField>
</codeMinor>
<messageIdRef>1234567890</messageIdRef>
<description>
<language>en-US</language>
<text>Object has been already deleted</text>
</description>
</statusInfo>
</statusInfoSet>
</h:syncResponseHeaderInfo>
<o:Security s:mustUnderstand="1">
<u:Timestamp u:Id="_0">
<u:Created>2011-02-17T10:10:56.390Z</u:Created>
<u:Expires>2011-02-17T10:15:56.390Z</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">
<deleteGroupsResponse/>
</s:Body>
</s:Envelope>