Last modified on August 24, 2023 at 6:51 pm
Overview
Retrieve a specific agreement by specifying the agreement type. At this time, the possible types are standard and custom. The JSON-encoded response object will contain the agreement. The Object Definition is provided below.
JSON Object Definition
The following lists properties on the JSON object representing agreements you may encounter when retrieving an agreement. Fields with no value set are omitted from the JSON object. For a complete list of agreement properties and further details, see the Agreement Object Reference.
{
"type": "",
"title": "",
"text": "",
"createdDate": "",
"updatedDate": "",
"required": false
}
Examples
This example shows a response containing the organization-specific custom agreement. The custom agreement type is always required if it is defined, so the required property is true.
Request
GET /dc/api/v5/agreements/custom HTTP/1.1 Host: org.digitalchalk.com Accept: application/json
Response
HTTP/1.1 200 OK
Content-type: application/json
Content-length: 931
{
"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
}