User Agreement Object Reference

Last modified on August 24, 2023 at 8:10 pm

A user agreement represents an end-user license agreement that a given user either has agreed to or will be required to agree to on first login. After the agreement is accepted by the user, the user agreement title and text property will continue to reflect the agreement the user was presented regardless of revisions to the agreement text going forward.

Example User Agreement Object

The following is an example of a JSON representation of a User Agreement object. This illustrates how user agreements are represented in server responses.

  "type": "custom",
  "title": "Organizational Guidelines for Educational Materials",
  "text": "The materials you access through DigitalChalk as part of the courses have been approved by the relevant international regulatory bodies. By accessing these materials, you acknowledge that the materials are covered under international copyright laws, and you agree to use the materials only in a way that is consistent with the parameters of the course.",
  "createdDate": "2012-12-06T22:07:18Z",
  "agreed": true 
  "agreedDate": "2012-12-09T17:18:02Z",

Property Details

PropertyJSON Data TypeDescription
typestringThe type of the agreement. This will either be standard or custom. The standard agreement is the end-user license agreement for the DigitalChalk platform that students must accept to use the system. A custom agreement is a supplemental agreement your organization has prepared that a user must also agree to before they can access your course materials.
titlestringThe title of the agreement.
textstringThe text of the agreement. Note that the text content may contain HTML. If the agreement has been updated since the user agreed, this text will contain the agreement as it was presnted to the user when they accepted the agreement.
createdDatestringThe date the agreement was first created. For more information on the expected format, see the Date/Time Format documentation.
agreedbooleanIndicates whether the user has accepted the agreement.
agreedDatebooleanThe date the user accepted the agreement. For more information on the expected format, see the Date/Time Format documentation.