Terms

Terms are an optional data type - these are only created if a district sends us term information.

❗️

Clever Complete Agreement Required

This feature is included with a Clever Complete subscription. Sign up here or email your Application Success Manager to learn more.

Table of Contents

Schema
Example Terms Object
Related Objects


Schema

❗️

Fields are not returned in a specific order so please ensure that your app does not rely on the order.

FieldGuaranteed?Description
idGuaranteedGlobally unique and stable id for term created by Clever. Used in API calls (ex /v3.0/terms/4fe3ff51dfa547000000041f)
districtGuaranteedGlobally unique and stable id for term's district.
nameNot GuaranteedName provided by district.
start_dateNot GuaranteedStart date for the term. ISO 8601 extended format: YYYY-MM-DD.
end_dateNot GuaranteedEnd date for the term. ISO 8601 extended format: YYYY-MM-DD.

Example Terms Object

"data": {
   "id": "string", // ObjectID: Globally unique and stable ID for the term
   "district": "string", // ObjectID: Globally unique and stable ID for the term's district
   "name": "string", // String: Name provided by district
   "start_date": "string", // Date: Term's start date
   "end_date": "string" // Date: Term's end date
 }


Related Objects

To retrieve a list of the section objects associated with a term, use /terms/{id}/sections.