Agreement Object Reference

Last modified on August 24, 2023 at 6:51 pm

An agreement represents an end-user license agreement that may be presented to a user before they are allowed access to the DigitalChalk system and your course materials. The object allows you to access the title and text of the agreements, track when an agreement was created or last updated, and determine whether an agreement will be shown to end-users when they first log in to the system.

Example Agreement Object

The following is an example of a JSON representation of a Agreement object. This illustrates how 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",
  "updatedDate": "2012-12-09T17:18:02Z",
  "required": true 

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 user 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.
createdDatestringThe date the agreement was first created. For more information on the expected format, see the Date/Time Format documentation.
updatedDatestringThe date the agreement was last updated. For more information on the expected format, see the Date/Time Format documentation.
requiredbooleanIndicates whether the agreement will be shown to users when they create an account. If the value is false, the agreement remains defined in the system but will not be displayed to users.