replacePersons

Method description

replacePersons is the method used to update/replace or insert one or more new persons in itslearning. This is a destructive write-over of all of the original information.

Preconditions for use

None.

Message Schema

Input parameters / request message elements

Name

Description

Data type

Allowed values

M/O

<personIdPairSet>

Wrapper for a list of personIdPair elements

M

<personIdPair>

Wrapper for a set of one <sourceId><identifier> and one <person> element

M

<sourceId><identifier>

The syncID of the person to be inserted

Text

Max 64 chars

M

<person>

The Person data to be stored in the new record. Refer to Managing persons for full details on the person object

Object

M

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

Response message elements

Name

Description

Data type

<replacePersonsResponse>

Empty response element

Empty

Comments

If the syncID does not exist in itslearning, the person with the syncID will be inserted instead. You should include complete person objects, as the existing person objects will be completely replaced.

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

See createPersonsRequest

Example request message

See createPersonsRequest.
Same example can be used but replace <ims1:createPersonsRequest> tag with <ims1:replacePersonsRequest>

Example response message

See createPersonsRequest