When an administrator configures their Turnitin URL and API Key in your organization’s configuration page and saves these changes, your API should call the ‘Get Features Enabled’ request to validate the values. On success, a returned attribute ‘tenant.require_eula’ will be false if EULA does not need to be shown to users and true if it does. A ‘false’ can happen in certain agreements with customers. If ‘true’, the logic explained below is required.
Handling EULA Changes
The current version of the Turnitin EULA should be obtained by calling the ‘Get EULA Version Info’ request and passing ‘latest’ as the value for ‘version_id’. This will return the ‘version’ which should be stored as the value for use in the API.
The ‘version’ value can be used to retrieve the EULA (HTML format) in the ‘Get EULA Page’ request (pass the ‘version_id’) in different languages. Ideally, you would store the EULA HTML on your servers and not call the API to retrieve it each time it needs to be shown in your UI.
You need to poll the ‘Get EULA Version Info’ request every 24 hours (passing ‘latest’ as the value for ‘version_id’) to detect if Turnitin has changed the EULA. If the version changes, it needs to be stored for use in the API and retrieve the new EULA HTML for presentation to users.
EULA Presentation prior to submission
If the user submitting has not previously accepted the latest Turnitin EULA, they need to be shown it and accept it prior to submission. If the user has previously accepted the latest Turnitin EULA then it does not need to be displayed.
If accepted, the ‘Create Submission’ request should contain the optional ‘eula’ attributes. If not accepted, the submission workflow should not be started.
EULA Presentation for report viewing
Turnitin can handle the presentation of the latest EULA (if not previously accepted) because the user is launched into our UI.
Don't send the optional ‘eula’ attributes in the ‘Create Viewer Launch URL’ request. If the user (‘viewer_user_id’) has not accepted the latest EULA, they are shown it and must accept it before they can see the report. We call this ‘EULA Click-Through’.