deletePerson
Method description
deletePerson is the method used to delete a single existing person in itslearning
Preconditions for use
You need to know the syncID of the person to delete.
Message Schema
Input parameters / request message elements
Name | Description | Data type | Allowed values | M/O |
---|---|---|---|---|
<sourcedId><identifier> | The syncID of the person to be deleted | Text | Valid SyncID | M |
Response message elements
Name | Description | Data type |
---|---|---|
deletePersonResponse | Empty response element, status conveyed in SOAP header | Empty |
Example
Description
I want to delete a person in itslearning with syncID /synchronization key = 876.
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/pms/xsd/imsPersonManMessSchema_v1p0"
xmlns:ims2
=
"http://www.imsglobal.org/services/common/imsCommonSchema_v1p0"
>
<
soapenv
:Header>
<
ims
:syncRequestHeaderInfo>
<
ims
:messageIdentifier>1</
ims
:messageIdentifier>
</
ims
:syncRequestHeaderInfo>
</
soapenv
:Header>
<
soapenv
:Body>
<
ims1
:deletePersonRequest>
<
ims1
:sourcedId>
<
ims2
:identifier>876</
ims2
:identifier>
</
ims1
:sourcedId>
</
ims1
:deletePersonRequest>
</
soapenv
:Body>
</
soapenv
:Envelope>
Example response message
<
s
:Envelope
xmlns:s
=
"http://schemas.xmlsoap.org/soap/envelope/"
>
<
s
:Header>
<
h
:syncResponseHeaderInfo>
<
messageIdentifier
>1</
messageIdentifier
>
<
statusInfo
>
<
codeMajor
>success</
codeMajor
>
<
severity
>status</
severity
>
<
messageIdRef
>1</
messageIdRef
>
</
statusInfo
>
</
h
:syncResponseHeaderInfo>
<
o
:Security
s:mustUnderstand
=
"1"
>
<
u
:Timestamp
u:Id
=
"_0"
>
<
u
:Created>2011-02-01T13:37:35.342Z</
u
:Created>
<
u
:Expires>2011-02-01T13:42:35.342Z</
u
:Expires>
</
u
:Timestamp>
</
o
:Security>
</
s
:Header>
<
s
:Body
xmlns:xsi
=
"http://www.w3.org/2001/XMLSchema-instance"
>
<
deletePersonResponse
/>
</
s
:Body>
</
s
:Envelope>