Last modified on August 24, 2023 at 8:17 pm
Overview
Retrieve a specific user agreement by specifying the agreement type. At this time, the possible types are standard and custom. The JSON-encoded response object will contain the user agreement record. The Object Definition is provided below.
JSON Object Definition
The following lists properties on the JSON object representing user agreements you may encounter when retrieving a user agreement. Fields with no value set are omitted from the JSON object. For a complete list of user agreement properties and further details, see the User Agreement Object Reference.
{
"type": "",
"title": "",
"text": "",
"createdDate": "",
"agreed": false,
"agreedDate": ""
}
Examples
This example shows a response containing the record of the user’s acceptance of the organization-specific custom agreement. Note that the user has not yet accepted this agreement, so the agreed property is false, and the agreedDate property is omitted.
Request
GET /dc/api/v5/users/782ecb882901dfa239247b1cd48a89b2/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",
"agreed": false
}