This API is under construction. Some of the details documented here may change.
Create Person
Functional Overview
This function may be used to create a new instructor or student user in Turnitin. Each user in Turnitin must have a unique email address.
Upon successful completion the new user will be joined to the insitution account authenticated on the call as a student or instructor.
If a user already exists with the email address provided, an error will be returned. If you would like to access an existing Turnitin user, utilize the discoverPersonIDs function to retrieve the user ID
createByProxyPerson
This function takes a request containing the user's firstname, lastname, email address and default user type and creates a new user on the Turnitin system and associates the user with the Turnitin account. If the user exists an error is returned.
If the call is successful the Turnitin user ID associated with the new user is returned in the SOAP response message.
Parameters
Required:
- //string. max size xxx. must be formatted as email address with "@". must be unique
- First
- //string. max size xxx. user first name
- Last
- //string. max size xxx. user last name. required by turnitin UI to create user password
- Role
- //string. max size xxx. default user role to assign to user. Must equal "Learner" or "Instructor"
- none
- //
Outputs
- sourcedId
- //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" |
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/createByProxyPerson"
Content-length: 3660
Source: 12
Authorization: OAuth oauth_nonce="b523a9adf76d4fb6295dd2c7850a1fb32f19b20c",
oauth_timestamp="1337786332",
oauth_consumer_key="49201",
oauth_signature_method="HMAC-SHA1",
oauth_version="1.0",
oauth_body_hash="NBs53wFx5iNF07TDWa8vCZbSPk0%3D",
oauth_signature="EpjcPuGTUud7jkLIzNtqF2GCWLc%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>86b64d49-52a4-41c7-86ec-b9d5f56d1300</ns1:imsx_messageIdentifier>
</ns1:imsx_syncRequestHeaderInfo>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ns1:createByProxyPersonRequest>
<ns1:personRecord>
<ns1:sourcedGUID>
<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:createByProxyPersonRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
<?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>86b64d49-52a4-41c7-86ec-b9d5f56d1300</tns:imsx_messageRefIdentifier>
<tns:imsx_description>User successfully created.</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:createByProxyPersonResponse xmlns:tns="http://www.imsglobal.org/services/lis/pms2p0/wsdl11/sync/imspms_v2p0">
<tns:sourcedId>100012263</tns:sourcedId>
</tns:createByProxyPersonResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>