1 | Clever API v3.0 - Data Schema (All Fields) | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
2 | API v3.0 last updated 8/3/2022. | |||||||||||
3 | Important: Guaranteed fields are always present for the given resources. Validated fields will only contain the possible values or formats listed. All other data is shown as it exists in the source system, which may include empty strings. * Denotes a special field. To receive access to special fields, please reach out to integrations@clever.com | |||||||||||
4 | ||||||||||||
5 | Resource | Field Name | Format | Example Data | Description | Validated | Guaranteed | Field Availability by Product | ||||
6 | District SSO | Secure Sync | Library | |||||||||
7 | District | id | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for district created by Clever. Used in API calls (ex /v3.0/districts/4fd43cc56d11340000000005 ) | Y | Y | Y | Y | N | ||
8 | District | name | String | "Clever Public Schools" | District (or CMO) name. | N | Y | Y | Y | N | ||
9 | District | mdr_number | String | "123456" | MDR number (used for matching district records) | N | N | N | Y | N | ||
10 | District | nces_id | String | "12093120" | Federal NCES id for school. | N | N | N | Y | N | ||
11 | District | sis_type | String | "sftp" | Indicates the type of SIS this district's data originates from. "sftp" is returned when district data is synced via SFTP or CSV upload. Other string values vary. | Y | Y | N | Y | N | ||
12 | District | state | String | "running" | Possible values: ["running", "pending", "error", "paused", "success", ""] Pending means there is an error that the district can fix; Error means there is an error that Clever can fix. Paused means that the district's sync is paused to reflect last year's data. | Y | N | N | Y | N | ||
13 | District | last_sync | Timestamp | "2012-07-10T14:00:07.818Z" | Last successful sync of district's data. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | N | N | Y | N | ||
14 | District | portal_url | String | "https://clever.com/in/demo" | Indicates the URL of the district's Clever portal. | N | Y | N | Y | N | ||
15 | District | login_methods | Array | ["Clever Badges", "Clever Passwords"] | Indicates the type of login methods the district supports. Possible set of values: ["Clever Badges", "Canvas", "Clever Passwords", "Google", "LDAP", "SAML", "Other"] | Y | Y | N | Y | N | ||
16 | District | launch_date | Date | "2017-02-03" | Indicates when the end users in district are able to start logging in to the application. ISO 8601 extended format: YYYY-MM-DD. | Y | Y | N | Y | N | ||
17 | District | pause_start | Date | "2017-06-10" | Indicates when the district's data gets paused to reflect last year's data in the SIS. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
18 | District | pause_end | Date | "2017-08-24" | Indicates when the district's data is unpaused to reflect data for the new school year. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
19 | District | district_contact.district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for school's district. | Y | N | N | Y | N | ||
20 | District | district_contact.name.first | String | "Whitney" | District administrator's first name. | N | N | N | Y | N | ||
21 | District | district_contact.name.last | String | "Houston" | District administrator's last name. | N | N | N | Y | N | ||
22 | District | district_contact.email | String | "whouston@cleverusd.org" | District administrator's email. | N | N | N | Y | N | ||
23 | District | district_contact.title | String | "IT Director" | District administrator's title, if available. | Y | N | N | Y | N | ||
24 | District | district_contact.id | ObjectID | "5aec8191fa7a610001604ce7" | Globally unique and stable id for the district admin. | Y | N | N | Y | N | ||
25 | District | error | String | "Invalid username/password specified. Please check SIS credentials on settings page." | User-facing string describing a district error state. Typically useful only for district administrators. Should not be used to programmatically determine district status. | N | N | N | Y | N | ||
26 | District | links.self | Link | /v3.0/districts/4fd43cc56d11340000000005 | Stable link to district. | Y | Y | N | Y | N | ||
27 | x | x | x | x | x | x | x | x | x | x | ||
28 | School | id | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for school created by Clever. Used in API calls (ex. /v3.0/schools/4fe3ff50dfa5470000000001). | Y | Y | N | Y | N | ||
29 | School | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for school's district. | Y | Y | N | Y | N | ||
30 | School | last_modified | Timestamp | "2012-06-22T05:14:57.372Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
31 | School | name | String | "Cleverton High" | School name. | N | Y | N | Y | N | ||
32 | School | state_id | String | "1230192301923" | State school identifier. | N | N | N | Y | N | ||
33 | School | school_number | String | "10045" | District or county school identifier. | N | Y | N | Y | N | ||
34 | School | sis_id | String | "97" | Internal school identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
35 | School | nces_id | String | "12093120" | Federal NCES id for school. | N | N | N | Y | N | ||
36 | School | low_grade | String | "9" | School's beginning grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | N | ||
37 | School | high_grade | String | "12" | School's exit grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | N | ||
38 | School | principal.name | String | "Edward Rooney" | School principal's name. | N | N | N | Y | N | ||
39 | School | principal.email | String | "erooney@highschool.org" | School principal's email address. | N | N | N | Y | N | ||
40 | School | location.address | String | "456 Elm St." | School address. | N | N | N | Y | N | ||
41 | School | location.city | String | "Pleasantville" | School address city. | N | N | N | Y | N | ||
42 | School | location.state | String | "MA" | School address state. | N | N | N | Y | N | ||
43 | School | location.zip | String | "90210" or "12345-0000" | School address ZIP. | N | N | N | Y | N | ||
44 | School | mdr_number | String | "123456" | MDR number (used for matching school records) | N | N | N | Y | N | ||
45 | School | phone | String | "515.555.1234" | School phone number. | N | N | N | Y | N | ||
46 | School | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
47 | School | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | N | ||
48 | School | links.self | Link | /v3.0/schools/4fe3ff50dfa5470000000001 | Stable link to school. | Y | Y | N | Y | N | ||
49 | School | links.district | Link | /v3.0/schools/4fe3ff50dfa5470000000001/district | Gets the district for a school. | Y | Y | N | Y | N | ||
50 | School | links.sections | Link | /v3.0/schools/4fe3ff50dfa5470000000001/sections | Gets all sections for a school. | Y | Y | N | Y | N | ||
51 | School | links.users | Link | /v3.0/schools/4fe3ff50dfa5470000000001/users | Gets all users for a school. | Y | Y | N | Y | N | ||
52 | School | links.terms | Link | /v3.0/schools/4fe3ff50dfa5470000000001/terms | Gets all terms for a school. | Y | Y | N | Y | N | ||
53 | School | links.courses | Link | /v3.0/schools/4fe3ff50dfa5470000000001/courses | Gets all courses for a school. | Y | Y | N | Y | N | ||
54 | x | x | x | x | x | x | x | x | x | x | ||
55 | Term | id | ObjectID | "598349d40ad2e2f959000006" | Globally unique and stable id for term created by Clever. Used in API calls (ex /v3.0/terms/4fe3ff51dfa547000000041f) | Y | Y | N | Y | N | ||
56 | Term | district | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for term's district. | Y | Y | N | Y | N | ||
57 | Term | name | String | "S1" | Name provided by district. | N | N | N | Y | N | ||
58 | Term | start_date | Date | "2012-12-02" | Start date for the term. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
59 | Term | end_date | Date | "2013-06-01" | End date for the term. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
60 | Term | links.self | Link | /v3.0/terms/59841f3a40acac766d00000e | Stable link to term. | Y | Y | N | Y | N | ||
61 | Term | links.district | Link | /v3.0/terms/59841f3a40acac766d00000e/district | Gets the district for a term. | Y | Y | N | Y | N | ||
62 | Term | links.sections | Link | /v3.0/terms/59841f3a40acac766d00000e/sections | Gets all sections for a term. | Y | Y | N | Y | N | ||
63 | x | x | x | x | x | x | x | x | x | x | ||
64 | Course | id | ObjectID | "5970d4dd35e9e6974100014d" | Globally unique and stable id for course created by Clever. Used in API calls (ex /v3.0/courses/4fe3ff51dfa547000000041f) | Y | Y | N | Y | N | ||
65 | Course | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for course's district. | Y | Y | N | Y | N | ||
66 | Course | name | String | "AP Calculus" | Name provided by district. | N | N | N | Y | N | ||
67 | Course | number | String | "406" | Course number provided by district. | N | N | N | Y | N | ||
68 | Course | links.self | Link | /v3.0/courses/596f1147e80fa32c53000486 | Stable link to course. | Y | Y | N | Y | N | ||
69 | Course | links.district | Link | /v3.0/courses/596f1147e80fa32c53000486/district | Gets the district for a course. | Y | Y | N | Y | N | ||
70 | Course | links.sections | Link | /v3.0/courses/596f1147e80fa32c53000486/sections | Gets all sections for a course. | Y | Y | N | Y | N | ||
71 | x | x | x | x | x | x | x | x | x | x | ||
72 | Section | id | ObjectID | "4fee004dca2e43cf27000807" | Globally unique and stable id for section created by Clever. Used in API calls (ex /v3.0/sections/4fe3ff51dfa547000000041f) | Y | Y | N | Y | Y | ||
73 | Section | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for section's district. | Y | Y | N | Y | N | ||
74 | Section | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for section's school. | Y | Y | N | Y | N | ||
75 | Section | teacher | ObjectID | "4fee004dca2e43cf270007d6" | Globally unique and stable id for section's primary teacher. | Y | Y | N | Y | Y | ||
76 | Section | teachers | List of ObjectIDs | ["4fee004dca2e43cf270007d6", "4fee004dca2e43df270007d7", "4fee004dca2e43ce270007d8"] | List of ids of co-teachers associated with the section. Primary teacher will be the first id in the array (the same as the "sections.teacher" field) | Y | Y | N | Y | Y | ||
77 | Section | last_modified | Timestamp | "2012-06-22T05:14:57.825Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
78 | Section | name | String | "Algebra I - Escalante - 5(A)" | Section name. Clever generates a section name by concatenating "course_name" "- teacher_last_name" and "- period", e.g. Algebra - Smith - Period 3. If course name is not present, the section name from the source system is used. | N | Y | N | Y | Y | ||
79 | Section | course | ObjectID | "4fee004dca2e43df270007d7" | The id of the course associated with the section. | Y | N | N | Y | N | ||
80 | Section | period | String | "5(A)" | Bell schedule information for the section. | N | N | N | Y | N | ||
81 | Section | subject | String | "Math" | The subject associated with the section. Possible values: ["english/language arts","math","science","social studies","language","homeroom/advisory", "interventions/online learning","technology and engineering","PE and health","arts and music","other",""] | Y | N | N | Y | Y | ||
82 | Section | students | List of ObjectIDs | ["4fe3ff50dfa547000000033a", "4fe3ff50dfa5470000000359", "4fe3ff50dfa5470000000234"] | List of ids of students in section. | Y | Y | N | Y | Y | ||
83 | Section | sis_id | String | "1023" | Internal section identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
84 | Section | section_number | String | "104" | Section identifier, set by school or district. | N | N | N | Y | Y | ||
85 | Section | grade | String | "9" | Section grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | Y | ||
86 | Section | term_id | ObjectID | "4fee004dca2e43df270007d7" | ID of the term associated with the section. | Y | N | N | Y | N | ||
87 | Section | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | |||
88 | Section | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
89 | Section | links.self | Link | /v3.0/sections/4fe3ff51dfa547000000041f | Stable link to section. | Y | Y | N | Y | Y | ||
90 | Section | links.district | Link | /v3.0/sections/4fe3ff51dfa547000000041f/district | Gets the district for section. | Y | Y | N | Y | N | ||
91 | Section | links.users | Link | /v3.0/sections/4fe3ff51dfa547000000041f/users | Gets the users for a section. | Y | Y | N | Y | N | ||
92 | Section | links.school | Link | /v3.0/sections/4fe3ff51dfa547000000041f/school | Gets the school for a section. | Y | Y | N | Y | N | ||
93 | Section | links.term | Link | /v3.0/sections/4fe3ff51dfa547000000041f/term | Gets the term for a section. | Y | Y | N | Y | N | ||
94 | Section | links.course | Link | /v3.0/sections/4fe3ff51dfa547000000041f/course | Gets the course for a section. | Y | Y | N | Y | N | ||
95 | x | x | x | x | x | x | x | x | x | x | ||
96 | Resource | id | ObjectID | "22c09442-f632-419e-8260-bde7dc93d53c" | Globally unique and stable id for resource created by Clever. Used in API calls (ex /v3.0/resources/4fe3ff51dfa547000000041f) | Y | N | N | Y | N | ||
97 | Resource | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for resource's district. | Y | N | N | Y | N | ||
98 | Resource | resource_id | String | "ETYDGGPOOXGRRRRR" | Internal resource identifier as defined by an application. | Y | N | N | Y | N | ||
99 | Resource | title | String | "Priciples of Corporate Finance" | Title of a resource as defined by an application. | Y | N | N | Y | N | ||
100 | Resource | roles | List of roles that will have access to this resource | {"teacher", "student} | List of roles that a resource can be assigned to. Limited to teachers and students. | Y | N | N | Y | N | ||
101 | Resource | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | N | N | Y | N | ||
102 | Resource | updated | Timestamp | "2012-06-22T05:14:57.375Z" | Resource update date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | N | N | Y | N | ||
103 | ||||||||||||
104 | User | id | ObjectID | "4fee004cca2e43cf27000007" | Globally unique and stable id for all users created by Clever. Used in API calls (ex. /v3.0/users/4fee004cca2e43cf27000007/). | Y | Y | Y | Y | Y | ||
105 | User | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for user's district. | Y | Y | Y | Y | N | ||
106 | User | String | "fbueller@cleverschools.org" | Users's email address. | N | N | Y | Y | Y | |||
107 | User | name.first | String | "Ferris" | User first name. | N | Y | Y | Y | Y | ||
108 | User | name.middle | String | "W" | User middle name or initial. | N | N | N | Y | Y | ||
109 | User | name.last | String | "Bueller" | User last name. | N | Y | Y | Y | Y | ||
110 | User | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
111 | User | last_modified | Timestamp | "2012-06-22T05:14:57.375Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
112 | User | links.self | Link | /v3.0/users/4fee004cca2e43cf27000007 | Stable link to user. | Y | Y | N | Y | Y | ||
113 | User | links.district | Link | /v3.0/users/4fee004cca2e43cf27000007/district | Gets the district for a user. | Y | Y | N | Y | N | ||
114 | User | links.schools | Link | /v3.0/users/4fee004cca2e43cf27000007/schools | Gets all schools for a user. | Y | Y | N | Y | N | ||
115 | User | links.sections | Link | /v3.0/users/4fee004cca2e43cf27000007/sections | Gets all sections for a user. | Y | Y | N | Y | N | ||
116 | User | links.myContacts | Link | /v3.0/users/4fee004cca2e43cf27000007/contacts | Gets all contacts for a student. | Y | Y | N | Y | N | ||
117 | User | links.myTeachers | Link | /v3.0/users/4fee004cca2e43cf27000007/teachers | Gets all teachers for a student. | Y | Y | N | Y | N | ||
118 | User | links.myStudents | Link | /v3.0/users/4fee004cca2e43cf27000007/students | Gets all students for a teacher. | Y | Y | N | Y | Y | ||
119 | x | x | x | x | x | x | x | x | x | x | ||
120 | User (Student) | roles.student.school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for student's primary school. | Y | Y | N | Y | N | ||
121 | User (Student) | roles.student.schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this student is associated with. | Y | Y | N | Y | N | ||
122 | User (Student) | roles.student.enrollments | List of enrollments by school | [{"school": "4fe3ff50dfa547000000033c", "start_date": "2018-08-01T00:00:00.000Z", "end_date":"2018-12-15T00:00:00.000Z"}] | List of school enrollments which include school id and start/end dates based on when the student is in at least one active section at a school. | Y | Y | N | Y | N | ||
123 | User (Student) | roles.student.student_number | String | "10772" | School or district defined student identifier. | N | N | N | Y | N | ||
124 | User (Student) | roles.student.state_id | String | "1742739" | State student identifier. | N | N | N | Y | N | ||
125 | User (Student) | roles.student.sis_id | String | "2411" | Internal student identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
126 | User (Student) | roles.student.location.address | String | "123 Main St." | Primary student address. | N | N | N | Y | N | ||
127 | User (Student) | roles.student.location.city | String | "Anytown" | Primary student city. | N | N | N | Y | N | ||
128 | User (Student) | roles.student.location.state | String | "OH" | Primary student state. | N | N | N | Y | N | ||
129 | User (Student) | roles.student.location.zip | String | "90210" or "12345-0000" | Primary student address ZIP. | N | N | N | Y | N | ||
130 | User (Student) | roles.student.gender | String | "F" | Student gender. Possible values ["M","F", "X", ""]. | Y | N | N | Y | N | ||
131 | User (Student) | roles.student.dob | Date | 10/20/1995 | Student birthdate. MM/DD/YYYY format. | Y | N | N | Y | N | ||
132 | User (Student) | roles.student.grade | String | "9" | Student grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | Y | ||
133 | User (Student) | roles.student.graduation_year | String | "2019" | Graduation year provided by district. | Y | N | N | Y | N | ||
134 | *User (Student) | roles.student.ell_status | String | "Y" | Student English Language Learner (or Limited English Proficiency) status. Possible values ["Y", "N", ""]. Experimental field - may not be covered in all systems. | Y | N | N | Y | N | ||
135 | *User (Student) | roles.student.frl_status | String | "Free" | Student’s lunch status. "Free", "Reduced", "Paid", "" | Y | N | N | Y | N | ||
136 | *User (Student) | roles.student.iep_status | String | "Y" | Student’s special education status. Supported values: Y N | Y | N | N | Y | N | ||
137 | User (Student) | roles.student.race | String | "Caucasian" | Student's race. Possible values: ["Caucasian", "Asian", "Black or African American", "American Indian", "Hawaiian or Other Pacific Islander", "Two or More Races","Unknown", ""]. | Y | N | N | Y | N | ||
138 | User (Student) | roles.student.home_language | String | "Chinese" | Language spoken in the home setting. Possible values: [Supported values: ”English”, ”Albanian”, ”Amharic”, ”Arabic”, ”Bengali”, ”Bosnian”, ”Burmese”, ”Cantonese”, ”Chinese”, ”Dutch”, ”Farsi”, ”French”, ”German”, ”Hebrew”, ”Hindi”, ”Hmong”, ”Ilocano”, ”Japanese”, ”Javanese”, ”Karen”, ”Khmer”, ”Korean”, ”Laotian”, ”Latvian”, ”Malay”, ”Mandarin”, ”Nepali”, ”Oromo”, ”Polish”, ”Portuguese”, ”Punjabi”, ”Romanian”, ”Russian”, ”Samoan”, ”Serbian”, ”Somali”, ”Spanish”, ”Swahili”, ”Tagalog”, ”Tamil”, ”Telugu”, ”Thai”, ”Tigrinya”, ”Turkish”, ”Ukrainian”, ”Urdu”, ”Vietnamese”.] | Y | N | N | Y | N | ||
139 | User (Student) | roles.student.hispanic_ethnicity | String | "N" | Student's Hispanic/Latino ethnicity. Possible values: ["Y", "N", ""]. | Y | N | N | Y | N | ||
140 | User (Student) | roles.student.ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | |||
141 | User (Student) | roles.student.credentials.district_username | String | "fbueller1234" | Student's preferred username, specified by district. | N | N | N | Y | N | ||
142 | x | x | x | x | x | x | x | x | x | x | ||
143 | User (Teacher) | roles.teacher.legacy_id | ObjectID | "4fee004dca2e43cf270007d6" | Globally unique and stable id for teacher from earlier API version | Y | Y | Y | Y | Y | ||
144 | User (Teacher) | roles.teacher.school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for teacher's primary school. | Y | Y | N | Y | N | ||
145 | User (Teacher) | roles.teacher.schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this teacher is associated with. | Y | Y | N | Y | N | ||
146 | User (Teacher) | roles.teacher.sis_id | String | "455" | Internal teacher identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
147 | User (Teacher) | roles.teacher.teacher_number | String | "110011" | District or school assigned teacher identifier. | N | N | N | Y | N | ||
148 | User (Teacher) | roles.teacher.state_id | String | "2853840" | State teacher identifier. | N | N | N | Y | N | ||
149 | User (Teacher) | roles.teacher.ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | |||
150 | User (Teacher) | roles.teacher.title | String | "Math Department Chair" | Teacher's title | N | N | N | Y | N | ||
151 | User (Teacher) | roles.teacher.credentials.district_username | String | "jescalante@cleverprep.org" | Teacher's preferred username, specified by district. | N | N | N | Y | N | ||
152 | x | x | x | x | x | x | x | x | x | x | ||
153 | User (Staff) | roles.staff.legacy_id | ObjectID | "519edecb58b876b01800038g" | Globally unique and stable id for staff from earlier API versions | Y | Y | Y | Y | N | ||
154 | User (Staff) | roles.staff.title | String | "Chief Instigator" | The staff member's job title, if specified. | N | N | N | Y | N | ||
155 | User (Staff) | roles.staff.department | String | "Math" | Department provided by district | N | N | N | Y | N | ||
156 | User (Staff) | roles.staff.roles | Array | "SchoolTechLead" | Possible values: ["PortalOnly, "SchoolTechLead"] | Y | Y | N | Y | N | ||
157 | User (Staff) | roles.staff.ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | N | ||
158 | User (Staff) | roles.staff.schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this staff member is associated with. | Y | Y | N | Y | N | ||
159 | User (Staff) | roles.staff.staff_id | String | "1721" | An identifier provided by the district when syncing or creating this staff member. | N | Y | N | Y | N | ||
160 | User (Staff) | roles.staff.credentials.district_username | String | "bhoedel123" | Staff member's preferred username, specified by district | N | N | N | Y | N | ||
161 | x | x | x | x | x | x | x | x | x | x | ||
162 | User (District Admin) | roles.district_admin.legacy_id | ObjectID | "519edecb58b876b01800038f" | Globally unique and stable id for district administrator from earlier API versions | Y | Y | Y | Y | N | ||
163 | User (District Admin) | roles.district_admin.title | String | "Assistant to Principal" | The district admin's job title, if specified. | N | N | N | Y | N | ||
164 | x | x | x | x | x | x | x | x | x | x | ||
165 | User (Contact) | roles.contact.legacy_id | ObjectID | "4fee004dca2e43cf270009d9" | Globally unique and stable id for student contact from earlier API versions | Y | Y | N | Y | N | ||
166 | User (Contact) | roles.contact.sis_id | String | "123456" | Internal contact identifier from source system. | N | N | N | Y | N | ||
167 | User (Contact) | roles.contact.phone | String | "727.565.1000" | Contact phone number. | N | N | N | Y | N | ||
168 | User (Contact) | roles.contact.phone_type | String | "mobile" | Type of phone number. Possible values: ["Home", "Cell", "Work", "Other",""]. | Y | N | N | Y | N | ||
169 | User (Contact) | roles.contact.student_relationships.relationship | String | "Parent" | Relationship to student. Possible values: ["Parent","Grandparent","Self", "Aunt/Uncle", "Sibling," Other",""]. | Y | N | N | Y | N | ||
170 | User (Contact) | roles.contact.student_relationships.student | ObjectID | "4fe3ff50dfa547000000033a" | Globally unique and stable ids for student associated with contact. | Y | Y | N | Y | N | ||
171 | User (Contact) | roles.contact.student_relationships.type | String | "primary" | Type of contact. Possible values: ["Primary","Secondary", "Parent/Guardian", "Emergency", "Family", "Other",""]. | Y | N | N | Y | N | ||
173 | x | x | x | x | x | x | x | x | x | x | ||
174 | Event | id | ObjectID | "4ffc35672f767044120301dd" | Globally unique and stable id for event created by Clever. Used in API calls (ex /v3.0/events/4ffc35672f767044120301dd). Events may be purged after 30 days. | Y | Y | N | Y | N | ||
175 | Event | created | Timestamp | "2012-07-10T14:00:07.818Z" | Time of the event. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
176 | Event | type | String | "users.created" | Type of event. Format is resource.modification. Possible resources are ["schools","terms","courses","sections","users"]. Possible modifications are ["created","updated","deleted"]. | Y | Y | N | Y | N | ||
177 | Event | data | Varies | User resource | Event "data" field contains the resource (e.g. school, student, section, teacher) that was created or updated. | N | Y | N | Y | N | ||
178 | Event | previous_attributes | Varies | Fields from updated resource. | For events of the "updated" type, the previous_attributes field shows the prior value of the field or fields that have changed. | N | N | N | Y | N | ||
179 | Event | links.self | Link | /v3.0/events/4ffc35672f767044120301dd | Stable link to event. Events will be purged after 30 days. | Y | Y | N | Y | N | ||
180 | Data availability is subject to the decision of schools or districts to share their data. | |||||||||||
1 | Clever API v2.1 - Data Schema (All Fields) | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
2 | API v2.1 published 4/10/2019, last updated 6/18/2019. | |||||||||||
3 | For v2.0, select the v2.0 tab. | |||||||||||
4 | Important: Guaranteed fields are always present for the given resources. Validated fields will only contain the possible values or formats listed. All other data is shown as it exists in the source system, which may include empty strings. | |||||||||||
5 | ||||||||||||
6 | Resource | Field Name | Format | Example Data | Description | Validated | Guaranteed | Field Availability by Product | ||||
7 | District SSO | Secure Sync | Library | |||||||||
8 | District | id | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for district created by Clever. Used in API calls (ex /v2.0/districts/4fd43cc56d11340000000005 ) | Y | Y | Y | Y | N | ||
9 | District | name | String | "Clever Public Schools" | District (or CMO) name. | N | Y | Y | Y | N | ||
10 | District | mdr_number | String | "123456" | MDR number (used for matching district records) | N | N | N | Y | N | ||
11 | District | nces_id | String | "12093120" | Federal NCES id for school. | N | N | N | Y | N | ||
12 | District | sis_type | String | "sftp" | Indicates the type of SIS this district's data originates from. "sftp" is returned when district data is synced via SFTP or CSV upload. Other string values vary. | N | N | N | Y | N | ||
13 | District | state | String | "running" | Possible values: ["running", "pending", "error", "paused", "success", ""] Pending means there is an error that the district can fix; Error means there is an error that Clever can fix. Paused means that the district's sync is paused to reflect last year's data. | Y | N | N | Y | N | ||
14 | District | last_sync | Timestamp | "2012-07-10T14:00:07.818Z" | Last successful sync of district's data. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | N | N | Y | N | ||
15 | District | portal_url | String | "https://clever.com/in/demo" | Indicates the URL of the district's Clever portal. | Y | Y | N | Y | N | ||
16 | District | login_methods | Array | ["Clever Badges", "Clever Passwords"] | Indicates the type of login methods the district supports. Possible set of values: ["Clever Badges", "Canvas", "Clever Passwords", "Google", "LDAP", "SAML", "Other"] | Y | Y | N | Y | N | ||
17 | District | goals_enabled | String | "Y" | Indicates whether the district supports Clever Goals. Possible set of values: ["Y", "N",""] | Y | Y | N | Y | N | ||
18 | District | launch_date | Date | "2017-02-03" | Indicates when the end users in district are able to start logging in to the application. ISO 8601 extended format: YYYY-MM-DD. | Y | Y | N | Y | N | ||
19 | District | pause_start | Date | "2017-06-10" | Indicates when the district's data gets paused to reflect last year's data in the SIS. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
20 | District | pause_end | Date | "2017-08-24" | Indicates when the district's data is unpaused to reflect data for the new school year. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
21 | District | district_contact.district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for school's district. | Y | N | N | Y | N | ||
22 | District | district_contact.name.first | String | "Whitney" | District administrator's first name. | N | N | N | Y | N | ||
23 | District | district_contact.name.last | String | "Houston" | District administrator's last name. | N | N | N | Y | N | ||
24 | District | district_contact.email | String | "whouston@cleverusd.org" | District administrator's email. | N | N | N | Y | N | ||
25 | District | district_contact.title | String | "IT Director" | District administrator's title, if available. | N | N | N | Y | N | ||
26 | District | district_contact.id | ObjectID | "5aec8191fa7a610001604ce7" | Globally unique and stable id for the district admin. | Y | N | N | Y | N | ||
27 | District | error | String | "Invalid username/password specified. Please check SIS credentials on settings page." | User-facing string describing a district error state. Typically useful only for district administrators. Should not be used to programmatically determine district status. | N | N | N | Y | N | ||
28 | District | links.self | Link | /v2.0/districts/4fd43cc56d11340000000005 | Stable link to district. | Y | Y | N | Y | N | ||
29 | x | x | x | x | x | x | x | x | x | x | ||
30 | School | id | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for school created by Clever. Used in API calls (ex. /v2.0/schools/4fe3ff50dfa5470000000001). | Y | Y | N | Y | N | ||
31 | School | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for school's district. | Y | Y | N | Y | N | ||
32 | School | last_modified | Timestamp | "2012-06-22T05:14:57.372Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
33 | School | name | String | "Cleverton High" | School name. | N | Y | N | Y | N | ||
34 | School | state_id | String | "1230192301923" | State school identifier. | N | N | N | Y | N | ||
35 | School | school_number | String | "10045" | District or county school identifier. | N | Y | N | Y | N | ||
36 | School | sis_id | String | "97" | Internal school identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
37 | School | nces_id | String | "12093120" | Federal NCES id for school. | N | N | N | Y | N | ||
38 | School | low_grade | String | "9" | School's beginning grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | N | ||
39 | School | high_grade | String | "12" | School's exit grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | N | ||
40 | School | principal.name | String | "Edward Rooney" | School principal's name. | N | N | N | Y | N | ||
41 | School | principal.email | String | "erooney@highschool.org" | School principal's email address. | N | N | N | Y | N | ||
42 | School | location.address | String | "456 Elm St." | School address. | N | N | N | Y | N | ||
43 | School | location.city | String | "Pleasantville" | School address city. | N | N | N | Y | N | ||
44 | School | location.state | String | "MA" | School address state. | N | N | N | Y | N | ||
45 | School | location.zip | String | "90210" or "12345-0000" | School address ZIP. | N | N | N | Y | N | ||
46 | School | mdr_number | String | "123456" | MDR number (used for matching school records) | N | N | N | Y | N | ||
47 | School | phone | String | "515.555.1234" | School phone number. | N | N | N | Y | N | ||
48 | School | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
49 | School | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | N | ||
50 | School | links.self | Link | /v2.0/schools/4fe3ff50dfa5470000000001 | Stable link to school. | Y | Y | N | Y | N | ||
51 | School | links.district | Link | /v2.0/schools/4fe3ff50dfa5470000000001/district | Gets the district for a school. | Y | Y | N | Y | N | ||
52 | School | links.teachers | Link | /v2.0/schools/4fe3ff50dfa5470000000001/teachers | Gets all teachers for a school. | Y | Y | N | Y | N | ||
53 | School | links.students | Link | /v2.0/schools/4fe3ff50dfa5470000000001/students | Gets all students for a school. | Y | Y | N | Y | N | ||
54 | School | links.sections | Link | /v2.0/schools/4fe3ff50dfa5470000000001/sections | Gets all sections for a school. | Y | Y | N | Y | N | ||
55 | x | x | x | x | x | x | x | x | x | x | ||
56 | Term | id | ObjectID | "598349d40ad2e2f959000006" | Globally unique and stable id for term created by Clever. Used in API calls (ex /v2.0/terms/4fe3ff51dfa547000000041f) | Y | Y | N | Y | N | ||
57 | Term | district | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for term's district. | Y | Y | N | Y | N | ||
58 | Term | name | String | "S1" | Name provided by district. | N | N | N | Y | N | ||
59 | Term | start_date | Date | "2012-12-02" | Start date for the term. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
60 | Term | end_date | Date | "2013-06-01" | End date for the term. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
61 | Term | links.self | Link | /v2.0/terms/59841f3a40acac766d00000e | Stable link to term. | Y | Y | N | Y | N | ||
62 | Term | links.district | Link | /v2.0/terms/59841f3a40acac766d00000e/district | Gets the district for a term. | Y | Y | N | Y | N | ||
63 | Term | links.sections | Link | /v2.0/terms/59841f3a40acac766d00000e/sections | Gets all sections for a term. | Y | Y | N | Y | N | ||
64 | x | x | x | x | x | x | x | x | x | x | ||
65 | Course | id | ObjectID | "5970d4dd35e9e6974100014d" | Globally unique and stable id for course created by Clever. Used in API calls (ex /v2.0/courses/4fe3ff51dfa547000000041f) | Y | Y | N | Y | N | ||
66 | Course | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for course's district. | Y | Y | N | Y | N | ||
67 | Course | name | String | "AP Calculus" | Name provided by district. | N | N | N | Y | N | ||
68 | Course | number | String | "406" | Course number provided by district. | N | N | N | Y | N | ||
69 | Course | links.self | Link | /v2.0/courses/596f1147e80fa32c53000486 | Stable link to course. | Y | Y | N | Y | N | ||
70 | Course | links.district | Link | /v2.0/courses/596f1147e80fa32c53000486/district | Gets the district for a course. | Y | Y | N | Y | N | ||
71 | Course | links.sections | Link | /v2.0/courses/596f1147e80fa32c53000486/sections | Gets all sections for a course. | Y | Y | N | Y | N | ||
72 | x | x | x | x | x | x | x | x | x | x | ||
73 | Section | id | ObjectID | "4fee004dca2e43cf27000807" | Globally unique and stable id for section created by Clever. Used in API calls (ex /v2.0/sections/4fe3ff51dfa547000000041f) | Y | Y | N | Y | Y | ||
74 | Section | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for section's district. | Y | Y | N | Y | N | ||
75 | Section | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for section's school. | Y | Y | N | Y | N | ||
76 | Section | teacher | ObjectID | "4fee004dca2e43cf270007d6" | Globally unique and stable id for section's primary teacher. | Y | Y | N | Y | Y | ||
77 | Section | teachers | List of ObjectIDs | ["4fee004dca2e43cf270007d6", "4fee004dca2e43df270007d7", "4fee004dca2e43ce270007d8"] | List of ids of co-teachers associated with the section. Primary teacher will be the first id in the array (the same as the "sections.teacher" field) | Y | Y | N | Y | Y | ||
78 | Section | last_modified | Timestamp | "2012-06-22T05:14:57.825Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
79 | Section | name | String | "Algebra I - Escalante - 5(A)" | Section name. Clever generates a section name by concatenating "course_name" "- teacher_last_name" and "- period", e.g. Algebra - Smith - Period 3. If course name is not present, the section name from the source system is used. | N | Y | N | Y | Y | ||
80 | Section | course | ObjectID | "4fee004dca2e43df270007d7" | The id of the course associated with the section. | Y | N | N | Y | N | ||
81 | Section | period | String | "5(A)" | Bell schedule information for the section. | N | N | N | Y | N | ||
82 | Section | subject | String | "Math" | The subject associated with the section. Possible values: ["english/language arts","math","science","social studies","language","homeroom/advisory", "interventions/online learning","technology and engineering","PE and health","arts and music","other",""] | Y | N | N | Y | Y | ||
83 | Section | students | List of ObjectIDs | ["4fe3ff50dfa547000000033a", "4fe3ff50dfa5470000000359", "4fe3ff50dfa5470000000234"] | List of ids of students in section. | Y | Y | N | Y | Y | ||
84 | Section | sis_id | String | "1023" | Internal section identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
85 | Section | section_number | String | "104" | Section identifier, set by school or district. | N | N | N | Y | Y | ||
86 | Section | grade | String | "9" | Section grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | Y | ||
87 | Section | term_id | ObjectID | "4fee004dca2e43df270007d7" | ID of the term associated with the section. | Y | N | N | Y | N | ||
88 | Section | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | |||
89 | Section | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
90 | Section | links.self | Link | /v2.0/sections/4fe3ff51dfa547000000041f | Stable link to section. | Y | Y | N | Y | Y | ||
91 | Section | links.district | Link | /v2.0/sections/4fe3ff51dfa547000000041f/district | Gets the district for section. | Y | Y | N | Y | N | ||
92 | Section | links.teacher | Link | /v2.0/sections/4fe3ff51dfa547000000041f/teacher | Gets the teacher for a section. | Y | Y | N | Y | N | ||
93 | Section | links.teachers | Link | /v2.0/sections/4fe3ff51dfa547000000041f/teachers | Gets teachers associated with a section. | Y | Y | N | Y | N | ||
94 | Section | links.students | Link | /v2.0/sections/4fe3ff51dfa547000000041f/students | Gets the students for a section. | Y | Y | N | Y | N | ||
95 | Section | links.school | Link | /v2.0/sections/4fe3ff51dfa547000000041f/school | Gets the school for a section. | Y | Y | N | Y | N | ||
96 | Section | links.term | Link | /v2.0/sections/4fe3ff51dfa547000000041f/term | Gets the term for a section. | Y | Y | N | Y | N | ||
97 | Section | links.course | Link | /v2.0/sections/4fe3ff51dfa547000000041f/course | Gets the course for a section. | Y | Y | N | Y | N | ||
98 | x | x | x | x | x | x | x | x | x | x | ||
99 | Student | id | ObjectID | "4fee004cca2e43cf27000007" | Globally unique and stable id for student, created by Clever. Used in API calls (ex. /v2.0/students/4fee004cca2e43cf27000007/). | Y | Y | Y | Y | Y | ||
100 | Student | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for student's district. | Y | Y | Y | Y | N | ||
101 | Student | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for student's primary school. | Y | Y | N | Y | N | ||
102 | Student | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this student is associated with. | Y | Y | N | Y | N | ||
103 | Student | enrollments | List of enrollments by school | [{"school": "4fe3ff50dfa547000000033c", "start_date": "2018-08-01T00:00:00.000Z", "end_date":"2018-12-15T00:00:00.000Z"}] | List of school enrollments which include school id and start/end dates based on when the student is in at least one active section at a school. | Y | Y | N | Y | N | ||
104 | Student | student_number | String | "10772" | School or district defined student identifier. | N | N | N | Y | N | ||
105 | Student | state_id | String | "1742739" | State student identifier. | N | N | N | Y | N | ||
106 | Student | sis_id | String | "2411" | Internal student identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
107 | Student | name.first | String | "Ferris" | Student first name. | N | Y | Y | Y | Y | ||
108 | Student | name.middle | String | "W" | Student middle name or initial. | N | N | N | Y | Y | ||
109 | Student | name.last | String | "Bueller" | Student last name. | N | Y | Y | Y | Y | ||
110 | Student | location.address | String | "123 Main St." | Primary student address. | N | N | N | Y | N | ||
111 | Student | location.city | String | "Anytown" | Primary student city. | N | N | N | Y | N | ||
112 | Student | location.state | String | "OH" | Primary student state. | N | N | N | Y | N | ||
113 | Student | location.zip | String | "90210" or "12345-0000" | Primary student address ZIP. | N | N | N | Y | N | ||
114 | Student | location.lat | String | "37.4870246645558" | Primary student address latitude. | N | N | N | Y | N | ||
115 | Student | location.lon | String | "122.259305648889" | Primary student address longitude. | N | N | N | Y | N | ||
116 | Student | gender | String | "F" | Student gender. Possible values ["M","F", "X", ""]. | Y | N | N | Y | N | ||
117 | Student | dob | Date | 10/20/1995 | Student birthdate. MM/DD/YYYY format. | Y | N | N | Y | N | ||
118 | Student | grade | String | "9" | Student grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | Y | ||
119 | Student | graduation_year | String | "2019" | Graduation year provided by district. | Y | N | N | Y | N | ||
120 | Student | ell_status | String | "Y" | Student English Language Learner (or Limited English Proficiency) status. Possible values ["Y", "N", ""]. Experimental field - may not be covered in all systems. | Y | N | N | Y | N | ||
121 | Student | iep_status | String | "Y" | Student’s special education status. Supported values: Y N | Y | N | N | Y | N | ||
122 | Student | frl_status | String | "Free" | Student’s lunch status. "Free", "Reduced", "Paid", "" | Y | N | N | Y | N | ||
123 | Student | race | String | "Caucasian" | Student's race. Possible values: ["Caucasian", "Asian", "Black or African American", "American Indian", "Hawaiian or Other Pacific Islander", "Two or More Races","Unknown", ""]. | Y | N | N | Y | N | ||
124 | Student | home_language | String | "Chinese" | Language spoken in the home setting. Possible values: [Supported values: ”English”, ”Albanian”, ”Amharic”, ”Arabic”, ”Bengali”, ”Bosnian”, ”Burmese”, ”Cantonese”, ”Chinese”, ”Dutch”, ”Farsi”, ”French”, ”German”, ”Hebrew”, ”Hindi”, ”Hmong”, ”Ilocano”, ”Japanese”, ”Javanese”, ”Karen”, ”Khmer”, ”Korean”, ”Laotian”, ”Latvian”, ”Malay”, ”Mandarin”, ”Nepali”, ”Oromo”, ”Polish”, ”Portuguese”, ”Punjabi”, ”Romanian”, ”Russian”, ”Samoan”, ”Serbian”, ”Somali”, ”Spanish”, ”Swahili”, ”Tagalog”, ”Tamil”, ”Telugu”, ”Thai”, ”Tigrinya”, ”Turkish”, ”Ukrainian”, ”Urdu”, ”Vietnamese”.] | N | N | N | Y | N | ||
125 | Student | hispanic_ethnicity | String | "N" | Student's Hispanic/Latino ethnicity. Possible values: ["Y", "N", ""]. | Y | N | N | Y | N | ||
126 | Student | String | "fbueller@cleverschools.org" | Student's email address. | N | N | Y | Y | N | |||
127 | Student | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | |||
128 | Student | credentials.district_username | String | "fbueller1234" | Student's preferred username, specified by district. | N | N | N | Y | N | ||
129 | Student | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
130 | Student | last_modified | Timestamp | "2012-06-22T05:14:57.375Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
131 | Student | links.self | Link | /v2.0/students/4fee004cca2e43cf27000007 | Stable link to student. | Y | Y | N | Y | Y | ||
132 | Student | links.district | Link | /v2.0/students/4fee004cca2e43cf27000007/district | Gets the district for a student. | Y | Y | N | Y | N | ||
133 | Student | links.school | Link | /v2.0/students/4fee004cca2e43cf27000007/school | Gets the school for a student. | Y | Y | N | Y | N | ||
134 | Student | links.schools | Link | /v2.0/students/4fee004cca2e43cf27000007/schools | Gets all schools for a student. | Y | Y | N | Y | N | ||
135 | Student | links.sections | Link | /v2.0/students/4fee004cca2e43cf27000007/sections | Gets all sections for a student. | Y | Y | N | Y | N | ||
136 | Student | links.contacts | Link | /v2.0/students/4fee004cca2e43cf27000007/contacts | Gets all contacts for a student. | Y | Y | N | Y | N | ||
137 | Student | links.teachers | Link | /v2.0/students/4fee004cca2e43cf27000007/teachers | Gets all teachers for a student. | Y | Y | N | Y | N | ||
138 | x | x | x | x | x | x | x | x | x | x | ||
139 | Teacher | id | ObjectID | "4fee004dca2e43cf270007d6" | Globally unique and stable id for teacher created by Clever. Used in API calls (ex /v2.0/teachers/4fee004dca2e43cf270007d6). | Y | Y | Y | Y | Y | ||
140 | Teacher | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for teacher's primary school. | Y | Y | N | Y | N | ||
141 | Teacher | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for teacher's district. | Y | Y | Y | Y | N | ||
142 | Teacher | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this teacher is associated with. | Y | Y | N | Y | N | ||
143 | Teacher | last_modified | Timestamp | "2012-06-22T05:14:57.799Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
144 | Teacher | sis_id | String | "455" | Internal teacher identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
145 | Teacher | String | "jescalante@cleverprep.org" | Teacher email. | N | N | Y | Y | Y | |||
146 | Teacher | name.first | String | "Jamie" | Teacher first name. | N | Y | Y | Y | Y | ||
147 | Teacher | name.middle | String | "A." | Teacher middle name or initial. | N | N | N | Y | Y | ||
148 | Teacher | name.last | String | "Escalante" | Teacher last name. | N | Y | Y | Y | Y | ||
149 | Teacher | teacher_number | String | "110011" | District or school assigned teacher identifier. | N | N | N | Y | N | ||
150 | Teacher | state_id | String | "2853840" | State teacher identifier. | N | N | N | Y | N | ||
151 | Teacher | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | |||
152 | Teacher | title | String | "Math Department Chair" | Teacher's title | N | N | N | Y | N | ||
153 | Teacher | credentials.district_username | String | "jescalante@cleverprep.org" | Teacher's preferred username, specified by district. | N | N | N | Y | N | ||
154 | Teacher | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
155 | Teacher | links.self | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed | Stable link to teacher. | Y | Y | N | Y | Y | ||
156 | Teacher | links.district | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/district | Gets the district for a teacher. | Y | Y | N | Y | N | ||
157 | Teacher | links.sections | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/sections | Gets all of the sections for a teacher. | Y | Y | N | Y | Y | ||
158 | Teacher | links.school | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/school | Gets the school for a teacher. | Y | Y | N | Y | N | ||
159 | Teacher | links.schools | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/schools | Gets all schools for a teacher. | Y | Y | N | Y | N | ||
160 | Teacher | links.students | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/students | Gets all the students in all of a teacher's sections. | Y | Y | N | Y | N | ||
161 | x | x | x | x | x | x | x | x | x | x | ||
162 | School Admin | id | ObjectID | "519edecb58b876b01800038g" | Globally unique and stable id for student administrator created by Clever. Used in API calls (ex v2.0/school_admins/519edecb58b876b01800038g ) | Y | Y | Y | Y | N | ||
163 | School Admin | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for admin's district. | Y | Y | Y | Y | N | ||
164 | School Admin | name.first | String | "Pippi" | The school admin's first name | N | Y | Y | Y | N | ||
165 | School Admin | name.last | String | "Longstocking" | The school admin's last name | N | Y | Y | Y | N | ||
166 | School Admin | title | String | "Chief Instigator" | The school admin's job title, if specified. | N | N | N | Y | N | ||
167 | School Admin | String | "blanche.hoedel@sherman.edu" | Globally unique email address associated with the school admin. | N | Y | Y | Y | N | |||
168 | School Admin | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this admin is associated with. | Y | Y | N | Y | N | ||
169 | School Admin | staff_id | String | "1721" | An identifier provided by the district when syncing or creating this administrator. | N | Y | N | Y | N | ||
170 | School Admin | credentials.district_username | String | "bhoedel123" | School admin's preferred username, specified by district | N | N | N | Y | N | ||
171 | School Admin | links.self | Link | /v2.0/school_admins/519edecb58b876b01800038g | Stable link to school admin. | Y | Y | N | Y | N | ||
172 | School Admin | links.district | Link | /v2.0/school_admins/519edecb58b876b01800038g/district | Gets the district for a school admin. | Y | Y | N | Y | N | ||
173 | School Admin | links.schools | Link | /v2.0/school_admins/519edecb58b876b01800038g/schools | Gets all schools for a school admin. | Y | Y | N | Y | N | ||
174 | x | x | x | x | x | x | x | x | x | x | ||
175 | District Admin | id | ObjectID | "519edecb58b876b01800038f" | Globally unique and stable id for district administrator created by Clever. Used in API calls (ex v2.0/district_admins/519edecb58b876b01800038f ) | Y | Y | Y | Y | N | ||
176 | District Admin | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for admin's district. | Y | Y | Y | Y | N | ||
177 | District Admin | name.first | String | "Blanche" | The district admin's first name, when available. | N | Y | Y | Y | N | ||
178 | District Admin | name.last | String | "Hoedel" | The district admin's last name, when available. | N | N | Y | Y | N | ||
179 | District Admin | title | String | "Assistant to Principal" | The district admin's job title, if specified. | N | N | N | Y | N | ||
180 | District Admin | String | "blanche.hoedel@sherman.edu" | Globally unique email address associated with the district admin. | N | Y | Y | Y | N | |||
181 | District Admin | links.self | Link | /v2.0/district_admins/519edecb58b876b01800038f | Stable link to district admin. | Y | Y | Y | Y | N | ||
182 | x | x | x | x | x | x | x | x | x | x | ||
183 | Contact | id | ObjectID | "4fee004dca2e43cf270009d9" | Globally unique and stable id for student contact. | Y | Y | N | Y | N | ||
184 | Contact | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for contact's district. | Y | Y | N | Y | N | ||
185 | Contact | name | String | "Katie Bueller" | Name of contact. | N | Y | N | Y | N | ||
186 | Contact | type | String | "primary" | Type of contact. Possible values: ["Primary","Secondary", "Parent/Guardian", "Emergency", "Family", "Other"]. | Y | Y | N | Y | N | ||
187 | Contact | students | List of ObjectIDs | ["4fe3ff50dfa547000000033a", "4fe3ff50dfa5470000000359", "4fe3ff50dfa5470000000234"] | Globally unique and stable ids for students associated with contact. | Y | Y | N | Y | N | ||
188 | Contact | sis_id | String | "123456" | Internal contact identifier from source system. | N | N | N | Y | N | ||
189 | Contact | String | "kbueller@gmail.com" | Contact email address. | N | N | N | Y | N | |||
190 | Contact | phone | String | "727.565.1000" | Contact phone number. | N | N | N | Y | N | ||
191 | Contact | phone_type | String | "mobile" | Type of phone number. Possible values: ["Home", "Cell", "Work", "Other"]. | Y | N | N | Y | N | ||
192 | Contact | relationship | String | "Parent" | Relationship to student. Possible values: ["Parent","Grandparent","Self", "Aunt/Uncle", "Sibling," Other"]. | Y | N | N | Y | N | ||
193 | Contact | links.self | Link | /v2.0/contacts/4fee004cca2e43cf27000007 | Stable link to list of contacts. | Y | Y | N | Y | N | ||
194 | Contact | links.district | Link | /v2.0/contacts/4fee004cca2e43cf27000007/district | Gets the district for a contact. | Y | Y | N | Y | N | ||
195 | Contact | links.students | Link | /v2.0/contacts/4fee004cca2e43cf27000007/students | Gets all the students associated with a contact. | Y | Y | N | Y | N | ||
197 | x | x | x | x | x | x | x | x | x | x | ||
198 | Event | id | ObjectID | "4ffc35672f767044120301dd" | Globally unique and stable id for event created by Clever. Used in API calls (ex /v2.0/events/4ffc35672f767044120301dd). Events may be purged after 30 days. | Y | Y | N | Y | N | ||
199 | Event | created | Timestamp | "2012-07-10T14:00:07.818Z" | Time of the event. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
200 | Event | type | String | "Students.created" | Type of event. Format is resource.modification. Possible resources are ["schools","students","terms","courses","sections","teachers", "schooladmins", "districtadmins", "contacts"]. Possible modifications are ["created","updated","deleted"]. | Y | Y | N | Y | N | ||
201 | Event | data | Varies | Student resource | Event "data" field contains the resource (e.g. school, student, section, teacher) that was created or updated. | N | Y | N | Y | N | ||
202 | Event | previous_attributes | Varies | Fields from updated resource. | For events of the "updated" type, the previous_attributes field shows the prior value of the field or fields that have changed. | N | N | N | Y | N | ||
203 | Event | links.self | Link | /v2.0/events/4ffc35672f767044120301dd | Stable link to event. Events will be purged after 30 days. | Y | Y | N | Y | N | ||
204 | Data availability is subject to the decision of schools or districts to share their data. | |||||||||||
1 | Clever API v2.1 - Data Schema (All Fields) | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
2 | API v2.1 published 4/10/2019, last updated 6/18/2019. | ||||||||||
3 | For v2.0, select the v2.0 tab. | ||||||||||
4 | Important: Guaranteed fields are always present for the given resources. Validated fields will only contain the possible values or formats listed. All other data is shown as it exists in the source system, which may include empty strings. | ||||||||||
5 | |||||||||||
6 | Resource | Field Name | Format | Example Data | Description | Validated | Guaranteed | Field Availability by Product | |||
7 | Free Library Integration | District Integration | |||||||||
8 | District | id | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for district created by Clever. Used in API calls (ex /v2.0/districts/4fd43cc56d11340000000005 ) | Y | Y | N | Y | ||
9 | District | name | String | "Clever Public Schools" | District (or CMO) name. | N | Y | N | Y | ||
10 | District | mdr_number | String | "123456" | MDR number (used for matching district records) | N | N | N | Y | ||
11 | District | nces_id | String | "12093120" | Federal NCES id for school. | N | N | N | Y | ||
12 | District | sis_type | String | "sftp" | Indicates the type of SIS this district's data originates from. "sftp" is returned when district data is synced via SFTP or CSV upload. Other string values vary. | N | N | N | Y | ||
13 | District | state | String | "running" | Possible values: ["running", "pending", "error", "paused", ""] Pending means there is an error that the district can fix; Error means there is an error that Clever can fix. Paused means that the district's sync is paused to reflect last year's data. | Y | Y | N | Y | ||
14 | District | last_sync | Timestamp | "2012-07-10T14:00:07.818Z" | Last successful sync of district's data. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | N | N | Y | ||
15 | District | portal_url | String | "https://clever.com/in/demo" | Indicates the URL of the district's Clever portal. | Y | Y | N | Y | ||
16 | District | login_methods | Array | ["Clever Badges", "Clever Passwords"] | Indicates the type of login methods the district supports. Possible set of values: ["Clever Badges", "Canvas", "Clever Passwords", "Google", "LDAP", "SAML", "Other"] | Y | Y | N | Y | ||
17 | District | launch_date | Date | "2017-02-03" | Indicates when the end users in district are able to start logging in to the application. ISO 8601 extended format: YYYY-MM-DD. | Y | Y | N | Y | ||
18 | District | pause_start | Date | "2017-06-10" | Indicates when the district's data gets paused to reflect last year's data in the SIS. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | ||
19 | District | pause_end | Date | "2017-08-24" | Indicates when the district's data is unpaused to reflect data for the new school year. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | ||
20 | District | district_contact.district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for school's district. | Y | N | N | Y | ||
21 | District | district_contact.name.first | String | "Whitney" | District administrator's first name. | N | N | N | Y | ||
22 | District | district_contact.name.last | String | "Houston" | District administrator's last name. | N | N | N | Y | ||
23 | District | district_contact.email | String | "whouston@cleverusd.org" | District administrator's email. | N | N | N | Y | ||
24 | District | district_contact.title | String | "IT Director" | District administrator's title, if available. | N | N | N | Y | ||
25 | District | district_contact.id | ObjectID | "5aec8191fa7a610001604ce7" | Globally unique and stable id for the district admin. | Y | N | N | Y | ||
26 | District | error | String | "Invalid username/password specified. Please check SIS credentials on settings page." | User-facing string describing a district error state. Typically useful only for district administrators. Should not be used to programmatically determine district status. | N | N | N | Y | ||
27 | District | links.self | Link | /v2.0/districts/4fd43cc56d11340000000005 | Stable link to district. | Y | Y | N | Y | ||
28 | x | x | x | x | x | x | x | x | x | ||
29 | School | id | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for school created by Clever. Used in API calls (ex. /v2.0/schools/4fe3ff50dfa5470000000001). | Y | Y | N | Y | ||
30 | School | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for school's district. | Y | Y | N | Y | ||
31 | School | last_modified | Timestamp | "2012-06-22T05:14:57.372Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
32 | School | name | String | "Cleverton High" | School name. | N | Y | N | Y | ||
33 | School | state_id | String | "1230192301923" | State school identifier. | N | N | N | Y | ||
34 | School | school_number | String | "10045" | District or county school identifier. | N | Y | N | Y | ||
35 | School | sis_id | String | "97" | Internal school identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | ||
36 | School | nces_id | String | "12093120" | Federal NCES id for school. | N | N | N | Y | ||
37 | School | low_grade | String | "9" | School's beginning grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | ||
38 | School | high_grade | String | "12" | School's exit grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | N | Y | ||
39 | School | principal.name | String | "Edward Rooney" | School principal's name. | N | N | N | Y | ||
40 | School | principal.email | String | "erooney@highschool.org" | School principal's email address. | N | N | N | Y | ||
41 | School | location.address | String | "456 Elm St." | School address. | N | N | N | Y | ||
42 | School | location.city | String | "Pleasantville" | School address city. | N | N | N | Y | ||
43 | School | location.state | String | "MA" | School address state. | N | N | N | Y | ||
44 | School | location.zip | String | "90210" or "12345-0000" | School address ZIP. | N | N | N | Y | ||
45 | School | mdr_number | String | "123456" | MDR number (used for matching school records) | N | N | N | Y | ||
46 | School | phone | String | "515.555.1234" | School phone number. | N | N | N | Y | ||
47 | School | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
48 | School | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | ||
49 | School | links.self | Link | /v2.0/schools/4fe3ff50dfa5470000000001 | Stable link to school. | Y | Y | N | Y | ||
50 | School | links.district | Link | /v2.0/schools/4fe3ff50dfa5470000000001/district | Gets the district for a school. | Y | Y | N | Y | ||
51 | School | links.teachers | Link | /v2.0/schools/4fe3ff50dfa5470000000001/teachers | Gets all teachers for a school. | Y | Y | N | Y | ||
52 | School | links.students | Link | /v2.0/schools/4fe3ff50dfa5470000000001/students | Gets all students for a school. | Y | Y | N | Y | ||
53 | School | links.sections | Link | /v2.0/schools/4fe3ff50dfa5470000000001/sections | Gets all sections for a school. | Y | Y | N | Y | ||
54 | x | x | x | x | x | x | x | x | x | ||
55 | Term | id | ObjectID | "598349d40ad2e2f959000006" | Globally unique and stable id for term created by Clever. Used in API calls (ex /v2.0/terms/4fe3ff51dfa547000000041f) | Y | Y | N | Y | ||
56 | Term | district | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for term's district. | Y | Y | N | Y | ||
57 | Term | name | String | "S1" | Name provided by district. | N | N | N | Y | ||
58 | Term | start_date | Date | "2012-12-02" | Start date for the term. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | ||
59 | Term | end_date | Date | "2013-06-01" | End date for the term. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | ||
60 | Term | links.self | Link | /v2.0/terms/59841f3a40acac766d00000e | Stable link to term. | Y | Y | N | Y | ||
61 | Term | links.district | Link | /v2.0/terms/59841f3a40acac766d00000e/district | Gets the district for a term. | Y | Y | N | Y | ||
62 | Term | links.sections | Link | /v2.0/terms/59841f3a40acac766d00000e/sections | Gets all sections for a term. | Y | Y | N | Y | ||
63 | x | x | x | x | x | x | x | x | x | ||
64 | Course | id | ObjectID | "5970d4dd35e9e6974100014d" | Globally unique and stable id for course created by Clever. Used in API calls (ex /v2.0/courses/4fe3ff51dfa547000000041f) | Y | Y | N | Y | ||
65 | Course | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for course's district. | Y | Y | N | Y | ||
66 | Course | name | String | "AP Calculus" | Name provided by district. | N | N | N | Y | ||
67 | Course | number | String | "406" | Course number provided by district. | N | N | N | Y | ||
68 | Course | links.self | Link | /v2.0/courses/596f1147e80fa32c53000486 | Stable link to course. | Y | Y | N | Y | ||
69 | Course | links.district | Link | /v2.0/courses/596f1147e80fa32c53000486/district | Gets the district for a course. | Y | Y | N | Y | ||
70 | Course | links.sections | Link | /v2.0/courses/596f1147e80fa32c53000486/sections | Gets all sections for a course. | Y | Y | N | Y | ||
71 | x | x | x | x | x | x | x | x | x | ||
72 | Section | id | ObjectID | "4fee004dca2e43cf27000807" | Globally unique and stable id for section created by Clever. Used in API calls (ex /v2.0/sections/4fe3ff51dfa547000000041f) | Y | Y | Y | Y | ||
73 | Section | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for section's district. | Y | Y | N | Y | ||
74 | Section | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for section's school. | Y | Y | N | Y | ||
75 | Section | teacher | ObjectID | "4fee004dca2e43cf270007d6" | Globally unique and stable id for section's primary teacher. | Y | Y | Y | Y | ||
76 | Section | teachers | List of ObjectIDs | ["4fee004dca2e43cf270007d6", "4fee004dca2e43df270007d7", "4fee004dca2e43ce270007d8"] | List of ids of co-teachers associated with the section. Primary teacher will be the first id in the array (the same as the "sections.teacher" field) | Y | Y | Y | Y | ||
77 | Section | last_modified | Timestamp | "2012-06-22T05:14:57.825Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
78 | Section | name | String | "Algebra I - Escalante - 5(A)" | Section name. Clever generates a section name by concatenating "course_name" "- teacher_last_name" and "- period", e.g. Algebra - Smith - Period 3. If course name is not present, the section name from the source system is used. | N | Y | Y | Y | ||
79 | Section | course | ObjectID | "4fee004dca2e43df270007d7" | The id of the course associated with the section. | Y | N | N | Y | ||
80 | Section | period | String | "5(A)" | Bell schedule information for the section. | N | N | N | Y | ||
81 | Section | subject | String | "Math" | The subject associated with the section. Possible values: ["english/language arts","math","science","social studies","language","homeroom/advisory", "interventions/online learning","technology and engineering","PE and health","arts and music","other",""] | Y | Y | Y | Y | ||
82 | Section | students | List of ObjectIDs | ["4fe3ff50dfa547000000033a", "4fe3ff50dfa5470000000359", "4fe3ff50dfa5470000000234"] | List of ids of students in section. | Y | Y | Y | Y | ||
83 | Section | sis_id | String | "1023" | Internal section identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | ||
84 | Section | section_number | String | "104" | Section identifier, set by school or district. | N | N | Y | Y | ||
85 | Section | grade | String | "9" | Section grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | Y | Y | ||
86 | Section | term_id | ObjectID | "4fee004dca2e43df270007d7" | ID of the term associated with the section. | Y | N | N | Y | ||
87 | Section | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | Y | |||
88 | Section | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
89 | Section | links.self | Link | /v2.0/sections/4fe3ff51dfa547000000041f | Stable link to section. | Y | Y | Y | Y | ||
90 | Section | links.district | Link | /v2.0/sections/4fe3ff51dfa547000000041f/district | Gets the district for section. | Y | Y | N | Y | ||
91 | Section | links.teacher | Link | /v2.0/sections/4fe3ff51dfa547000000041f/teacher | Gets the teacher for a section. | Y | Y | N | Y | ||
92 | Section | links.teachers | Link | /v2.0/sections/4fe3ff51dfa547000000041f/teachers | Gets teachers associated with a section. | Y | Y | N | Y | ||
93 | Section | links.students | Link | /v2.0/sections/4fe3ff51dfa547000000041f/students | Gets the students for a section. | Y | Y | N | Y | ||
94 | Section | links.school | Link | /v2.0/sections/4fe3ff51dfa547000000041f/school | Gets the school for a section. | Y | Y | N | Y | ||
95 | Section | links.term | Link | /v2.0/sections/4fe3ff51dfa547000000041f/term | Gets the term for a section. | Y | Y | N | Y | ||
96 | Section | links.course | Link | /v2.0/sections/4fe3ff51dfa547000000041f/course | Gets the course for a section. | Y | Y | N | Y | ||
97 | x | x | x | x | x | x | x | x | x | ||
98 | Student | id | ObjectID | "4fee004cca2e43cf27000007" | Globally unique and stable id for student, created by Clever. Used in API calls (ex. /v2.0/students/4fee004cca2e43cf27000007/). | Y | Y | Y | Y | ||
99 | Student | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for student's district. | Y | Y | N | Y | ||
100 | Student | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for student's primary school. | Y | Y | N | Y | ||
101 | Student | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this student is associated with. | Y | Y | N | Y | ||
102 | Student | enrollments | List of enrollments by school | [{"school": "4fe3ff50dfa547000000033c", "start_date": "2018-08-01T00:00:00.000Z", "end_date":"2018-12-15T00:00:00.000Z"}] | List of school enrollments which include school id and start/end dates based on when the student is in at least one active section at a school. | Y | Y | N | Y | ||
103 | Student | student_number | String | "10772" | School or district defined student identifier. | N | N | N | Y | ||
104 | Student | state_id | String | "1742739" | State student identifier. | N | N | N | Y | ||
105 | Student | sis_id | String | "2411" | Internal student identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | ||
106 | Student | name.first | String | "Ferris" | Student first name. | N | Y | Y | Y | ||
107 | Student | name.middle | String | "W" | Student middle name or initial. | N | N | Y | Y | ||
108 | Student | name.last | String | "Bueller" | Student last name. | N | Y | Y | Y | ||
109 | Student | location.address | String | "123 Main St." | Primary student address. | N | N | N | Y | ||
110 | Student | location.city | String | "Anytown" | Primary student city. | N | N | N | Y | ||
111 | Student | location.state | String | "OH" | Primary student state. | N | N | N | Y | ||
112 | Student | location.zip | String | "90210" or "12345-0000" | Primary student address ZIP. | N | N | N | Y | ||
113 | Student | location.lat | String | "37.4870246645558" | Primary student address latitude. | N | N | N | Y | ||
114 | Student | location.lon | String | "122.259305648889" | Primary student address longitude. | N | N | N | Y | ||
115 | Student | gender | String | "F" | Student gender. Possible values ["M","F", "X", ""]. | Y | N | N | Y | ||
116 | Student | dob | Date | 10/20/1995 | Student birthdate. MM/DD/YYYY format. | Y | N | N | Y | ||
117 | Student | grade | String | "9" | Student grade level. Possible values [ "1", … ,"13", "PreKindergarten", "TransitionalKindergarten", "Kindergarten", "InfantToddler", "Preschool", "PostGraduate", "Ungraded", "Other", ""]. | Y | N | Y | Y | ||
118 | Student | graduation_year | String | "2019" | Graduation year provided by district. | Y | N | N | Y | ||
119 | Student | ell_status | String | "Y" | Student English Language Learner (or Limited English Proficiency) status. Possible values ["Y", "N", ""]. Experimental field - may not be covered in all systems. | Y | N | N | Y | ||
120 | Student | race | String | "Caucasian" | Student's race. Possible values: ["Caucasian", "Asian", "Black or African American", "American Indian", "Hawaiian or Other Pacific Islander", "Two or More Races","Unknown", ""]. | Y | N | N | Y | ||
121 | Student | unweighted_gpa | String | "3.9" | Student's unweighted GPA value. | N | N | N | Y | ||
122 | Student | weighted_gpa | String | "4.2" | Student's weighted GPA value. | N | N | N | Y | ||
123 | Student | home_language | String | "Chinese" | Language spoken in the home setting. | N | N | N | Y | ||
124 | Student | hispanic_ethnicity | String | "N" | Student's Hispanic/Latino ethnicity. Possible values: ["Y", "N", ""]. | Y | N | N | Y | ||
125 | Student | String | "fbueller@cleverschools.org" | Student's email address. | N | N | N | Y | |||
126 | Student | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | Y | |||
127 | Student | credentials.district_username | String | "fbueller1234" | Student's preferred username, specified by district. | N | N | N | Y | ||
128 | Student | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
129 | Student | last_modified | Timestamp | "2012-06-22T05:14:57.375Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
130 | Student | links.self | Link | /v2.0/students/4fee004cca2e43cf27000007 | Stable link to student. | Y | Y | Y | Y | ||
131 | Student | links.district | Link | /v2.0/students/4fee004cca2e43cf27000007/district | Gets the district for a student. | Y | Y | N | Y | ||
132 | Student | links.school | Link | /v2.0/students/4fee004cca2e43cf27000007/school | Gets the school for a student. | Y | Y | N | Y | ||
133 | Student | links.schools | Link | /v2.0/students/4fee004cca2e43cf27000007/schools | Gets all schools for a student. | Y | Y | N | Y | ||
134 | Student | links.sections | Link | /v2.0/students/4fee004cca2e43cf27000007/sections | Gets all sections for a student. | Y | Y | N | Y | ||
135 | Student | links.contacts | Link | /v2.0/students/4fee004cca2e43cf27000007/contacts | Gets all contacts for a student. | Y | Y | N | Y | ||
136 | Student | links.teachers | Link | /v2.0/students/4fee004cca2e43cf27000007/teachers | Gets all teachers for a student. | Y | Y | N | Y | ||
137 | x | x | x | x | x | x | x | x | x | ||
138 | Teacher | id | ObjectID | "4fee004dca2e43cf270007d6" | Globally unique and stable id for teacher created by Clever. Used in API calls (ex /v2.0/teachers/4fee004dca2e43cf270007d6). | Y | Y | Y | Y | ||
139 | Teacher | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for teacher's primary school. | Y | Y | N | Y | ||
140 | Teacher | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for teacher's district. | Y | Y | N | Y | ||
141 | Teacher | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this teacher is associated with. | Y | Y | N | Y | ||
142 | Teacher | last_modified | Timestamp | "2012-06-22T05:14:57.799Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
143 | Teacher | sis_id | String | "455" | Internal teacher identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | ||
144 | Teacher | String | "jescalante@cleverprep.org" | Teacher email. | N | N | Y | Y | |||
145 | Teacher | name.first | String | "Jamie" | Teacher first name. | N | Y | Y | Y | ||
146 | Teacher | name.middle | String | "A." | Teacher middle name or initial. | N | N | Y | Y | ||
147 | Teacher | name.last | String | "Escalante" | Teacher last name. | N | Y | Y | Y | ||
148 | Teacher | teacher_number | String | "110011" | District or school assigned teacher identifier. | N | N | N | Y | ||
149 | Teacher | state_id | String | "2853840" | State teacher identifier. | N | N | N | Y | ||
150 | Teacher | ext | List of extension fields | {"rti_math":"3","iep_plan":"1"} | Extension fields where field name and value is defined by the district | N | N | N | Y | ||
151 | Teacher | title | String | "Math Department Chair" | Teacher's title | N | N | N | Y | ||
152 | Teacher | credentials.district_username | String | "jescalante@cleverprep.org" | Teacher's preferred username, specified by district. | N | N | N | Y | ||
153 | Teacher | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
154 | Teacher | links.self | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed | Stable link to teacher. | Y | Y | Y | Y | ||
155 | Teacher | links.district | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/district | Gets the district for a teacher. | Y | Y | N | Y | ||
156 | Teacher | links.sections | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/sections | Gets all of the sections for a teacher. | Y | Y | Y | Y | ||
157 | Teacher | links.school | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/school | Gets the school for a teacher. | Y | Y | N | Y | ||
158 | Teacher | links.schools | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/schools | Gets all schools for a teacher. | Y | Y | N | Y | ||
159 | Teacher | links.students | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/students | Gets all the students in all of a teacher's sections. | Y | Y | N | Y | ||
160 | x | x | x | x | x | x | x | x | x | ||
161 | School Admin | id | ObjectID | "519edecb58b876b01800038g" | Globally unique and stable id for student administrator created by Clever. Used in API calls (ex v2.0/school_admins/519edecb58b876b01800038g ) | Y | Y | N | Y | ||
162 | School Admin | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for admin's district. | Y | Y | N | Y | ||
163 | School Admin | name.first | String | "Pippi" | The school admin's first name | N | Y | N | Y | ||
164 | School Admin | name.last | String | "Longstocking" | The school admin's last name | N | Y | N | Y | ||
165 | School Admin | title | String | "Chief Instigator" | The school admin's job title, if specified. | N | N | N | Y | ||
166 | School Admin | String | "blanche.hoedel@sherman.edu" | Globally unique email address associated with the school admin. | N | Y | N | Y | |||
167 | School Admin | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this admin is associated with. | Y | Y | N | Y | ||
168 | School Admin | staff_id | String | "1721" | An identifier provided by the district when syncing or creating this administrator. | N | Y | N | Y | ||
169 | School Admin | credentials.district_username | String | "bhoedel123" | School admin's preferred username, specified by district | N | N | N | Y | ||
170 | School Admin | department | String | "mathematics" | Department the school admin is associated with | N | N | N | Y | ||
171 | School Admin | ext | List of extension fields | {"secondary_title":"coach"} | Extension fields where field name and value is defined by the district | N | N | N | Y | ||
172 | School Admin | links.self | Link | /v2.0/school_admins/519edecb58b876b01800038g | Stable link to school admin. | Y | Y | N | Y | ||
173 | School Admin | links.district | Link | /v2.0/school_admins/519edecb58b876b01800038g/district | Gets the district for a school admin. | Y | Y | N | Y | ||
174 | School Admin | links.schools | Link | /v2.0/school_admins/519edecb58b876b01800038g/schools | Gets all schools for a school admin. | Y | Y | N | Y | ||
175 | x | x | x | x | x | x | x | x | x | ||
176 | District Admin | id | ObjectID | "519edecb58b876b01800038f" | Globally unique and stable id for district administrator created by Clever. Used in API calls (ex v2.0/district_admins/519edecb58b876b01800038f ) | Y | Y | N | Y | ||
177 | District Admin | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for admin's district. | Y | Y | N | Y | ||
178 | District Admin | name.first | String | "Blanche" | The district admin's first name, when available. | N | Y | N | Y | ||
179 | District Admin | name.last | String | "Hoedel" | The district admin's last name, when available. | N | N | N | Y | ||
180 | District Admin | title | String | "Assistant to Principal" | The district admin's job title, if specified. | N | N | N | Y | ||
181 | District Admin | String | "blanche.hoedel@sherman.edu" | Globally unique email address associated with the district admin. | N | Y | N | Y | |||
182 | District Admin | links.self | Link | /v2.0/district_admins/519edecb58b876b01800038f | Stable link to district admin. | Y | Y | N | Y | ||
183 | x | x | x | x | x | x | x | x | x | ||
184 | Contact | id | ObjectID | "4fee004dca2e43cf270009d9" | Globally unique and stable id for student contact. | Y | Y | N | Y | ||
185 | Contact | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for contact's district. | Y | Y | N | Y | ||
186 | Contact | name | String | "Katie Bueller" | Name of contact. | N | Y | N | Y | ||
187 | Contact | type | String | "primary" | Type of contact. Possible values: ["Primary","Secondary", "Parent/Guardian", "Emergency", "Family", "Other"]. | Y | Y | N | Y | ||
188 | Contact | students | List of ObjectIDs | ["4fe3ff50dfa547000000033a", "4fe3ff50dfa5470000000359", "4fe3ff50dfa5470000000234"] | Globally unique and stable ids for students associated with contact. | Y | Y | N | Y | ||
189 | Contact | sis_id | String | "123456" | Internal contact identifier from source system. | N | N | N | Y | ||
190 | Contact | String | "kbueller@gmail.com" | Contact email address. | N | N | N | Y | |||
191 | Contact | phone | String | "727.565.1000" | Contact phone number. | N | N | N | Y | ||
192 | Contact | phone_type | String | "mobile" | Type of phone number. Possible values: ["Home", "Cell", "Work", "Other"]. | Y | N | N | Y | ||
193 | Contact | relationship | String | "Parent" | Relationship to student. Possible values: ["Parent","Grandparent","Self", "Aunt/Uncle", "Sibling," Other"]. | Y | N | N | Y | ||
194 | Contact | links.self | Link | /v2.0/contacts/4fee004cca2e43cf27000007 | Stable link to list of contacts. | Y | Y | N | Y | ||
195 | Contact | links.district | Link | /v2.0/contacts/4fee004cca2e43cf27000007/district | Gets the district for a contact. | Y | Y | N | Y | ||
196 | Contact | links.students | Link | /v2.0/contacts/4fee004cca2e43cf27000007/students | Gets all the students associated with a contact. | Y | Y | N | Y | ||
198 | x | x | x | x | x | x | x | x | x | ||
199 | Event | id | ObjectID | "4ffc35672f767044120301dd" | Globally unique and stable id for event created by Clever. Used in API calls (ex /v2.0/events/4ffc35672f767044120301dd). Events may be purged after 30 days. | Y | Y | N | Y | ||
200 | Event | created | Timestamp | "2012-07-10T14:00:07.818Z" | Time of the event. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | ||
201 | Event | type | String | "Students.created" | Type of event. Format is resource.modification. Possible resources are ["schools","students","terms","courses","sections","teachers", "schooladmins", "districtadmins", "contacts"]. Possible modifications are ["created","updated","deleted"]. | Y | Y | N | Y | ||
202 | Event | data | Varies | Student resource | Event "data" field contains the resource (e.g. school, student, section, teacher) that was created or updated. | N | Y | N | Y | ||
203 | Event | previous_attributes | Varies | Fields from updated resource. | For events of the "updated" type, the previous_attributes field shows the prior value of the field or fields that have changed. | N | N | N | Y | ||
204 | Event | links.self | Link | /v2.0/events/4ffc35672f767044120301dd | Stable link to event. Events will be purged after 30 days. | Y | Y | N | Y | ||
205 | Data availability is subject to the decision of schools or districts to share their data. | ||||||||||
1 | Clever API v2.0 - Data Schema (All Fields) | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
2 | API v2.0 published 11/6/2017, last updated 10/01/2018. | |||||||||||
3 | ||||||||||||
4 | Important: Guaranteed fields are always present for the given resources. Validated fields will only contain the possible values or formats listed. All other data is shown as it exists in the source system, which may include empty strings. | |||||||||||
5 | ||||||||||||
6 | Resource | Field Name | Format | Example Data | Description | Validated | Guaranteed | Field Availability by Product | ||||
7 | Free Instant Login | Secure Sync | Free Library | |||||||||
8 | District | id | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for district created by Clever. Used in API calls (ex /v2.0/districts/4fd43cc56d11340000000005 ) | Y | Y | Y | Y | N | ||
9 | District | name | String | "Clever Public Schools" | District (or CMO) name. | N | Y | Y | Y | N | ||
10 | District | mdr_number | String | "123456" | MDR number (used for matching district records) | N | N | N | Y | N | ||
11 | District | nces_id | String | "12093120" | Federal NCES id for school. | N | N | N | Y | N | ||
12 | District | sis_type | String | "sftp" | Indicates the type of SIS this district's data originates from. "sftp" is returned when district data is synced via SFTP or CSV upload. Other string values vary. | N | N | N | Y | N | ||
13 | District | state | String | "running" | Possible values: ["running", "pending", "error", "paused"] Pending means there is an error that the district can fix; Error means there is an error that Clever can fix. Paused means that the district's sync is paused to reflect last year's data. | Y | Y | N | Y | N | ||
14 | District | last_sync | Timestamp | "2012-07-10T14:00:07.818Z" | Last successful sync of district's data. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | N | N | Y | N | ||
15 | District | launch_date | Date | "2017-02-03" | Indicates when the end users in district are able to start logging in to the application. ISO 8601 extended format: YYYY-MM-DD. | Y | Y | N | Y | N | ||
16 | District | pause_start | Date | "2017-06-10" | Indicates when the district's data gets paused to reflect last year's data in the SIS. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
17 | District | pause_end | Date | "2017-08-24" | Indicates when the district's data is unpaused to reflect data for the new school year. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
18 | District | error | String | "Invalid username/password specified. Please check SIS credentials on settings page." | User-facing string describing a district error state. Typically useful only for district administrators. Should not be used to programmatically determine district status. | N | N | N | Y | N | ||
19 | District | links.self | Link | /v2.0/districts/4fd43cc56d11340000000005 | Stable link to district. | Y | Y | N | Y | N | ||
20 | x | x | x | x | x | x | x | x | x | x | ||
21 | School | id | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for school created by Clever. Used in API calls (ex. /v2.0/schools/4fe3ff50dfa5470000000001). | Y | Y | N | Y | N | ||
22 | School | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for school's district. | Y | Y | N | Y | N | ||
23 | School | last_modified | Timestamp | "2012-06-22T05:14:57.372Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
24 | School | name | String | "Cleverton High" | School name. | N | Y | N | Y | N | ||
25 | School | state_id | String | "1230192301923" | State school identifier. | N | N | N | Y | N | ||
26 | School | school_number | String | "10045" | District or county school identifier. | N | Y | N | Y | N | ||
27 | School | sis_id | String | "97" | Internal school identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
28 | School | nces_id | String | "12093120" | Federal NCES id for school. | N | N | N | Y | N | ||
29 | School | low_grade | String | "9" | School's beginning grade level. Possible values [ "1", … ,"12", "PreKindergarten","Kindergarten","PostGraduate","Other"]. | Y | N | N | Y | N | ||
30 | School | high_grade | String | "12" | School's exit grade level. Possible values [ "1", … ,"12", "PreKindergarten","Kindergarten","PostGraduate","Other"]. | Y | N | N | Y | N | ||
31 | School | principal.name | String | "Edward Rooney" | School principal's name. | N | N | N | Y | N | ||
32 | School | principal.email | String | "erooney@highschool.org" | School principal's email address. | N | N | N | Y | N | ||
33 | School | location.address | String | "456 Elm St." | School address. | N | N | N | Y | N | ||
34 | School | location.city | String | "Pleasantville" | School address city. | N | N | N | Y | N | ||
35 | School | location.state | String | "MA" | School address state. | N | N | N | Y | N | ||
36 | School | location.zip | String | "90210" or "12345-0000" | School address ZIP. | N | N | N | Y | N | ||
37 | School | mdr_number | String | "123456" | MDR number (used for matching school records) | N | N | N | Y | N | ||
38 | School | phone | String | "515.555.1234" | School phone number. | N | N | N | Y | N | ||
39 | School | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
40 | School | links.self | Link | /v2.0/schools/4fe3ff50dfa5470000000001 | Stable link to school. | Y | Y | N | Y | N | ||
41 | School | links.district | Link | /v2.0/schools/4fe3ff50dfa5470000000001/district | Gets the district for a school. | Y | Y | N | Y | N | ||
42 | School | links.teachers | Link | /v2.0/schools/4fe3ff50dfa5470000000001/teachers | Gets all teachers for a school. | Y | Y | N | Y | N | ||
43 | School | links.students | Link | /v2.0/schools/4fe3ff50dfa5470000000001/students | Gets all students for a school. | Y | Y | N | Y | N | ||
44 | School | links.sections | Link | /v2.0/schools/4fe3ff50dfa5470000000001/sections | Gets all sections for a school. | Y | Y | N | Y | N | ||
45 | x | x | x | x | x | x | x | x | x | x | ||
46 | Term | id | ObjectID | "598349d40ad2e2f959000006" | Globally unique and stable id for term created by Clever. Used in API calls (ex /v2.0/terms/4fe3ff51dfa547000000041f) | Y | Y | N | Y | N | ||
47 | Term | district | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for term's district. | Y | Y | N | Y | N | ||
48 | Term | name | String | "S1" | Name provided by district. | N | N | N | Y | N | ||
49 | Term | start_date | Date | "2012-12-02" | Start date for the term. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
50 | Term | end_date | Date | "2013-06-01" | End date for the term. ISO 8601 extended format: YYYY-MM-DD. | Y | N | N | Y | N | ||
51 | Term | links.self | Link | /v2.0/terms/59841f3a40acac766d00000e | Stable link to term. | Y | Y | N | Y | N | ||
52 | Term | links.district | Link | /v2.0/terms/59841f3a40acac766d00000e/district | Gets the district for a term. | Y | Y | N | Y | N | ||
53 | Term | links.sections | Link | /v2.0/terms/59841f3a40acac766d00000e/sections | Gets all sections for a term. | Y | Y | N | Y | N | ||
54 | x | x | x | x | x | x | x | x | x | x | ||
55 | Course | id | ObjectID | "5970d4dd35e9e6974100014d" | Globally unique and stable id for course created by Clever. Used in API calls (ex /v2.0/courses/4fe3ff51dfa547000000041f) | Y | Y | N | Y | N | ||
56 | Course | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for course's district. | Y | Y | N | Y | N | ||
57 | Course | name | String | "AP Calculus" | Name provided by district. | N | N | N | Y | N | ||
58 | Course | number | String | "406" | Course number provided by district. | N | N | N | Y | N | ||
59 | Course | links.self | Link | /v2.0/courses/596f1147e80fa32c53000486 | Stable link to course. | Y | Y | N | Y | N | ||
60 | Course | links.district | Link | /v2.0/courses/596f1147e80fa32c53000486/district | Gets the district for a course. | Y | Y | N | Y | N | ||
61 | Course | links.sections | Link | /v2.0/courses/596f1147e80fa32c53000486/sections | Gets all sections for a course. | Y | Y | N | Y | N | ||
62 | x | x | x | x | x | x | x | x | x | x | ||
63 | Section | id | ObjectID | "4fee004dca2e43cf27000807" | Globally unique and stable id for section created by Clever. Used in API calls (ex /v2.0/sections/4fe3ff51dfa547000000041f) | Y | Y | N | Y | Y | ||
64 | Section | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for section's district. | Y | Y | N | Y | N | ||
65 | Section | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for section's school. | Y | Y | N | Y | N | ||
66 | Section | teacher | ObjectID | "4fee004dca2e43cf270007d6" | Globally unique and stable id for section's primary teacher. | Y | Y | N | Y | Y | ||
67 | Section | teachers | List of ObjectIDs | ["4fee004dca2e43cf270007d6", "4fee004dca2e43df270007d7", "4fee004dca2e43ce270007d8"] | List of ids of co-teachers associated with the section. Primary teacher will be the first id in the array (the same as the "sections.teacher" field) | Y | Y | N | Y | Y | ||
68 | Section | last_modified | Timestamp | "2012-06-22T05:14:57.825Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
69 | Section | name | String | "Algebra I - Escalante - 5(A)" | Section name. Clever generates a section name by concatenating "course_name" "- teacher_last_name" and "- period", e.g. Algebra - Smith - Period 3. If course name is not present, the section name from the source system is used. | N | Y | N | Y | Y | ||
70 | Section | course | ObjectID | "4fee004dca2e43df270007d7" | The id of the course associated with the section. | Y | N | N | Y | N | ||
71 | Section | period | String | "5(A)" | Bell schedule information for the section. | N | N | N | Y | N | ||
72 | Section | subject | String | "Math" | The subject associated with the section. Possible values: ["english/language arts","math","science","social studies","language","homeroom/advisory", "interventions/online learning","technology and engineering","PE and health","arts and music","other"] | Y | Y | N | Y | Y | ||
73 | Section | students | List of ObjectIDs | ["4fe3ff50dfa547000000033a", "4fe3ff50dfa5470000000359", "4fe3ff50dfa5470000000234"] | List of ids of students in section. | Y | Y | N | Y | Y | ||
74 | Section | sis_id | String | "1023" | Internal section identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
75 | Section | section_number | String | "104" | Section identifier, set by school or district. | N | N | N | Y | Y | ||
76 | Section | grade | String | "9" | Section grade level. Possible values [ "1", … ,"12", "PreKindergarten","Kindergarten","PostGraduate","Other"]. | Y | N | N | Y | Y | ||
77 | Section | term_id | ObjectID | "4fee004dca2e43df270007d7" | ID of the term associated with the section. | Y | N | N | Y | N | ||
78 | Section | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
79 | Section | links.self | Link | /v2.0/sections/4fe3ff51dfa547000000041f | Stable link to section. | Y | Y | N | Y | Y | ||
80 | Section | links.district | Link | /v2.0/sections/4fe3ff51dfa547000000041f/district | Gets the district for section. | Y | Y | N | Y | N | ||
81 | Section | links.teacher | Link | /v2.0/sections/4fe3ff51dfa547000000041f/teacher | Gets the teacher for a section. | Y | Y | N | Y | N | ||
82 | Section | links.teachers | Link | /v2.0/sections/4fe3ff51dfa547000000041f/teachers | Gets teachers associated with a section. | Y | Y | N | Y | N | ||
83 | Section | links.students | Link | /v2.0/sections/4fe3ff51dfa547000000041f/students | Gets the students for a section. | Y | Y | N | Y | N | ||
84 | Section | links.school | Link | /v2.0/sections/4fe3ff51dfa547000000041f/school | Gets the school for a section. | Y | Y | N | Y | N | ||
85 | Section | links.term | Link | /v2.0/sections/4fe3ff51dfa547000000041f/term | Gets the term for a section. | Y | Y | N | Y | N | ||
86 | Section | links.course | Link | /v2.0/sections/4fe3ff51dfa547000000041f/course | Gets the course for a section. | Y | Y | N | Y | N | ||
87 | x | x | x | x | x | x | x | x | x | x | ||
88 | Student | id | ObjectID | "4fee004cca2e43cf27000007" | Globally unique and stable id for student, created by Clever. Used in API calls (ex. /v2.0/students/4fee004cca2e43cf27000007/). | Y | Y | Y | Y | Y | ||
89 | Student | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for student's district. | Y | Y | Y | Y | N | ||
90 | Student | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for student's primary school. | Y | Y | N | Y | N | ||
91 | Student | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this student is associated with. | Y | Y | N | Y | N | ||
92 | Student | last_modified | Timestamp | "2012-06-22T05:14:57.375Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
93 | Student | student_number | String | "10772" | School or district defined student identifier. | N | N | N | Y | N | ||
94 | Student | state_id | String | "1742739" | State student identifier. | N | N | N | Y | N | ||
95 | Student | sis_id | String | "2411" | Internal student identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
96 | Student | name.first | String | "Ferris" | Student first name. | N | Y | Y | Y | Y | ||
97 | Student | name.middle | String | "W" | Student middle name or initial. | N | N | N | Y | Y | ||
98 | Student | name.last | String | "Bueller" | Student last name. | N | Y | Y | Y | Y | ||
99 | Student | location.address | String | "123 Main St." | Primary student address. | N | N | N | Y | N | ||
100 | Student | location.city | String | "Anytown" | Primary student city. | N | N | N | Y | N | ||
101 | Student | location.state | String | "OH" | Primary student state. | N | N | N | Y | N | ||
102 | Student | location.zip | String | "90210" or "12345-0000" | Primary student address ZIP. | N | N | N | Y | N | ||
103 | Student | location.lat | String | "37.4870246645558" | Primary student address latitude. | N | N | N | Y | N | ||
104 | Student | location.lon | String | "122.259305648889" | Primary student address longitude. | N | N | N | Y | N | ||
105 | Student | gender | String | "M" | Student gender. Possible values ["M","F",""]. | Y | N | N | Y | N | ||
106 | Student | dob | Date | 10/20/1995 | Student birthdate. MM/DD/YYYY format. | Y | N | N | Y | N | ||
107 | Student | grade | String | "9" | Student grade level. Possible values [ "1", … ,"12", "PreKindergarten","Kindergarten","PostGraduate","Other"]. | Y | N | N | Y | Y | ||
108 | Student | graduation_year | String | "2019" | Graduation year provided by district. | Y | N | N | Y | N | ||
109 | Student | ell_status | String | "Y" | Student English Language Learner (or Limited English Proficiency) status. Possible values ["Y", "N", ""]. Experimental field - may not be covered in all systems. | Y | N | N | Y | N | ||
110 | Student | race | String | "Caucasian" | Student's race. Possible values: ["Caucasian", "Asian", "Black or African American", "American Indian", "Hawaiian or Other Pacific Islander", "Two or More Races","Unknown", ""]. | Y | N | N | Y | N | ||
111 | Student | unweighted_gpa | String | "3.9" | Student's unweighted GPA value. | N | N | N | N | |||
112 | Student | weighted_gpa | String | "4.2" | Student's weighted GPA value. | N | N | N | N | |||
113 | Student | home_language | String | "Chinese" | Language spoken in the home setting. | N | N | N | N | |||
114 | Student | hispanic_ethnicity | String | "N" | Student's Hispanic/Latino ethnicity. Possible values: ["Y", "N", ""]. | Y | N | N | Y | N | ||
115 | Student | String | "fbueller@cleverschools.org" | Student's email address. | N | N | Y | Y | N | |||
116 | Student | credentials.district_username | String | "fbueller1234" | Student's preferred username, specified by district. | N | N | N | Y | N | ||
117 | Student | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
118 | Student | links.self | Link | /v2.0/students/4fee004cca2e43cf27000007 | Stable link to student. | Y | Y | N | Y | Y | ||
119 | Student | links.district | Link | /v2.0/students/4fee004cca2e43cf27000007/district | Gets the district for a student. | Y | Y | N | Y | N | ||
120 | Student | links.school | Link | /v2.0/students/4fee004cca2e43cf27000007/school | Gets the school for a student. | Y | Y | N | Y | N | ||
121 | Student | links.schools | Link | /v2.0/students/4fee004cca2e43cf27000007/schools | Gets all schools for a student. | Y | Y | N | Y | N | ||
122 | Student | links.sections | Link | /v2.0/students/4fee004cca2e43cf27000007/sections | Gets all sections for a student. | Y | Y | N | Y | N | ||
123 | Student | links.contacts | Link | /v2.0/students/4fee004cca2e43cf27000007/contacts | Gets all contacts for a student. | Y | Y | N | Y | N | ||
124 | Student | links.teachers | Link | /v2.0/students/4fee004cca2e43cf27000007/teachers | Gets all teachers for a student. | Y | Y | N | Y | N | ||
125 | x | x | x | x | x | x | x | x | x | x | ||
126 | Teacher | id | ObjectID | "4fee004dca2e43cf270007d6" | Globally unique and stable id for teacher created by Clever. Used in API calls (ex /v2.0/teachers/4fee004dca2e43cf270007d6). | Y | Y | Y | Y | Y | ||
127 | Teacher | school | ObjectID | "4fee004cca2e43cf27000001" | Globally unique and stable id for teacher's primary school. | Y | Y | N | Y | N | ||
128 | Teacher | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for teacher's district. | Y | Y | Y | Y | N | ||
129 | Teacher | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this teacher is associated with. | Y | Y | N | Y | N | ||
130 | Teacher | last_modified | Timestamp | "2012-06-22T05:14:57.799Z" | Last time resource was updated. Initializes to resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
131 | Teacher | sis_id | String | "455" | Internal teacher identifier from source system. Recommended for use only when matching historical data to new Clever import. | N | Y | N | Y | N | ||
132 | Teacher | String | "jescalante@cleverprep.org" | Teacher email. | N | N | Y | Y | Y | |||
133 | Teacher | name.first | String | "Jamie" | Teacher first name. | N | Y | Y | Y | Y | ||
134 | Teacher | name.middle | String | "A." | Teacher middle name or initial. | N | N | N | Y | Y | ||
135 | Teacher | name.last | String | "Escalante" | Teacher last name. | N | Y | Y | Y | Y | ||
136 | Teacher | teacher_number | String | "110011" | District or school assigned teacher identifier. | N | N | N | Y | N | ||
137 | Teacher | state_id | String | "2853840" | State teacher identifier. | N | N | N | Y | N | ||
138 | Teacher | title | String | "Math Department Chair" | Teacher's title | N | N | N | Y | N | ||
139 | Teacher | credentials.district_username | String | "jescalante@cleverprep.org" | Teacher's preferred username, specified by district. | N | N | N | Y | N | ||
140 | Teacher | created | Timestamp | "2012-06-22T05:14:57.375Z" | Resource creation date. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
141 | Teacher | links.self | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed | Stable link to teacher. | Y | Y | N | Y | Y | ||
142 | Teacher | links.district | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/district | Gets the district for a teacher. | Y | Y | N | Y | N | ||
143 | Teacher | links.sections | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/sections | Gets all of the sections for a teacher. | Y | Y | N | Y | Y | ||
144 | Teacher | links.school | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/school | Gets the school for a teacher. | Y | Y | N | Y | N | ||
145 | Teacher | links.schools | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/schools | Gets all schools for a teacher. | Y | Y | N | Y | N | ||
146 | Teacher | links.students | Link | /v2.0/teachers/4fe3ff51dfa54700000003ed/students | Gets all the students in all of a teacher's sections. | Y | Y | N | Y | N | ||
147 | x | x | x | x | x | x | x | x | x | x | ||
148 | School Admin | id | ObjectID | "519edecb58b876b01800038g" | Globally unique and stable id for student administrator created by Clever. Used in API calls (ex v2.0/school_admins/519edecb58b876b01800038g ) | Y | Y | Y | Y | N | ||
149 | School Admin | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for admin's district. | Y | Y | Y | Y | N | ||
150 | School Admin | name.first | String | "Pippi" | The school admin's first name | N | Y | Y | Y | N | ||
151 | School Admin | name.last | String | "Longstocking" | The school admin's last name | N | Y | Y | Y | N | ||
152 | School Admin | title | String | "Chief Instigator" | The school admin's job title, if specified. | N | N | N | Y | N | ||
153 | School Admin | String | "blanche.hoedel@sherman.edu" | Globally unique email address associated with the school admin. | N | Y | Y | Y | N | |||
154 | School Admin | schools | List of ObjectIDs | ["4fe3ff50dfa547000000033c", "4fe3ff50dfa547000000035d", "4fe3ff50dfa547000000023a"] | List of ids of schools this admin is associated with. | Y | Y | N | Y | N | ||
155 | School Admin | staff_id | String | "1721" | An identifier provided by the district when syncing or creating this administrator. | N | Y | N | Y | N | ||
156 | School Admin | credentials.district_username | String | "bhoedel123" | School admin's preferred username, specified by district | N | N | N | Y | N | ||
157 | School Admin | links.self | Link | /v2.0/school_admins/519edecb58b876b01800038g | Stable link to school admin. | Y | Y | N | Y | N | ||
158 | School Admin | links.district | Link | /v2.0/school_admins/519edecb58b876b01800038g/district | Gets the district for a school admin. | Y | Y | N | Y | N | ||
159 | School Admin | links.schools | Link | /v2.0/school_admins/519edecb58b876b01800038g/schools | Gets all schools for a school admin. | Y | Y | N | Y | N | ||
160 | x | x | x | x | x | x | x | x | x | x | ||
161 | District Admin | id | ObjectID | "519edecb58b876b01800038f" | Globally unique and stable id for district administrator created by Clever. Used in API calls (ex v2.0/district_admins/519edecb58b876b01800038f ) | Y | Y | Y | Y | N | ||
162 | District Admin | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for admin's district. | Y | Y | Y | Y | N | ||
163 | District Admin | name.first | String | "Blanche" | The district admin's first name, when available. | N | Y | Y | Y | N | ||
164 | District Admin | name.last | String | "Hoedel" | The district admin's last name, when available. | N | N | Y | Y | N | ||
165 | District Admin | title | String | "Assistant to Principal" | The district admin's job title, if specified. | N | N | N | Y | N | ||
166 | District Admin | String | "blanche.hoedel@sherman.edu" | Globally unique email address associated with the district admin. | N | Y | Y | Y | N | |||
167 | District Admin | links.self | Link | /v2.0/district_admins/519edecb58b876b01800038f | Stable link to district admin. | Y | Y | Y | Y | N | ||
168 | x | x | x | x | x | x | x | x | x | x | ||
169 | Contact | id | ObjectID | "4fee004dca2e43cf270009d9" | Globally unique and stable id for student contact. | Y | Y | N | Y | N | ||
170 | Contact | district | ObjectID | "4fd43cc56d11340000000005" | Globally unique and stable id for contact's district. | Y | Y | N | Y | N | ||
171 | Contact | name | String | "Katie Bueller" | Name of contact. | N | Y | N | Y | N | ||
172 | Contact | type | String | "primary" | Type of contact. Possible values: ["Primary","Secondary", "Parent/Guardian", "Emergency", "Family", "Other"]. | Y | Y | N | Y | N | ||
173 | Contact | students | List of ObjectIDs | ["4fe3ff50dfa547000000033a", "4fe3ff50dfa5470000000359", "4fe3ff50dfa5470000000234"] | Globally unique and stable ids for students associated with contact. | Y | Y | N | Y | N | ||
174 | Contact | sis_id | String | "123456" | Internal contact identifier from source system. | N | N | N | Y | N | ||
175 | Contact | String | "kbueller@gmail.com" | Contact email address. | N | N | N | Y | N | |||
176 | Contact | phone | String | "727.565.1000" | Contact phone number. | N | N | N | Y | N | ||
177 | Contact | phone_type | String | "mobile" | Type of phone number. Possible values: ["Home", "Cell", "Work", "Other"]. | Y | N | N | Y | N | ||
178 | Contact | relationship | String | "Parent" | Relationship to student. Possible values: ["Parent","Grandparent","Self", "Aunt/Uncle", "Sibling," Other"]. | Y | N | N | Y | N | ||
179 | Contact | links.self | Link | /v2.0/contacts/4fee004cca2e43cf27000007 | Stable link to list of contacts. | Y | Y | N | Y | N | ||
180 | Contact | links.district | Link | /v2.0/contacts/4fee004cca2e43cf27000007/district | Gets the district for a contact. | Y | Y | N | Y | N | ||
181 | Contact | links.students | Link | /v2.0/contacts/4fee004cca2e43cf27000007/students | Gets all the students associated with a contact. | Y | Y | N | Y | N | ||
183 | x | x | x | x | x | x | x | x | x | x | ||
184 | Event | id | ObjectID | "4ffc35672f767044120301dd" | Globally unique and stable id for event created by Clever. Used in API calls (ex /v2.0/events/4ffc35672f767044120301dd). Events may be purged after 30 days. | Y | Y | N | Y | N | ||
185 | Event | created | Timestamp | "2012-07-10T14:00:07.818Z" | Time of the event. UTC time in W3C Date Time Format: YYYY-MM-DDTHH:MM:SS.SSSZ. | Y | Y | N | Y | N | ||
186 | Event | type | String | "Students.created" | Type of event. Format is resource.modification. Possible resources are ["schools","students","terms","courses","sections","teachers", "schooladmins", "districtadmins", "contacts"]. Possible modifications are ["created","updated","deleted"]. | Y | Y | N | Y | N | ||
187 | Event | data | Varies | Student resource | Event "data" field contains the resource (e.g. school, student, section, teacher) that was created or updated. | N | Y | N | Y | N | ||
188 | Event | previous_attributes | Varies | Fields from updated resource. | For events of the "updated" type, the previous_attributes field shows the prior value of the field or fields that have changed. | N | N | N | Y | N | ||
189 | Event | links.self | Link | /v2.0/events/4ffc35672f767044120301dd | Stable link to event. Events will be purged after 30 days. | Y | Y | N | Y | N | ||
190 | Data availability is subject to the decision of schools or districts to share their data. | |||||||||||