This API is under construction. Some of the details documented here may change.

Update Person

Functional Overview

This function may be used to update a user's first or last name. The APi does not support updating a user's email address

Coming Soon: A change to user email address requires user verification, via email notification. Upon a successful API call, Turnitin will send the user an email at the old email address with a link to confirm the change in email address. Upon user verification, the email will be changed to the new address. Requests to change a user email address to one already in use within Turnitin will result in an error.

updatePerson

This function takes a request containing a user's Turnitin User ID, firstname, lastname, email address and default user type and updates the Turnitin user associated with this Turnitin account using the User ID in the request. If the User ID is not associated with this Turnitin account or a user with this User ID is not found then an error is returned in the SOAP response.

If a user with this Turnitin User ID and associated with this Turnitin account is found then the user's data is updated with the data sent in the request.

Parameters

Required:
Email
//string. max size xxx. Email address for user
First
//string. max size xxx. First name of user.
Last
//string. max size xxxx. Last name of user.
Role
//string. max size xxxx. Default role for user.
Optional:
none
//

Outputs

codeMajor
//string. max size xxx. returns "success" or "Failure"
codeMinor
//string. max siz xxx. returns "success", "partial success", "error"
description
//string. max siz xxx. description of successful action completed OR error encountered

Error Codes & Text

CodeText
XXX "description"
XXX "description"
XXX "description"

Example updatePerson SOAP Request
  Content-type: text/xml;charset="utf-8"
  Accept: text/xml
  Cache-Control: no-cache
  Pragma: no-cache
  SOAPAction: "http://www.imsglobal.org/soap/lis/pms2p0/updatePerson"
  Content-length: 3710
  Source: 12
  Authorization: OAuth oauth_nonce="74196eeacb8b36f828d4c1261b02d2bcd584c80e",
       oauth_timestamp="1337786337",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="4X6PSI8UrNdydBaICtyqccBFoZY%3D",
       oauth_signature="1NHGiicEtGmOnZTEzBeYjBeoKxo%3D"

  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
  <SOAP-ENV:Header>
      <ns1:imsx_syncRequestHeaderInfo>
          <ns1:imsx_version>V1.0</ns1:imsx_version>
          <ns1:imsx_messageIdentifier>a428f832-9d21-4c80-a9a0-a26838afe4eb</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:updatePersonRequest>
          <ns1:sourcedId>100012263</ns1:sourcedId>
          <ns1:personRecord>
              <ns1:sourcedGUID>
                  <ns1:sourcedId>100012263</ns1:sourcedId>
              </ns1:sourcedGUID>
              <ns1:person>
                  <ns1:name>
                      <ns1:nameType>
                          <ns1:instanceIdentifier>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>1</ns1:textString>
                          </ns1:instanceIdentifier>
                          <ns1:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/nametypevocabularyv1p0.xml</ns1:instanceVocabulary>
                          <ns1:instanceValue>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>Contact</ns1:textString>
                          </ns1:instanceValue>
                      </ns1:nameType>
                      <ns1:partName>
                          <ns1:instanceIdentifier>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>1</ns1:textString>
                          </ns1:instanceIdentifier>
                          <ns1:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/partnamevocabularyv1p0.xml</ns1:instanceVocabulary>
                          <ns1:instanceName>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>First</ns1:textString>
                          </ns1:instanceName>
                          <ns1:instanceValue>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>Demo</ns1:textString>
                          </ns1:instanceValue>
                      </ns1:partName>
                      <ns1:partName>
                          <ns1:instanceIdentifier>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>2</ns1:textString>
                          </ns1:instanceIdentifier>
                          <ns1:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/partnamevocabularyv1p0.xml</ns1:instanceVocabulary>
                          <ns1:instanceName>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>Last</ns1:textString>
                          </ns1:instanceName>
                          <ns1:instanceValue>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>Student</ns1:textString>
                          </ns1:instanceValue>
                      </ns1:partName>
                  </ns1:name>
                  <ns1:contactinfo>
                      <ns1:contactinfoType>
                          <ns1:instanceIdentifier>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>1</ns1:textString>
                          </ns1:instanceIdentifier>
                          <ns1:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/contactinfotypevocabularyv1p0.xml</ns1:instanceVocabulary>
                          <ns1:instanceValue>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>EmailWorkPrimary</ns1:textString>
                          </ns1:instanceValue>
                      </ns1:contactinfoType>
                      <ns1:contactinfoValue>
                          <ns1:language>en-US</ns1:language>
                          <ns1:textString>demo.student.1337786332@turnitin.com</ns1:textString>
                      </ns1:contactinfoValue>
                  </ns1:contactinfo>
                  <ns1:roles>
                      <ns1:enterpriserolesType>
                          <ns1:instanceIdentifier>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>1</ns1:textString>
                          </ns1:instanceIdentifier>
                          <ns1:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/epriserolestypevocabularyv1p0.xml</ns1:instanceVocabulary>
                          <ns1:instanceName>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>Other</ns1:textString>
                          </ns1:instanceName>
                          <ns1:instanceValue>
                              <ns1:language>en-US</ns1:language>
                              <ns1:textString>Other</ns1:textString>
                          </ns1:instanceValue>
                      </ns1:enterpriserolesType>
                      <ns1:institutionRole>
                          <ns1:institutionroletype>
                              <ns1:instanceIdentifier>
                                  <ns1:language>en-US</ns1:language>
                                  <ns1:textString>1</ns1:textString>
                              </ns1:instanceIdentifier>
                              <ns1:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/institutionroletypevocabularyv1p0.xml</ns1:instanceVocabulary>
                              <ns1:instanceValue>
                                  <ns1:language>en-US</ns1:language>
                                  <ns1:textString>Learner</ns1:textString>
                              </ns1:instanceValue>
                          </ns1:institutionroletype>
                          <ns1:primaryroletype>true</ns1:primaryroletype>
                      </ns1:institutionRole>
                  </ns1:roles>
              </ns1:person>
          </ns1:personRecord>
      </ns1:updatePersonRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>
Example updatePerson SOAP Response
  <?xml version="1.0" encoding="UTF-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
      <tns:imsx_syncResponseHeaderInfo xmlns:tns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
      <tns:imsx_version>V1.0</tns:imsx_version>
      <tns:imsx_messageIdentifier>44E6FDA6-A4E9-11E1-AFE8-B001F0E76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>a428f832-9d21-4c80-a9a0-a26838afe4eb</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>User successfully updated.</tns:imsx_description>
          <tns:imsx_codeMinor>
              <tns:imsx_codeMinorField>
                  <tns:imsx_codeMinorFieldName>TargetEndSystem</tns:imsx_codeMinorFieldName>
                  <tns:imsx_codeMinorFieldValue>fullsuccess</tns:imsx_codeMinorFieldValue>
              </tns:imsx_codeMinorField>
          </tns:imsx_codeMinor>
      </tns:imsx_statusInfo>
  </tns:imsx_syncResponseHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <tns:updatePersonResponse xmlns:tns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0"/>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>