Last modified on August 24, 2023 at 6:51 pm
Overview
Retrieve a list of all agreements for your organization. This will include the DigitalChalk end user license agreement (type standard) as well as any additional custom agreement your organization has added (type custom), if any. The JSON-encoded response object will contain a results property with an array of agreements. The Object Definition is provided below.
JSON Object Definition
The following lists properties on the JSON object representing agreements you may encounter when retrieving a list of agreements. 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 two agreement types. In this case, both agreements are required for end users to accept, so the required property is true for both agreements.
Request
GET /dc/api/v5/agreements HTTP/1.1 Host: org.digitalchalk.com Accept: application/json
Response
HTTP/1.1 200 OK
Content-type: application/json
Content-length: 931
{
"results": [
{
"type": "standard",
"title": "DigitalChalk Standard End-User License Agreement",
"text": "(EXAMPLE TEXT) By using the DigitalChalk platform, you agree to ...",
"createdDate": "2009-03-14T16:12:32Z",
"required": true
},
{
"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
}
]
}