Method description
deleteMemberships is the method to delete one or more sets of persons as members of one or more groups.
Preconditions for use
You will need to know the syncID of the memberships you want to delete.
Message Schema
Input parameters / request message elements
Name | Description | Data type | Allowed values | M/O |
---|---|---|---|---|
<sourcedIdSet> | Wrapper for a list of <identifier> elements | M | ||
<identifier> | The membership SyncID for the memberships to delete | Text | Max 255 characters | M |
Please refer to the WSDL for the full element structure, only key elements are described here
Response message elements
Name | Description | Data type |
---|---|---|
deleteMembershipsResponse | Empty response element | Empty |
Comments
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.
Example
Description
I want to delete the following memberships in itslearning:
- syncID = M2
- syncID = M3
Example request message
<
soapenv
:Envelope
xmlns:soapenv
=
"http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ims
=
"http://www.imsglobal.org/services/mms/xsd/imsMemberManMessSchema_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>1</
ims3
:messageIdentifier>
</
ims3
:syncRequestHeaderInfo>
</
soapenv
:Header>
<
soapenv
:Body>
<
ims
:deleteMembershipsRequest>
<
ims
:sourcedIdSet>
<
ims1
:identifier>M2</
ims1
:identifier>
<
ims1
:identifier>M3</
ims1
:identifier>
</
ims
:sourcedIdSet>
</
ims
:deleteMembershipsRequest>
</
soapenv
:Body>
</
soapenv
:Envelope>
Example response message
<
s
:Envelope
xmlns:s
=
"http://schemas.xmlsoap.org/soap/envelope"
>
<
s
:Header>
<
h
:syncResponseHeaderInfo>
<
messageIdentifier
>1</
messageIdentifier
>
<
statusInfoSet
>
<
statusInfo
>
<
codeMajor
>success</
codeMajor
>
<
severity
>status</
severity
>
<
messageIdRef
>1</
messageIdRef
>
</
statusInfo
>
<
statusInfo
>
<
codeMajor
>success</
codeMajor
>
<
severity
>status</
severity
>
<
messageIdRef
>1</
messageIdRef
>
</
statusInfo
>
</
statusInfoSet
>
</
h
:syncResponseHeaderInfo>
<
o
:Security
s:mustUnderstand
=
"1"
>
<
u
:Timestamp
u:Id
=
"_0"
>
<
u
:Created>2011-02-03T15:11:33.404Z</
u
:Created>
<
u
:Expires>2011-02-03T15:16:33.404Z</
u
:Expires>
</
u
:Timestamp>
</
o
:Security>
</
s
:Header>
<
s
:Body>
<
deleteMembershipsResponse
/>
</
s
:Body>
</
s
:Envelope>