Discover PersonIDs

Functional Overview

This function may be used to retrieve the user ID for an instructor or student from Turnitin.

The instructor or student must already be associated with the insitution account authenticated on the API call. If this is not the case an error will be returned. To make a request for an existing user be associated with an insitution account, contact Turnitin support.

discoverPersonIds

This function takes an email address and searches the Turnitin account and API product for a user that is associated with this email address. If no users are found with this email address or the email address is from a user not associated with this account and API product then an error response is returned.

If a user is found with this email address and is associated with this Turnitin account then the Turnitin User ID is returned in the SOAP response.

Parameters

Required:

queryObject: //string. max size xxx. email address to be used to search for user IDs

Optional:

none: //

Outputs

sourceId: //integer. max size xxx. unique identifier for user
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 discoverPersonIds 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/discoverPersonIds"
  Content-length: 628
  Source: 12
  Authorization: OAuth oauth_nonce="5fa89df6b3cafeb271f428acac977f52de134cb7",
       oauth_timestamp="1337786338",
       oauth_consumer_key="49201",
       oauth_signature_method="HMAC-SHA1",
       oauth_version="1.0",
       oauth_body_hash="pGGs%2FIgnm4rEfZoLt%2FGes3TVmBM%3D",
       oauth_signature="tKfno3eH429EGO1StOtb6cwIW74%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>b7f21d15-5c81-4ff6-97b3-3b9c6b12898d</ns1:imsx_messageIdentifier>
      </ns1:imsx_syncRequestHeaderInfo>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
      <ns1:discoverPersonIdsRequest>
          <ns1:queryObject>demo.student.1337786332@turnitin.com</ns1:queryObject>
      </ns1:discoverPersonIdsRequest>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Example discoverPersonIds 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>65AC5110-A4E6-11E1-AFE8-3CF1EFE76FDE</tns:imsx_messageIdentifier>
      <tns:imsx_statusInfo>
          <tns:imsx_codeMajor>success</tns:imsx_codeMajor>
          <tns:imsx_severity>status</tns:imsx_severity>
          <tns:imsx_messageRefIdentifier>b7f21d15-5c81-4ff6-97b3-3b9c6b12898d</tns:imsx_messageRefIdentifier>
          <tns:imsx_description>Discovered 1 user/s.</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:discoverPersonIdsResponse xmlns:tns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
      <tns:sourcedIdSet>
          <tns:sourcedId>100012263</tns:sourcedId>
      </tns:sourcedIdSet>
  </tns:discoverPersonIdsResponse>
  </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>