changePersonIdentifier

Method description

changePersonIdentifier is the method used to change the syncID of an existing person in itslearning

Preconditions for use

Make sure that the user you are trying to update has an <institutionRoleType> recognized by IMS ES. See transformation table in the general PersonManagement service description for how itslearning profiles are converted to IMS ES <institutionRoleType>.

Message Schema

Input parameters / request message elements

Name	Description	Data type	Allowed values	M/O
<sourcedId><identifier>	the old *syncID* of the person to be updated	Text	Valid SyncID	M
<newsourcedId><identifier>	the new *syncID* of the person to be updated	Text	Valid SyncID	M

Response message elements

Name	Description	Data type
changePersonIdentifierResponse	Empty response element, status conveyed in SOAP header	Empty

Example

Description

I want to change synchronization key (syncID) of a person in itslearning.

Example request message

The following example changes the ID of person 123 to 876

<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>1234567890</ims:messageIdentifier>
        </ims:syncRequestHeaderInfo>
    </soapenv:Header>
    <soapenv:Body>
        <ims1:changePersonIdentifierRequest>
            <ims1:sourcedId>
                <ims2:identifier>123</ims2:identifier>
            </ims1:sourcedId>
            <ims1:newSourcedId>
                <ims2:identifier>876</ims2:identifier>
            </ims1:newSourcedId>
        </ims1:changePersonIdentifierRequest>
    </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-01-27T09:55:33.756Z</u:Created>
                <u:Expires>2011-01-27T10:00:33.756Z</u:Expires>
            </u:Timestamp>
        </o:Security>
    </s:Header>
    <s:Body>
        <changePersonIdentifierResponse/>
    </s:Body>
</s:Envelope>

Troubleshooting and error codes

Error messages

Error message	Cause	Resolution

Other known issues

None