deleteGroup

Method description

This method will delete the group with the given syncID

Preconditions for use

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

Message Schema

Input parameters / request message elements

Name

Description

Data type

Allowed values

M/O

sourcedId/identifier

ID of the group to delete

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

Response message elements

Name

Description

Data type

deleteGroupResponse

Empty response element, status carried in SOAP header

Empty

Comments

All child and descendant groups of the group 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 a group in itslearning with syncID = III

images/plugins/servlet/confluence/placeholder/unknown-attachment

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:deleteGroupRequest>
<ims:sourcedId>
<ims1:identifier>HHH</ims1:identifier>
</ims:sourcedId>
</ims:deleteGroupRequest>
</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-03T10:15:12.715Z</u:Created>
<u:Expires>2011-02-03T10:20:12.715Z</u:Expires>
</u:Timestamp>
</o:Security>
</s:Header>
<s:Body>
<deleteGroupResponse/>
</s:Body>
</s:Envelope>