updatePerson

Method description

updatePerson is the method used to write new content into the identified 'person' record in itslearning. This is an additive operation. If the person to update does not exist, itslearning will try to create the person instead

Preconditions for use

None.

Message Schema

Input parameters / request message elements

Name

Description

Data type

Allowed values

M/O

<sourceId><identifier>

The syncID of the person to be replaced

Text

Max 64 chars

M

<person>

The complete or partial person object to be updated. 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

updatePersonResponse

Empty response element

Empty

Comments

You should provide the request with all mandatory fields for a person, not only the fields you want to update. If the syncID does not exist in itslearning, the person with the syncId will be created instead.

Example

Description

I want to update a person with syncId 33333 in itslearning

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" xmlns:ims3="http://www.imsglobal.org/services/pms/xsd/imsPersonManDataSchema_v1p0">
<soapenv:Header>
<ims:syncRequestHeaderInfo>
<ims:messageIdentifier>1234567890</ims:messageIdentifier>
</ims:syncRequestHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims1:updatePersonRequest>
<ims1:sourcedId>
<ims2:identifier>33333</ims2:identifier>
</ims1:sourcedId>
<ims1:person>
<ims3:formatName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ims3:name>
<ims3:partName>
<ims3:namePartType>First</ims3:namePartType>
<ims3:namePartValue>Marylin</ims3:namePartValue>
</ims3:partName>
<ims3:partName>
<ims3:namePartType>Last</ims3:namePartType>
<ims3:namePartValue>Monroe</ims3:namePartValue>
</ims3:partName>
<ims3:partName>
<ims3:namePartType>Nick</ims3:namePartType>
<ims3:namePartValue>Nickname</ims3:namePartValue>
</ims3:partName>
</ims3:name>
<ims2:email>marylin@mail.com</ims2:email>
<ims3:userId>
<ims2:userIdValue>marmon</ims2:userIdValue>
<ims2:passWord>123</ims2:passWord>
</ims3:userId>
<ims3:address>
<ims3:street>Firststreet</ims3:street>
<ims3:street>Secondstreet</ims3:street>
</ims3:address>
<ims3:demographics>
<ims3:bday>1926-06-01</ims3:bday>
</ims3:demographics>
<ims3:institutionRole>
<ims3:institutionRoleType>Student</ims3:institutionRoleType>
<ims3:primaryRoleType>true</ims3:primaryRoleType>
</ims3:institutionRole>
<ims3:tel>
<ims3:telType>Mobile</ims3:telType>
<ims3:telValue>7412689</ims3:telValue>
</ims3:tel>
<ims3:tel>
<ims3:telType>Voice</ims3:telType>
<ims3:telValue>55567645</ims3:telValue>
</ims3:tel>
</ims1:person>
</ims1:updatePersonRequest>
</soapenv:Body>
</soapenv:Envelope>

Example response message

<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>
<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-08T08:31:38.939Z</u:Created>
<u:Expires>2011-02-08T08:36:38.939Z</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">
<updatePersonResponse/>
</s:Body>
</s:Envelope>