Read Person(s)

Functional Overview

These functions may be used to retrieve information about users in Turntin.

readPerson

This function takes a request containing a Turnitin User ID and searches the Turnitin account for that user. If no user is found or the User ID is not associated with the Turnitin account an error is returned in the SOAP response. If the user is found and is associated with the Turnitin account then user data containing firstname, lastname, email address and default user type for that user is returned in the SOAP response.

Parameters

Required:

sourcedId: //integer. max size xxx. unique identifier for user.

Optional:

none: //

Outputs

sourcedId: //integer. max size xxx. unique identifier for user
Email: //string. max size xxx. user email address
First: //string. maz size xxx. user first name
Last: //string. max size xxx. user last name
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

Code	Text
XXX	"description"
XXX	"description"
XXX	"description"

Example: 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/readPerson"
  Content-length: 583
  Source: 12
  Authorization: OAuth oauth_nonce="2f85758709dca9d23079116d98ff12e625c3252d",
       oauth_timestamp="1337786335",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="yJsjqDQ%2Fk71XBPWx%2Bc7l%2FcVCsHk%3D",
       oauth_signature="yzJu96r1iIH4rXnlsHRQ2zpYQFE%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>ae3cf0e5-2953-4fe0-bfde-ffe9a116b37c</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:readPersonRequest>
          <ns1:sourcedId>100012263</ns1:sourcedId>
      </ns1:readPersonRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example: 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>ae3cf0e5-2953-4fe0-bfde-ffe9a116b37c</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>User Found</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:readPersonResponse xmlns:tns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
      <tns:personRecord>
          <tns:sourcedGUID>
              <tns:refAgentInstanceID>Turnitin SRC12</tns:refAgentInstanceID>
              <tns:sourcedId>100012263</tns:sourcedId>
          </tns:sourcedGUID>
          <tns:person>
              <tns:name>
                  <tns:nameType>
                      <tns:instanceIdentifier>
                          <tns:language>en-US</tns:language>
                          <tns:textString>1</tns:textString>
                      </tns:instanceIdentifier>
                      <tns:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/nametypevocabularyv1p0.xml</tns:instanceVocabulary>
                      <tns:instanceValue>
                          <tns:language>en-US</tns:language>
                          <tns:textString>Contact</tns:textString>
                      </tns:instanceValue>
                  </tns:nameType>
                  <tns:partName>
                      <tns:instanceIdentifier>
                          <tns:language>en-US</tns:language>
                          <tns:textString>1</tns:textString>
                      </tns:instanceIdentifier>
                      <tns:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/partnamevocabularyv1p0.xml</tns:instanceVocabulary>
                      <tns:instanceName>
                          <tns:language>en-US</tns:language>
                          <tns:textString>First</tns:textString>
                      </tns:instanceName>
                      <tns:instanceValue>
                          <tns:language>en-US</tns:language>
                          <tns:textString>Demo</tns:textString>
                      </tns:instanceValue>
                  </tns:partName>
                  <tns:partName>
                      <tns:instanceIdentifier>
                          <tns:language>en-US</tns:language>
                          <tns:textString>2</tns:textString>
                      </tns:instanceIdentifier>
                      <tns:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/partnamevocabularyv1p0.xml</tns:instanceVocabulary>
                      <tns:instanceName>
                          <tns:language>en-US</tns:language>
                          <tns:textString>Last</tns:textString>
                      </tns:instanceName>
                      <tns:instanceValue>
                          <tns:language>en-US</tns:language>
                          <tns:textString>Student</tns:textString>
                      </tns:instanceValue>
                  </tns:partName>
              </tns:name>
              <tns:contactinfo>
                  <tns:contactinfoType>
                      <tns:instanceIdentifier>
                          <tns:language>en-US</tns:language>
                          <tns:textString>1</tns:textString>
                      </tns:instanceIdentifier>
                      <tns:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/contactinfotypevocabularyv1p0.xml</tns:instanceVocabulary>
                      <tns:instanceValue>
                          <tns:language>en-US</tns:language>
                          <tns:textString>EmailPrimary</tns:textString>
                      </tns:instanceValue>
                  </tns:contactinfoType>
                  <tns:contactinfoValue>
                      <tns:language>en-US</tns:language>
                      <tns:textString>demo.student.1337786332@turnitin.com</tns:textString>
                  </tns:contactinfoValue>
              </tns:contactinfo>
              <tns:roles>
                  <tns:enterpriserolesType>
                      <tns:instanceIdentifier>
                          <tns:language>en-US</tns:language>
                          <tns:textString>1</tns:textString>
                      </tns:instanceIdentifier>
                      <tns:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/epriserolestypevocabularyv1p0.xml</tns:instanceVocabulary>
                      <tns:instanceName>
                          <tns:language>en-US</tns:language>
                          <tns:textString>Other</tns:textString>
                      </tns:instanceName>
                      <tns:instanceValue>
                          <tns:language>en-US</tns:language>
                          <tns:textString>Other</tns:textString>
                      </tns:instanceValue>
                  </tns:enterpriserolesType>
                  <tns:institutionRole>
                      <tns:institutionroletype>
                          <tns:instanceIdentifier>
                              <tns:language>en-US</tns:language>
                              <tns:textString>1</tns:textString>
                          </tns:instanceIdentifier>
                          <tns:instanceVocabulary>http://www.imsglobal.org/vdex/lis/pmsv2p0/institutionroletypevocabularyv1p0.xml</tns:instanceVocabulary>
                          <tns:instanceValue>
                              <tns:language>en-US</tns:language>
                              <tns:textString>Learner</tns:textString>
                          </tns:instanceValue>
                      </tns:institutionroletype>
                      <tns:primaryroletype>1</tns:primaryroletype>
                  </tns:institutionRole>
              </tns:roles>
          </tns:person>
      </tns:personRecord>
  </tns:readPersonResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

readPersons

This function takes a request containing a set of Turnitin User IDs and searches the Turnitin account for those users. If none of the users are found or any of the User IDs are not associated with the Turnitin account an error is returned in the SOAP response. If one or more users were not found or not associated with the account then a 'partialsuccess' is returned containing the data for the users that were found.