Skip to content

Instantly share code, notes, and snippets.

@jmealo

jmealo/output.json

Last active September 30, 2015 15:07
Show Gist options
  • Save jmealo/11e6b8a077b330eb5f9d to your computer and use it in GitHub Desktop.
Save jmealo/11e6b8a077b330eb5f9d to your computer and use it in GitHub Desktop.
Download ZIP
Illuminate API Documentation Scraper
Raw
output.json
{
"endPoints": {
"Sites": {
"description": "Returns a list of District and School sites.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Sites/"
],
"responseExample": [
{
"site_id": 1,
"site_name": "XYZ Unified School District",
"state_school_id": 12340100000000,
"start_grade_level_id": 1,
"end_grade_level_id": 7,
"site_type_name": "Elementary",
"address": "123 ABC Street",
"address2": null,
"city": "Acme City",
"state": "CA",
"zip": 90000,
"local_site_code": null,
"num_hours": null,
"num_weeks": null,
"parent_site_id": 1
},
{
"site_id": 2,
"site_name": "XYZ Elementary",
"state_school_id": 1234025612300,
"start_grade_level_id": 1,
"end_grade_level_id": 7,
"site_type_name": "High Schools",
"address": "123 Acme Street",
"address2": null,
"city": "Acme City",
"state": "CA",
"zip": 90000,
"local_site_code": null,
"num_hours": null,
"num_weeks": null,
"parent_site_id": 1
}
],
"responseDescription": "A list or array of multiple Sites.",
"responseProperties": {},
"requestParameters": {},
"returnsArray": true
},
"GradeLevels": {
"description": "Returns a list of Grade Levels and their IDs.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradeLevels/"
],
"responseExample": [
{
"grade_level_id": 1,
"short_name": "K",
"long_name": "Kindergarten",
"standard_age": 5,
"state_id": "KN",
"sort_order": 2
},
{
"grade_level_id": 2,
"short_name": 1,
"long_name": "1st Grade",
"standard_age": 6,
"state_id": 1,
"sort_order": 3
}
],
"responseDescription": "A list or array of multiple Grade Levels.",
"responseProperties": {},
"requestParameters": {},
"returnsArray": true
},
"Students": {
"description": "Returns a paginated list of Students.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Students/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 101,
"results": [
{
"student_id": 1234,
"district_student_id": 123456,
"state_student_id": 123456789,
"last_name": "Doe",
"first_name": "John",
"middle_name": "A",
"birth_date": "2005-05-11",
"gender": "M",
"ethnicity_1": "White",
"ethnicity_2": null,
"ethnicity_3": null,
"is_hispanic": "f",
"primary_language": "ENGLISH",
"correspondence_language": "ENGLISH",
"language_fluency": "English Only",
"reclassification_date": null,
"primary_disability": null,
"us_entry_date": "2010-08-16",
"school_entry_date": "2010-08-16",
"district_entry_date": "2010-08-16",
"parent_education_level": "Graduate School/Post Graduate",
"birth_city": "Acme City",
"birth_state": "CA",
"birth_country": "United States Of America",
"academic_year": 2012,
"local_lunch_id": "12345"
},
{
"student_id": 5678,
"district_student_id": 56789,
"state_student_id": 987654321,
"last_name": "Doe",
"first_name": "Jane",
"middle_name": "B",
"birth_date": "2005-11-17",
"gender": "F",
"ethnicity_1": "White",
"ethnicity_2": null,
"ethnicity_3": null,
"is_hispanic": "f",
"primary_language": "ENGLISH",
"correspondence_language": "ENGLISH",
"language_fluency": "English Only",
"reclassification_date": null,
"primary_disibility": null,
"us_entry_date": null,
"school_entry_date": "2011-08-15",
"district_entry_date": "2011-08-15",
"parent_education_level": "Some College",
"birth_city": "Acme City",
"birth_state": "CA",
"birth_country": "United States Of America",
"academic_year": 2012,
"local_lunch_id": "67890"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"district_student_id": {
"description": "Filter results using the District ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"StudentParents": {
"description": "Returns a paginated list of Students and their Parent information.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/StudentParents/"
],
"responseExample": {
"page": 1,
"num_pages": 10,
"num_results": 500,
"results": [
{
"site_id": "101010",
"local_student_id": "123456",
"contact_id": "654321",
"last_name": "DOE",
"first_name": "JOHN",
"middle_name": "",
"name_prefix": "",
"language_id": "00",
"address": "123 Acme St",
"address_2": "Unit A1",
"city": "Acme City",
"state": "CA",
"zip": "90000",
"email_address": "user@hostname.com",
"home_phone_1": "2135551212",
"home_phone_2": null,
"work_phone_1": "3105551212",
"work_phone_2": null,
"mobile_phone_1": null,
"mobile_phone_2": null
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
}
},
"returnsArray": false
},
"StudentContacts": {
"description": "Returns a paginated list of Students and their Contact information.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/StudentContacts/"
],
"responseExample": {
"page": 1,
"num_pages": 10,
"num_results": 500,
"results": [
{
"student_id": "101010",
"district_student_id": "654321",
"site_id": "11000",
"correspondence_language_code": "EN",
"contact_id": "98765",
"contact_first_name": "JOHN",
"contact_middle_name": "",
"contact_last_name": "DOE",
"contact_name_prefix": "",
"contact_name_suffix": "",
"address": "123 Acme St",
"address_2": "Unit A1",
"city": "Acme City",
"state": "CA",
"zip": "90000",
"email_address": "user@hostname.com",
"home_phone_1": "2135551212",
"home_phone_2": null,
"work_phone_1": "3105551212",
"work_phone_2": null,
"mobile_phone_1": null,
"mobile_phone_2": null,
"resides_with": "t",
"legal_guardian": "f",
"emergency_contact": "t"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"site_id": {
"description": "Filter results by Site ID.",
"required": false,
"format": null
},
"legal_guardian": {
"description": "Filter results by legal guardian Contacts (boolean).",
"required": false,
"format": null
},
"emergency_contact": {
"description": "Filter results by emergency Contacts (boolean).",
"required": false,
"format": null
},
"resides_with": {
"description": "Filter results by Contacts that the Student resides with (boolean).",
"required": false,
"format": null
}
},
"returnsArray": false
},
"StudentCounselors": {
"description": "Returns a paginated list of Students and their Counselors.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/StudentCounselors/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 101,
"results": [
{
"student_id": 1234,
"district_student_id": 123456,
"state_student_id": 123456789,
"last_name": "Smith",
"first_name": "Susan",
"middle_name": "A",
"counselor_id": 789,
"district_counselor_id": "789123",
"start_date": "2013-09-05",
"end_date": null
},
{
"student_id": 5678,
"district_student_id": 56789,
"state_student_id": 987654321,
"last_name": "Smith",
"first_name": "Susan",
"middle_name": "B",
"counselor_id": 789,
"district_counselor_id": "789123",
"start_date": "2013-09-05",
"end_date": null
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"district_student_id": {
"description": "Filter results using the District ID for a Student.",
"required": false,
"format": null
},
"counselor_id": {
"description": "Filter results using the internal System ID for a Counselor.",
"required": false,
"format": null
},
"district_counselor_id": {
"description": "Filter results using the District ID for a Counselor.",
"required": false,
"format": null
},
"date": {
"description": "Filter student set for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter student set for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter student set for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"Users": {
"description": "Returns a paginated list of Users.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Users/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"user_id": 12345,
"district_user_id": null,
"last_name": "Doe",
"first_name": "John",
"middle_name": "A",
"birth_date": "1950-03-09",
"gender": "M",
"email1": "jadoe@district.k12.ca.us",
"username": "jadoe",
"state_user_id": 123456,
"suffix": null,
"name_former_last": null,
"name_former_first": null,
"name_former_middle": null,
"primary_ethnicity": "White",
"is_hispanic": "f",
"address": null,
"city": null,
"state": null,
"zip": null,
"job_title": "Teacher",
"staff_education_level": "Baccalaureate Plus 30",
"hire_date": "2002-01-23",
"exit_date": null,
"active": "t"
},
{
"user_id": 6789,
"district_user_id": null,
"last_name": "Doe",
"first_name": "Jane",
"middle_name": "B",
"birth_date": "1967-09-16",
"gender": "F",
"email1": "jbdoe@district.k12.ca.us",
"username": "jbdoe",
"state_user_id": 67890,
"suffix": null,
"name_former_last": null,
"name_former_first": null,
"name_former_middle": null,
"primary_ethnicity": "White",
"is_hispanic": "f",
"address": null,
"city": null,
"state": null,
"zip": null,
"job_title": "Teacher",
"staff_education_level": "Baccalaureate Plus 30",
"hire_date": "2009-08-13",
"exit_date": null,
"active": "t"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Limit to a single user using the internal System ID for a User.",
"required": false,
"format": null
},
"district_user_id": {
"description": "Limit to a single user using the District's User ID.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"UserRoles": {
"description": "Returns a paginated list of User Roles.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/UserRoles/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"user_id": 12345,
"district_user_id": "321",
"site_id": "567",
"academic_year": "2014",
"term_id": "1",
"role_id": "2",
"role_name": "Teacher"
},
{
"user_id": 12345,
"district_user_id": "321",
"site_id": "567",
"academic_year": "2014",
"term_id": "2",
"role_id": "2",
"role_name": "Teacher"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Limit to a single user using the internal System ID for a User.",
"required": false,
"format": null
},
"district_user_id": {
"description": "Limit to a single user using the District's User ID.",
"required": false,
"format": null
},
"academic_year": {
"description": "Limit to a single Academic Year. (2013-2014 = 2014).",
"required": false,
"format": null
},
"site_id": {
"description": "Limit to a single Site ID.",
"required": false,
"format": null
},
"term_id": {
"description": "Limit to a single Term ID.",
"required": false,
"format": null
},
"role_id": {
"description": "Limit to a single Role ID.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"SchoolFocusUserPermissions": {
"description": "Returns a paginated list of SchoolFocus User Permissions.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/SchoolFocusPermissions/"
],
"responseExample": {
"module": true,
"create": true,
"view": true,
"update": true,
"delete": false,
"erase": false,
"no_photo": false,
"no_video": false,
"review": false,
"download": false,
"search": true
},
"responseDescription": "A list or array of permissions",
"responseProperties": {
"results": "A list or array of permissions"
},
"requestParameters": {
"user_id": {
"description": "Internal System ID for a User",
"required": true,
"format": null
}
},
"returnsArray": true
},
"SchoolFocusUserSites": {
"description": "Return a list of sites associated with the user.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/SchoolFocusSites"
],
"responseExample": {
"17": "Another Elementary School",
"25": "Sample High School",
"32": "Sample Elementary School"
},
"responseDescription": "A list of school sites.",
"responseProperties": {
"results": "A list of school sites."
},
"requestParameters": {
"user_id": {
"description": "Internal System ID for a User",
"required": true,
"format": null
}
},
"returnsArray": true
},
"Terms": {
"description": "Returns a paginated list of Terms.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Terms/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"term_id": 259,
"site_id": 6,
"term_name": "Yearlong",
"term_num": 1,
"start_date": "2011-08-15",
"end_date": "2012-06-15",
"term_type": "Full Year",
"session_type_id": 1,
"session_type": "Normal",
"academic_year": 2012,
"district_term_id": null
},
{
"term_id": 260,
"site_id": 7,
"term_name": "Yearlong",
"term_num": 1,
"start_date": "2011-08-15",
"end_date": "2012-06-15",
"term_type": "Full Year",
"session_type_id": 1,
"session_type": "Normal",
"academic_year": 2012,
"district_term_id": null
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'. Defaults to the session start date if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'. Defaults to the session end date if not provided.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"Courses": {
"description": "Returns a paginated list of Courses.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Courses/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"course_id": 109,
"school_course_id": 2623,
"long_name": "CORE",
"short_name": "CORE",
"department_name": null,
"start_grade_level_id": 1,
"end_grade_level_id": 7,
"site_ids": "10, 11, 3, 4, 5, 6, 7, 8, 9",
"is_active": "t",
"weight": null,
"description": null,
"credits": null,
"has_variable_credits": "f",
"max_credits": null,
"is_specialed": "f",
"max_capacity": 30,
"is_intervention": "f",
"nclb_instructional_level": "Elementary NCLB Core Academic Course",
"course_content": null,
"educational_service": null,
"instructional_strategy": null,
"program_funding_source": null,
"cte_funding_provider": null,
"tech_prep": "f"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"Enrollment": {
"description": "Returns a paginated list of Enrollment records.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Enrollment/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"student_id": 1234,
"district_student_id": 123456,
"state_student_id": 123456789,
"last_name": "Doe",
"first_name": "John",
"middle_name": "A",
"birth_date": "2005-05-11",
"site_id": 4,
"entry_date": "2011-08-15",
"leave_date": "2012-06-15",
"grade_level_id": 2,
"academic_year": 2012,
"is_primary_ada": "t",
"attendance_category": "Regular Attendance Program",
"enrollment_exit_reason": null,
"session_type_id": 1
},
{
"student_id": 5678,
"district_student_id": 56789,
"state_student_id": 987654321,
"last_name": "Doe",
"first_name": "Jane",
"middle_name": "B",
"birth_date": "2005-11-17",
"site_id": 4,
"entry_date": "2011-08-15",
"leave_date": "2012-06-15",
"grade_level_id": 2,
"academic_year": 2012,
"is_primary_ada": "t",
"attendance_category": "Regular Attendance Program",
"enrollment_exit_reason": null,
"session_type_id": 1
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"MasterSchedule": {
"description": "Returns a paginated list of Sections.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/MasterSchedule/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"section_id": 1695,
"district_section_id": null,
"site_id": 3,
"term_id": 256,
"term_name": "Yearlong",
"course_id": 109,
"user_id": 416788,
"period": "All Day",
"academic_year": 2012,
"room_number": 204,
"session_type_id": 1,
"district_term_id": null,
"quarter_num": null,
"user_start_date": "2011-09-15",
"user_end_date": "2012-06-15",
"primary_teacher": "t",
"hqtcc": "N"
},
{
"section_id": 1696,
"district_section_id": null,
"site_id": 3,
"term_id": 256,
"term_name": "Yearlong",
"course_id": 109,
"user_id": 460992,
"period": "All Day",
"academic_year": 2012,
"room_number": 209,
"session_type_id": 1,
"district_term_id": null,
"quarter_num": null,
"user_start_date": "2011-09-15",
"user_end_date": "2012-06-15",
"primary_teacher": "t",
"hqtcc": "N"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"Roster": {
"description": "Returns a paginated list of Roster records.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Roster/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"student_id": 1234,
"district_student_id": 123456,
"state_student_id": 123456789,
"last_name": "Doe",
"first_name": "John",
"middle_name": "A",
"birth_date": "2005-05-11",
"section_id": 1843,
"site_id": 4,
"course_id": 109,
"user_id": 441389,
"entry_date": "2011-08-15",
"leave_date": "2012-06-15",
"grade_level_id": 2,
"academic_year": 2012,
"session_type_id": 1
},
{
"student_id": 5678,
"district_student_id": 56789,
"state_student_id": 987654321,
"last_name": "Doe",
"first_name": "Jane",
"middle_name": "B",
"birth_date": "2005-11-17",
"section_id": 1844,
"site_id": 4,
"course_id": 109,
"user_id": 116945,
"entry_date": "2011-08-15",
"leave_date": "2012-06-15",
"grade_level_id": 2,
"academic_year": 2012,
"session_type_id": 1
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"district_student_id": {
"description": "Filter results using the District ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"Assessments": {
"description": "Returns a paginated list of Assessments records.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Assessments/"
],
"responseExample": {
"page": 1,
"num_pages": 27,
"num_results": "785",
"results": [
{
"assessment_id": 1014,
"local_assessment_id": "1234",
"title": "Testing 1",
"description": "A long description of the assessment.",
"author_id": 12345,
"district_author_id": "123456",
"author_first": "User",
"author_last": "Illuminate",
"scope_id": 1,
"scope": "District Benchmark",
"subject_id": 1,
"subject": "English Language Arts",
"grade_levels": "9, 10, 11, 12",
"created_at": "2011-09-19 15:27:37",
"updated_at": "2011-09-19 15:27:38"
},
{
"assessment_id": "999",
"local_assessment_id": "1235",
"title": "Testing 2",
"description": "A long description of the assessment.",
"author_id": 12345,
"district_author_id": "123456",
"author_first": "User",
"author_last": "Illuminate",
"scope_id": 1,
"scope": "District Benchmark",
"subject_id": 2,
"subject": "Mathematics",
"grade_levels": "11, 12",
"created_at": "2011-09-04 19:15:06",
"updated_at": "2011-09-04 19:15:06"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"assessment_id": {
"description": "The internal system Assessment ID.",
"required": false,
"format": null
},
"local_assessment_id": {
"description": "The external District Assessment ID.",
"required": false,
"format": null
},
"author_id": {
"description": "The author's internal system User ID.",
"required": false,
"format": null
},
"district_author_id": {
"description": "The author's external District User ID.",
"required": false,
"format": null
},
"subject_id": {
"description": "The internal System Subject ID.",
"required": false,
"format": null
},
"scope_id": {
"description": "The internal System Scope ID.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"AssessmentScores": {
"description": "Submit student scores to an assessment.",
"method": "POST",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Assessment/{assessment_id}/Scores/"
],
"responseExample": {
"scores_added": 2
},
"responseDescription": "number of student scores saved.",
"responseProperties": {
"scores_added": "number of student scores saved."
},
"requestParameters": {},
"returnsArray": false,
"requestExample": [
{
"local_student_id": 12345,
"responses": [
"A",
"B",
"C",
"C",
"3"
]
},
{
"local_student_id": 12346,
"version": 2,
"responses": [
"C",
"C",
"B",
"A",
"0"
]
},
{
"local_student_id": 12346,
"version": 1,
"responses": [
"A",
"B",
"C",
"C",
""
],
"text_responses": [
"",
"",
"",
"",
"apel"
]
},
{
"local_student_id": 12346,
"responses": [
"A",
"B",
"C",
"C",
"3"
],
"text_responses": [
"",
"",
"",
"",
"Apple"
]
}
]
},
"AssessmentAggregateStudentResponses": {
"description": "Returns a paginated list of aggregated student scores for an assessment.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/AssessmentAggregateStudentResponses/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"assessment_id": "1234",
"title": "Best Assessment Ever",
"local_student_id": "12345",
"first_name": "John",
"last_name": "Doe",
"middle_name": "Moe",
"version": "1",
"version_label": "Version 1",
"date_taken": "2013-09-11",
"points": "5",
"points_possible": "10",
"percent_correct": "50.00",
"performance_band_level": "1",
"performance_band_label": "Far Below Basic",
"mastered": "f"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"assessment_id": {
"description": "Filter results using the internal System ID for an Assessment.",
"required": false,
"format": null
},
"date_taken_start": {
"description": "Filter results using the students date taken for an Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"date_taken_end": {
"description": "Filter results using the students date taken for an Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"modified_after": {
"description": "Filter results to return only records inserted or modified on or after the date provided.",
"required": false,
"format": null
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"AssessmentAggregateStudentResponsesGroup": {
"description": "Returns a paginated list of aggregated student scores for an assessment by question group.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/AssessmentAggregateStudentResponsesGroup/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"assessment_id": "1234",
"title": "Best Assessment Ever",
"reporting_group": "Reading Comprehension",
"local_student_id": "12345",
"first_name": "John",
"last_name": "Doe",
"middle_name": "Moe",
"date_taken": "2013-09-11",
"points": "5",
"points_possible": "10",
"percent_correct": "50.00",
"performance_band_level": "1",
"performance_band_label": "Far Below Basic",
"mastered": "f"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"assessment_id": {
"description": "Filter results using the internal System ID for an Assessment.",
"required": false,
"format": null
},
"date_taken_start": {
"description": "Filter results using the students date taken for an Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"date_taken_end": {
"description": "Filter results using the students date taken for an Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"modified_after": {
"description": "Filter results to return only records inserted or modified on or after the date provided.",
"required": false,
"format": null
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"AssessmentAggregateStudentResponsesStandard": {
"description": "Returns a paginated list of aggregated student scores for an assessment by standard.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/AssessmentAggregateStudentResponsesStandard/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"assessment_id": "1234",
"title": "Best Assessment Ever",
"academic_benchmark_guid": "FC4E368A-E636-11DA-ABAF-F681ADECFD11",
"standard_code": "GLAHSCE.MA.4.N.ME.04.01",
"standard_description": "Read and write numbers to 1,000,000",
"local_student_id": "12345",
"first_name": "John",
"last_name": "Doe",
"middle_name": "Moe",
"date_taken": "2013-09-11",
"points": "5",
"points_possible": "10",
"percent_correct": "50.00",
"performance_band_level": "1",
"performance_band_label": "Far Below Basic",
"mastered": "f"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"assessment_id": {
"description": "Filter results using the internal System ID for an Assessment.",
"required": false,
"format": null
},
"date_taken_start": {
"description": "Filter results using the students date taken for an Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"date_taken_end": {
"description": "Filter results using the students date taken for an Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"modified_after": {
"description": "Filter results to return only records inserted or modified on or after the date provided.",
"required": false,
"format": null
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"PoolAssessmentAggregateStudentResponses": {
"description": "Returns a paginated list of aggregated student scores for a pool assessment.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/PoolAssessmentAggregateStudentResponses/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"pool_assessment_id": "1234",
"title": "My Pool Assessment",
"local_student_id": "12345",
"first_name": "John",
"last_name": "Doe",
"middle_name": "Moe",
"date_taken": "2013-09-11",
"points": "5",
"points_possible": "10",
"percent_correct": "50.00",
"performance_band_level": "1",
"performance_band_label": "Far Below Basic",
"mastered": "f",
"start_time": "2013-09-07 04:47:33+08",
"end_time": "2013-09-07 05:01:59+08",
"minutes_elapsed": "14",
"student_pauses": "0"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"pool_assessment_id": {
"description": "Filter results using the internal System ID for a Pool Assessment.",
"required": false,
"format": null
},
"date_taken_start": {
"description": "Filter results using the students date taken for a Pool Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"date_taken_end": {
"description": "Filter results using the students date taken for a Pool Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"PoolAssessmentAggregateStudentResponsesStandard": {
"description": "Returns a paginated list of aggregated student scores for a pool assessment by standard.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/PoolAssessmentAggregateStudentResponsesStandard/"
],
"responseExample": {
"page": 2,
"num_pages": 51,
"num_results": 1001,
"results": [
{
"pool_assessment_id": "1234",
"title": "My Pool Assessment",
"academic_benchmark_guid": "FC4E368A-E636-11DA-ABAF-F681ADECFD11",
"standard_code": "GLAHSCE.MA.4.N.ME.04.01",
"standard_description": "Read and write numbers to 1,000,000",
"local_student_id": "12345",
"first_name": "John",
"last_name": "Doe",
"middle_name": "Moe",
"date_taken": "2013-09-11",
"points": "5",
"points_possible": "10",
"percent_correct": "50.00",
"performance_band_level": "1",
"performance_band_label": "Far Below Basic",
"mastered": "f"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"pool_assessment_id": {
"description": "Filter results using the internal System ID for a Pool Assessment.",
"required": false,
"format": null
},
"date_taken_start": {
"description": "Filter results using the students date taken for a Pool Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"date_taken_end": {
"description": "Filter results using the students date taken for a Pool Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null,
"value": 12345,
"type": "number"
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"AssessmentView": {
"description": "View the information in an assessment.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Assessment/{assessment_id}/View/"
],
"responseExample": {
"exported_at": "2013-05-21 20:27:06",
"version": 4,
"performance_band_sets": [
{
"performance_band_set_id": "1",
"description": "Imported District Default",
"performance_bands": [
{
"minimum_value": "90",
"label": "Advanced",
"label_number": "5",
"color": "00CA3F",
"is_mastery": true
},
{
"minimum_value": "80",
"label": "Proficient",
"label_number": "4",
"color": "91FD57",
"is_mastery": true
},
{
"minimum_value": "70",
"label": "Basic",
"label_number": "3",
"color": "FEFE56",
"is_mastery": false
},
{
"minimum_value": "60",
"label": "Below Basic",
"label_number": "2",
"color": "FFBF42",
"is_mastery": false
},
{
"minimum_value": "0",
"label": "Far Below Basic",
"label_number": "1",
"color": "FF001A",
"is_mastery": false
}
]
}
],
"assessment": {
"title": "Scores Assessment",
"description": "",
"created_at": "2013-05-21 16:05:48",
"updated_at": "2013-05-21 16:05:49",
"administered_at": "2013-05-21",
"academic_year": "2013",
"guid": "ac34b604-f5ec-4614-91d2-ed08107149c8",
"tags": "Mathematics",
"performance_band_set_id": "1",
"subject_area": "Mathematics",
"scope": null,
"grade_levels": [],
"standards": [
{
"guid": "9C69F630-29E8-11D8-9E1D-C9142A604C5A",
"performance_band_set_id": "1"
}
],
"groups": [
{
"sort_order": null,
"performance_band_set_id": "1",
"label": "Number Sense"
}
],
"versions": [
{
"number": "1",
"label": "Version 1",
"created_at": "2013-05-21 16:05:48",
"updated_at": "2013-05-21 16:05:48"
},
{
"number": "2",
"label": "Version 2",
"created_at": "2013-05-21 16:16:47",
"updated_at": "2013-05-21 16:16:47"
}
],
"fields": [
{
"order": "0",
"maximum": "1",
"created_at": "2013-05-21 16:05:49",
"updated_at": "2013-05-21 16:16:53",
"body": null,
"sort_order": "{0,1}",
"is_rubric": false,
"sheet_label": "1",
"sheet_responses": "{A,B,C,D,E}",
"responses": [
{
"points": "1",
"choice": null,
"rationale": null,
"version_number": "1",
"response": "A"
},
{
"points": "1",
"choice": null,
"rationale": null,
"version_number": "2",
"response": "A"
}
],
"standards": [
"9C69F630-29E8-11D8-9E1D-C9142A604C5A"
],
"groups": [
"Number Sense"
]
},
{
"order": "1",
"maximum": "3",
"created_at": "2013-05-21 16:05:49",
"updated_at": "2013-05-21 16:16:53",
"body": null,
"sort_order": "{1,0}",
"is_rubric": true,
"sheet_label": "2",
"sheet_responses": "{1,2,3,\"\",\"\"}",
"responses": [
{
"points": "1",
"choice": null,
"rationale": null,
"version_number": "1",
"response": "1"
},
{
"points": "1",
"choice": null,
"rationale": null,
"version_number": "2",
"response": "1"
},
{
"points": "2",
"choice": null,
"rationale": null,
"version_number": "1",
"response": "2"
},
{
"points": "2",
"choice": null,
"rationale": null,
"version_number": "2",
"response": "2"
},
{
"points": "3",
"choice": null,
"rationale": null,
"version_number": "1",
"response": "3"
},
{
"points": "3",
"choice": null,
"rationale": null,
"version_number": "2",
"response": "3"
}
],
"standards": [
"9C69F630-29E8-11D8-9E1D-C9142A604C5A"
],
"groups": [
"Number Sense"
]
}
]
}
},
"responseDescription": "Date of assessment export.",
"responseProperties": {
"exported_at": "Date of assessment export.",
"version": "This is the version number of the assessment JSON format.",
"num_results": "The total number of records available for the requested parameters.",
"performance_band_sets": "A list or array of performance band sets used by the assessment.",
"assessment": "The assessment structure."
},
"requestParameters": {},
"returnsArray": false
},
"RepositoryData": {
"description": "Submit data to a summary assessment or demographic, AKA repository.",
"method": "POST",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Repository/{repository_id}/Data/"
],
"responseExample": {
"success": true
},
"responseDescription": "string success.",
"responseProperties": {
"success": "string success."
},
"requestParameters": {},
"returnsArray": false,
"requestExample": [
{
"student_id": 12345,
"field_some_assessment_score": "3.5",
"field_comments": "Student needs to work on this."
},
{
"student_id": 12346,
"field_some_assessment_score": "2",
"field_comments": "I love this student."
}
]
},
"Attendance_Daily": {
"description": "Retrieve attendance daily records for a particular date.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Attendance/Daily/"
],
"responseExample": {
"page": 1,
"num_pages": 340,
"num_results": "10177",
"results": [
{
"district_student_id": "1121",
"illuminate_student_id": "1234567",
"flag_code": "Abs",
"flag_title": "Absent",
"site_id": "1022",
"date": "2012-05-05",
"last_name": "Smith",
"first_name": "Johnny",
"middle_name": "F",
"birth_date": "2000-12-31",
"gender": "M",
"contact_first_name": "John",
"contact_middle_name": "J",
"contact_last_name": "Smith",
"contact_name_suffix": "Mr.",
"contact_email_address": "jsmith@example.com",
"contact_name_prefix": "Sr.",
"contact_gender": "M",
"contact_birth_date": "1970-07-30",
"email_opt_out": "f",
"contact_type_code": "F",
"contact_type": "FATHER",
"correspondence_language_code": "EN",
"correspondence_language": "English",
"marital_status_code": "M",
"marital_status": "Married",
"address": "123 Main St.",
"address_2": "",
"city": "Cityland",
"zip": "12345",
"state": "CA",
"household_name": "",
"local_dwelling_block_id": "",
"dwelling_block_name": "",
"contact_phone": "9495551234",
"contact_phone_type_code": "C",
"contact_phone_type": "Cellular"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "The date you would like to retrieve the daily records for.",
"required": true,
"format": "YYYY-MM-DD"
},
"flag_code": {
"description": "The attendance flag display code that you would like to filter the daily records by.",
"required": false,
"format": null
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"Attendance_Section": {
"description": "Retrieve attendance section records for a particular date.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Attendance/Section/"
],
"responseExample": {
"page": 1,
"num_pages": 340,
"num_results": "10177",
"results": [
{
"district_student_id": "1121",
"illuminate_student_id": "1234567",
"flag_code": "Abs",
"flag_title": "Absent",
"site_id": "1022",
"date": "2012-05-05",
"last_name": "Smith",
"first_name": "Johnny",
"middle_name": "F",
"birth_date": "2000-12-31",
"gender": "M",
"section_id": "213",
"course_id": "4365",
"course_short_name": "Math 5",
"timeblocks": "3",
"teacher_first_name": "Jasmine",
"teacher_last_name": "Escalante",
"contact_first_name": "John",
"contact_middle_name": "J",
"contact_last_name": "Smith",
"contact_name_suffix": "Mr.",
"contact_email_address": "jsmith@example.com",
"contact_name_prefix": "Sr.",
"contact_gender": "M",
"contact_birth_date": "1970-07-30",
"email_opt_out": "f",
"contact_type_code": "F",
"contact_type": "FATHER",
"correspondence_language_code": "EN",
"correspondence_language": "English",
"marital_status_code": "M",
"marital_status": "Married",
"address": "123 Main St.",
"address_2": "",
"city": "Cityland",
"zip": "12345",
"state": "CA",
"household_name": "",
"local_dwelling_block_id": "",
"dwelling_block_name": "",
"contact_phone": "9495551234",
"contact_phone_type_code": "C",
"contact_phone_type": "Cellular"
}
]
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "The date you would like to retrieve the section records for.",
"required": true,
"format": "YYYY-MM-DD"
},
"site_id": {
"description": "Filter results using the internal System ID for a Site.",
"required": true,
"format": null
},
"flag_code": {
"description": "The attendance flag display code that you would like to filter the section records by.",
"required": false,
"format": null
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"Attendance_Flags": {
"description": "Retrieve list of attendance flags",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/Attendance/Flags/"
],
"responseExample": [
{
"flag_code": "+",
"flag_title": "Present",
"char_code": "+",
"precedence": 1,
"is_present": true,
"is_excused": false,
"is_reconciled": true,
"is_tardy": false,
"is_extreme": false,
"is_truancy": false,
"is_suspension": false,
"is_verified": false
}
],
"responseDescription": "The attendance flag display code.",
"responseProperties": {
"flag_code": "The attendance flag display code.",
"flag_title": "The attendance flag display title.",
"char_code": "The attendance flag character code.",
"precedence": "The attendance flag precedence. The flag with the lowest precedence value is used for the student's daily record.",
"is_present": "Whether the flag is considered present.",
"is_excused": "Whether the flag is considered excused. This field is N/A when is_present=TRUE.",
"is_reconciled": "Whether the flag is considered reconciled. This field N/A when is_present=TRUE.",
"is_tardy": "Whether the flag is considered tardy.",
"is_extreme": "Whether the flag is considered extreme (e.g. extreme tardy).",
"is_truancy": "Whether the flag is considered a truancy.",
"is_suspension": "Whether the flag is considered a suspension.",
"is_verified": "Whether the flag is considered verified. This flag is only applicable when is_present=TRUE."
},
"requestParameters": {},
"returnsArray": false
},
"CourseRequirementChecks": {
"description": "Retrieve status of course requirement checks (both graduation and UC checks) for all students",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/CourseRequirementChecks/"
],
"responseExample": [
{
"local_student_id": "123456",
"site_id": "2",
"requirement_check_type": "Graduation",
"requirement_category_short_name": "MATH",
"requirement_category_full_name": "Mathematics",
"requirement_category_is_non_credit": false,
"requirement_category_credits_required": 40,
"requirement_category_is_satisfied": false,
"requirement_category_credits_received": 20,
"requirement_category_credits_in_progress": 5,
"requirement_category_credits_scheduled": 5
}
],
"responseDescription": "The student's district student ID",
"responseProperties": {
"local_student_id": "The student's district student ID",
"site_id": "The site ID for the site where the student is enrolled",
"requirement_check_type": "The type of requirement check (Graduation or UC)",
"requirement_category_short_name": "The shortened name of the requirement category",
"requirement_category_full_name": "The long-form name of the requirement category",
"requirement_category_is_non_credit": "Indicates whether the requirement check category only looks at pass/fail status (as opposed to number of credits received)",
"requirement_category_credits_required": "The number of credits required to satisfy the category",
"requirement_category_is_satisfied": "Indicates whether the category has been satisfied by the student",
"requirement_category_credits_received": "The number of credits the student has completed toward the category",
"requirement_category_credits_in_progress": "The number of credits the student is currently taking toward fulfillment of the category",
"requirement_category_credits_scheduled": "The number of credits the student has scheduled in the future toward fulfillment of the category"
},
"requestParameters": {
"site_id": {
"description": "Limit results to students enrolled at a particular site. If this argument is not present, all district students will be returned. Selecting all district students may result in slow response times.",
"required": true,
"format": null
},
"as_of_date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": true,
"format": "YYYY-MM-DD"
}
},
"returnsArray": false
},
"CreateUserApiKeys": {
"description": "Create a set of User API Keys for another user. This is useful for vendors with administrator rights to make requests on behalf of different users. (I.E. Return a list of Assessments that a particular user has permission to.)",
"method": "POST",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/CreateUserApiKeys/"
],
"responseExample": {
"user_id": 1234,
"user_api_key": "421B33B6E85C",
"user_api_secret": "2ada48db1c211392399c57a718c7b29e75e1c588"
},
"responseDescription": "The internal System ID for this User.",
"responseProperties": {
"user_id": "The internal System ID for this User.",
"user_api_key": "The Api User Public Key.",
"user_api_secret": "The Api User Secret Key."
},
"requestParameters": {
"username": {
"description": "The username for the user that you would like to create or return api keys for.",
"required": true,
"format": null
},
"password": {
"description": "The password for the user that you would like to create or return api keys for.",
"required": true,
"format": null
}
},
"returnsArray": false
},
"GradebookScores": {
"description": "Retrieve GradeBook scores for all students",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradebookScores/"
],
"responseExample": {
"page": 1,
"num_pages": 519,
"num_results": 1038,
"results": {
"local_student_id": "546559",
"gradebook_name": "Per. 5 8th grade Science",
"assignment_name": "Tutorials",
"category_name": "HW and ASSIGNMENTS",
"is_excused": "f",
"is_missing": "f",
"points": "10",
"score": "10",
"percentage": "100",
"use_for_calc": "t",
"use_for_aggregate": "t",
"use_category_weights": "t",
"last_updated": "2013-06-06 02:38:06",
"calculated_at": "2013-06-06 02:38:06",
"mark": "A",
"entry": "z"
}
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"GradebookOverallScores": {
"description": "Retrieve overall GradeBook scores for all students",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradebookOverallScores/"
],
"responseExample": {
"page": 1,
"num_pages": 519,
"num_results": 1038,
"results": {
"local_student_id": "546558",
"gradebook_name": "TAs period 6",
"possible_points": "10",
"points_earned": "10",
"percentage": "100",
"mark": "P",
"color": "null",
"missing_count": "0",
"assignment_count": "1",
"zero_count": "0",
"excused_count": "0",
"time_frame_start_date": "2013-01-08",
"time_frame_end_date": "2013-02-22",
"calculated_at": "2013-02-27 11:25:29"
}
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"GradebookCategoryScores": {
"description": "Retrieve GradeBook scores per category for all students",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradebookCategoryScores"
],
"responseExample": {
"page": 1,
"num_pages": 519,
"num_results": 1038,
"results": {
"local_student_id": "546558",
"gradebook_name": "TAs period 6",
"possible_points": "10",
"points_earned": "10",
"percentage": "100",
"category_name": "Homework",
"weight": "30",
"mark": "P",
"mark_color": "null",
"missing_count": "0",
"assignment_count": "1",
"zero_count": "0",
"excused_count": "0",
"calculated_at": "2013-02-27 11:25:29",
"time_frame_start_date": "2013-01-08",
"time_frame_end_date": "2013-02-22"
}
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"GradebookStandardsScores": {
"description": "Retrieve GradeBook scores per standard for all students",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradebookStandardsScores"
],
"responseExample": {
"page": 1,
"num_pages": 519,
"num_results": 1038,
"results": {
"local_student_id": "4819",
"gradebook_name": "Biology P1 OGAS",
"standard": "SCI.9-12.BI.1.c",
"percentage": "60",
"mark": "D",
"points_earned": "30",
"possible_points": "50",
"color": "#dcdcdc",
"missing_count": "0",
"assignment_count": "1",
"zero_count": "0",
"excused_count": "0",
"timeframe_start_date": "2012-08-13",
"timeframe_end_date": "2012-11-02",
"calculated_at": "2013-06-03 01:33:03"
}
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"GradebookScoresWithSection": {
"description": "Retrieve GradeBook scores for all students associated to sections. Scores from GradeBooks associated via student groups will not be included.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradebookScoresWithSection/"
],
"responseExample": {
"page": 1,
"num_pages": 519,
"num_results": 1038,
"results": {
"local_student_id": "18829",
"gradebook_name": "Period 3 History Gr. 8 Sem. 2",
"assignment_name": "ISN Chapter 18",
"category_name": "Formative: Classwork",
"is_excused": "f",
"is_missing": "t",
"points": "0",
"score": "0",
"percentage": "0",
"use_for_calc": "t",
"use_for_aggregate": "t",
"use_category_weights": "t",
"last_updated": "2013-06-03 03:48:36",
"calculated_at": "2013-06-03 03:48:36.201801",
"mark": "F",
"entry": "mi",
"section_id": "1867",
"section_name": "",
"school_course_id": "HA800"
}
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"GradebookOverallScoresWithSection": {
"description": "Retrieve overall GradeBook scores for all students associated to sections. Scores from GradeBooks associated via student groups will not be included.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradebookOverallScoresWithSection/"
],
"responseExample": {
"page": 1,
"num_pages": 519,
"num_results": 1038,
"results": {
"local_student_id": "546558",
"gradebook_name": "TAs period 6",
"possible_points": "10",
"points_earned": "10",
"percentage": "100",
"mark": "P",
"color": "null",
"missing_count": "0",
"assignment_count": "1",
"zero_count": "0",
"excused_count": "0",
"time_frame_start_date": "2013-01-08",
"time_frame_end_date": "2013-02-22",
"calculated_at": "2013-02-27 11:25:29",
"section_id": "1867",
"section_name": "",
"school_course_id": "HA800"
}
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"GradebookCategoryScoresWithSection": {
"description": "Retrieve GradeBook scores per category for all students associated to sections. Scores from GradeBooks associated via student groups will not be included.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradebookCategoryScoresWithSection"
],
"responseExample": {
"page": 1,
"num_pages": 519,
"num_results": 1038,
"results": {
"local_student_id": "546558",
"gradebook_name": "TAs period 6",
"possible_points": "10",
"points_earned": "10",
"percentage": "100",
"category_name": "Homework",
"weight": "30",
"mark": "P",
"mark_color": "null",
"missing_count": "0",
"assignment_count": "1",
"zero_count": "0",
"excused_count": "0",
"calculated_at": "2013-02-27 11:25:29",
"time_frame_start_date": "2013-01-08",
"time_frame_end_date": "2013-02-22",
"section_id": "1867",
"section_name": "",
"school_course_id": "HA800"
}
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"returnsArray": false
},
"GradebookStandardsScoresWithSection": {
"description": "Retrieve GradeBook scores per standard for all students associated to sections. Scores from GradeBooks associated via student groups will not be included.",
"method": "GET",
"urls": [
"https://<subdomain>.illuminateed.com/<root_dir>/rest_server.php/Api/GradebookStandardsScoresWithSection"
],
"responseExample": {
"page": 1,
"num_pages": 519,
"num_results": 1038,
"results": {
"local_student_id": "4819",
"gradebook_name": "Biology P1 OGAS",
"standard": "SCI.9-12.BI.1.c",
"percentage": "60",
"mark": "D",
"points_earned": "30",
"possible_points": "50",
"color": "#dcdcdc",
"missing_count": "0",
"assignment_count": "1",
"zero_count": "0",
"excused_count": "0",
"timeframe_start_date": "2012-08-13",
"timeframe_end_date": "2012-11-02",
"calculated_at": "2013-06-03 01:33:03",
"section_id": "1867",
"section_name": "",
"school_course_id": "HA800"
}
},
"responseDescription": "The page number returned.",
"responseProperties": {
"page": "The page number returned.",
"num_pages": "The total number of pages available for the requested parameters.",
"num_results": "The total number of records available for the requested parameters.",
"results": "A list or array of multiple records."
},
"requestParameters": {
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"returnsArray": false
}
},
"requestParameters": {
"page": {
"description": "Which page number to return results for.",
"required": true,
"format": null
},
"limit": {
"description": "How many records to return per page. Max: 200",
"required": false,
"format": "<=200"
},
"user_id": {
"description": "Filter results using the internal System ID for a User.",
"required": false,
"format": null
},
"student_id": {
"description": "Filter results using the internal System ID for a Student.",
"required": false,
"format": null
},
"district_student_id": {
"description": "Filter results using the District ID for a Student.",
"required": false,
"format": null
},
"site_id": {
"description": "Limit results to students enrolled at a particular site. If this argument is not present, all district students will be returned. Selecting all district students may result in slow response times.",
"required": true,
"format": null
},
"grade_level_id": {
"description": "Filter results using the internal System ID for a Grade Level.",
"required": false,
"format": null
},
"date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": false,
"format": "YYYY-MM-DD"
},
"start_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"end_date": {
"description": "Filter results for a date range. Format 'YYYY-MM-DD'.",
"required": false,
"format": "YYYY-MM-DD"
},
"legal_guardian": {
"description": "Filter results by legal guardian Contacts (boolean).",
"required": false,
"format": null
},
"emergency_contact": {
"description": "Filter results by emergency Contacts (boolean).",
"required": false,
"format": null
},
"resides_with": {
"description": "Filter results by Contacts that the Student resides with (boolean).",
"required": false,
"format": null
},
"counselor_id": {
"description": "Filter results using the internal System ID for a Counselor.",
"required": false,
"format": null
},
"district_counselor_id": {
"description": "Filter results using the District ID for a Counselor.",
"required": false,
"format": null
},
"district_user_id": {
"description": "Limit to a single user using the District's User ID.",
"required": false,
"format": null
},
"academic_year": {
"description": "Limit to a single Academic Year. (2013-2014 = 2014).",
"required": false,
"format": null
},
"term_id": {
"description": "Limit to a single Term ID.",
"required": false,
"format": null
},
"role_id": {
"description": "Limit to a single Role ID.",
"required": false,
"format": null
},
"section_id": {
"description": "Filter results using the internal System ID for a Section.",
"required": false,
"format": null
},
"course_id": {
"description": "Filter results using the internal System ID for a Course.",
"required": false,
"format": null
},
"assessment_id": {
"description": "Filter results using the internal System ID for an Assessment.",
"required": false,
"format": null
},
"local_assessment_id": {
"description": "The external District Assessment ID.",
"required": false,
"format": null
},
"author_id": {
"description": "The author's internal system User ID.",
"required": false,
"format": null
},
"district_author_id": {
"description": "The author's external District User ID.",
"required": false,
"format": null
},
"subject_id": {
"description": "The internal System Subject ID.",
"required": false,
"format": null
},
"scope_id": {
"description": "The internal System Scope ID.",
"required": false,
"format": null
},
"local_student_id": {
"description": "Retrieve data for a specific student. If not specified, all students will be returned.",
"required": false,
"format": null
},
"responses": {
"value": [
"A",
"B",
"C",
"C",
"3"
],
"type": "object"
},
"date_taken_start": {
"description": "Filter results using the students date taken for a Pool Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"date_taken_end": {
"description": "Filter results using the students date taken for a Pool Assessment.",
"required": false,
"format": "YYYY-MM-DD"
},
"modified_after": {
"description": "Filter results to return only records inserted or modified on or after the date provided.",
"required": false,
"format": null
},
"pool_assessment_id": {
"description": "Filter results using the internal System ID for a Pool Assessment.",
"required": false,
"format": null
},
"field_some_assessment_score": {
"value": "3.5",
"type": "string"
},
"field_comments": {
"value": "Student needs to work on this.",
"type": "string"
},
"flag_code": {
"description": "The attendance flag display code that you would like to filter the section records by.",
"required": false,
"format": null
},
"as_of_date": {
"description": "Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.",
"required": true,
"format": "YYYY-MM-DD"
},
"username": {
"description": "The username for the user that you would like to create or return api keys for.",
"required": true,
"format": null
},
"password": {
"description": "The password for the user that you would like to create or return api keys for.",
"required": true,
"format": null
},
"session_type": {
"description": "Limit results to a specific session type. If not specified, data for all sessions will be returned.",
"required": false,
"format": null
},
"section_name": {
"description": "Limit results to a specific section. If not specified, data for all sections will be returned.",
"required": false,
"format": null
}
},
"responseProperties": {
"17": {
"value": "Another Elementary School",
"type": "string",
"canBeNull": false
},
"25": {
"value": "Sample High School",
"type": "string",
"canBeNull": false
},
"32": {
"value": "Sample Elementary School",
"type": "string",
"canBeNull": false
},
"site_id": {
"description": "The site ID for the site where the student is enrolled",
"value": "2",
"type": "string",
"canBeNull": false
},
"site_name": {
"value": "XYZ Unified School District",
"type": "string",
"canBeNull": false
},
"state_school_id": {
"value": 12340100000000,
"type": "number",
"canBeNull": false
},
"start_grade_level_id": {
"value": 1,
"type": "number",
"canBeNull": false
},
"end_grade_level_id": {
"value": 7,
"type": "number",
"canBeNull": false
},
"site_type_name": {
"value": "Elementary",
"type": "string",
"canBeNull": false
},
"address": {
"value": "123 ABC Street",
"type": "string",
"canBeNull": false
},
"address2": {
"value": null,
"type": "object",
"canBeNull": true
},
"city": {
"value": "Acme City",
"type": "string",
"canBeNull": false
},
"state": {
"value": "CA",
"type": "string",
"canBeNull": false
},
"zip": {
"value": 90000,
"type": "number",
"canBeNull": false
},
"local_site_code": {
"value": null,
"type": "object",
"canBeNull": true
},
"num_hours": {
"value": null,
"type": "object",
"canBeNull": true
},
"num_weeks": {
"value": null,
"type": "object",
"canBeNull": true
},
"parent_site_id": {
"value": 1,
"type": "number",
"canBeNull": false
},
"grade_level_id": {
"value": 1,
"type": "number",
"canBeNull": false
},
"short_name": {
"value": "K",
"type": "string",
"canBeNull": false
},
"long_name": {
"value": "Kindergarten",
"type": "string",
"canBeNull": false
},
"standard_age": {
"value": 5,
"type": "number",
"canBeNull": false
},
"state_id": {
"value": "KN",
"type": "string",
"canBeNull": false
},
"sort_order": {
"value": 2,
"type": "number",
"canBeNull": false
},
"page": {
"description": "The page number returned.",
"value": 1,
"type": "number",
"canBeNull": false
},
"num_pages": {
"description": "The total number of pages available for the requested parameters.",
"value": 519,
"type": "number",
"canBeNull": false
},
"num_results": {
"description": "The total number of records available for the requested parameters.",
"value": 1038,
"type": "number",
"canBeNull": false
},
"results": {
"description": "A list or array of multiple records.",
"value": {
"local_student_id": "4819",
"gradebook_name": "Biology P1 OGAS",
"standard": "SCI.9-12.BI.1.c",
"percentage": "60",
"mark": "D",
"points_earned": "30",
"possible_points": "50",
"color": "#dcdcdc",
"missing_count": "0",
"assignment_count": "1",
"zero_count": "0",
"excused_count": "0",
"timeframe_start_date": "2012-08-13",
"timeframe_end_date": "2012-11-02",
"calculated_at": "2013-06-03 01:33:03",
"section_id": "1867",
"section_name": "",
"school_course_id": "HA800"
},
"type": "object",
"canBeNull": false
},
"module": {
"value": true,
"type": "boolean",
"canBeNull": false
},
"create": {
"value": true,
"type": "boolean",
"canBeNull": false
},
"view": {
"value": true,
"type": "boolean",
"canBeNull": false
},
"update": {
"value": true,
"type": "boolean",
"canBeNull": false
},
"delete": {
"value": false,
"type": "boolean",
"canBeNull": false
},
"erase": {
"value": false,
"type": "boolean",
"canBeNull": false
},
"no_photo": {
"value": false,
"type": "boolean",
"canBeNull": false
},
"no_video": {
"value": false,
"type": "boolean",
"canBeNull": false
},
"review": {
"value": false,
"type": "boolean",
"canBeNull": false
},
"download": {
"value": false,
"type": "boolean",
"canBeNull": false
},
"search": {
"value": true,
"type": "boolean",
"canBeNull": false
},
"scores_added": {
"description": "number of student scores saved.",
"value": 2,
"type": "number",
"canBeNull": false
},
"exported_at": {
"description": "Date of assessment export.",
"value": "2013-05-21 20:27:06",
"type": "string",
"canBeNull": false
},
"version": {
"description": "This is the version number of the assessment JSON format.",
"value": 4,
"type": "number",
"canBeNull": false
},
"performance_band_sets": {
"description": "A list or array of performance band sets used by the assessment.",
"value": [
{
"performance_band_set_id": "1",
"description": "Imported District Default",
"performance_bands": [
{
"minimum_value": "90",
"label": "Advanced",
"label_number": "5",
"color": "00CA3F",
"is_mastery": true
},
{
"minimum_value": "80",
"label": "Proficient",
"label_number": "4",
"color": "91FD57",
"is_mastery": true
},
{
"minimum_value": "70",
"label": "Basic",
"label_number": "3",
"color": "FEFE56",
"is_mastery": false
},
{
"minimum_value": "60",
"label": "Below Basic",
"label_number": "2",
"color": "FFBF42",
"is_mastery": false
},
{
"minimum_value": "0",
"label": "Far Below Basic",
"label_number": "1",
"color": "FF001A",
"is_mastery": false
}
]
}
],
"type": "object",
"canBeNull": false
},
"assessment": {
"description": "The assessment structure.",
"value": {
"title": "Scores Assessment",
"description": "",
"created_at": "2013-05-21 16:05:48",
"updated_at": "2013-05-21 16:05:49",
"administered_at": "2013-05-21",
"academic_year": "2013",
"guid": "ac34b604-f5ec-4614-91d2-ed08107149c8",
"tags": "Mathematics",
"performance_band_set_id": "1",
"subject_area": "Mathematics",
"scope": null,
"grade_levels": [],
"standards": [
{
"guid": "9C69F630-29E8-11D8-9E1D-C9142A604C5A",
"performance_band_set_id": "1"
}
],
"groups": [
{
"sort_order": null,
"performance_band_set_id": "1",
"label": "Number Sense"
}
],
"versions": [
{
"number": "1",
"label": "Version 1",
"created_at": "2013-05-21 16:05:48",
"updated_at": "2013-05-21 16:05:48"
},
{
"number": "2",
"label": "Version 2",
"created_at": "2013-05-21 16:16:47",
"updated_at": "2013-05-21 16:16:47"
}
],
"fields": [
{
"order": "0",
"maximum": "1",
"created_at": "2013-05-21 16:05:49",
"updated_at": "2013-05-21 16:16:53",
"body": null,
"sort_order": "{0,1}",
"is_rubric": false,
"sheet_label": "1",
"sheet_responses": "{A,B,C,D,E}",
"responses": [
{
"points": "1",
"choice": null,
"rationale": null,
"version_number": "1",
"response": "A"
},
{
"points": "1",
"choice": null,
"rationale": null,
"version_number": "2",
"response": "A"
}
],
"standards": [
"9C69F630-29E8-11D8-9E1D-C9142A604C5A"
],
"groups": [
"Number Sense"
]
},
{
"order": "1",
"maximum": "3",
"created_at": "2013-05-21 16:05:49",
"updated_at": "2013-05-21 16:16:53",
"body": null,
"sort_order": "{1,0}",
"is_rubric": true,
"sheet_label": "2",
"sheet_responses": "{1,2,3,\"\",\"\"}",
"responses": [
{
"points": "1",
"choice": null,
"rationale": null,
"version_number": "1",
"response": "1"
},
{
"points": "1",
"choice": null,
"rationale": null,
"version_number": "2",
"response": "1"
},
{
"points": "2",
"choice": null,
"rationale": null,
"version_number": "1",
"response": "2"
},
{
"points": "2",
"choice": null,
"rationale": null,
"version_number": "2",
"response": "2"
},
{
"points": "3",
"choice": null,
"rationale": null,
"version_number": "1",
"response": "3"
},
{
"points": "3",
"choice": null,
"rationale": null,
"version_number": "2",
"response": "3"
}
],
"standards": [
"9C69F630-29E8-11D8-9E1D-C9142A604C5A"
],
"groups": [
"Number Sense"
]
}
]
},
"type": "object",
"canBeNull": false
},
"success": {
"description": "string success.",
"value": true,
"type": "boolean",
"canBeNull": false
},
"flag_code": {
"description": "The attendance flag display code.",
"value": "+",
"type": "string",
"canBeNull": false
},
"flag_title": {
"description": "The attendance flag display title.",
"value": "Present",
"type": "string",
"canBeNull": false
},
"char_code": {
"description": "The attendance flag character code.",
"value": "+",
"type": "string",
"canBeNull": false
},
"precedence": {
"description": "The attendance flag precedence. The flag with the lowest precedence value is used for the student's daily record.",
"value": 1,
"type": "number",
"canBeNull": false
},
"is_present": {
"description": "Whether the flag is considered present.",
"value": true,
"type": "boolean",
"canBeNull": false
},
"is_excused": {
"description": "Whether the flag is considered excused. This field is N/A when is_present=TRUE.",
"value": false,
"type": "boolean",
"canBeNull": false
},
"is_reconciled": {
"description": "Whether the flag is considered reconciled. This field N/A when is_present=TRUE.",
"value": true,
"type": "boolean",
"canBeNull": false
},
"is_tardy": {
"description": "Whether the flag is considered tardy.",
"value": false,
"type": "boolean",
"canBeNull": false
},
"is_extreme": {
"description": "Whether the flag is considered extreme (e.g. extreme tardy).",
"value": false,
"type": "boolean",
"canBeNull": false
},
"is_truancy": {
"description": "Whether the flag is considered a truancy.",
"value": false,
"type": "boolean",
"canBeNull": false
},
"is_suspension": {
"description": "Whether the flag is considered a suspension.",
"value": false,
"type": "boolean",
"canBeNull": false
},
"is_verified": {
"description": "Whether the flag is considered verified. This flag is only applicable when is_present=TRUE.",
"value": false,
"type": "boolean",
"canBeNull": false
},
"local_student_id": {
"description": "The student's district student ID",
"value": "123456",
"type": "string",
"canBeNull": false
},
"requirement_check_type": {
"description": "The type of requirement check (Graduation or UC)",
"value": "Graduation",
"type": "string",
"canBeNull": false
},
"requirement_category_short_name": {
"description": "The shortened name of the requirement category",
"value": "MATH",
"type": "string",
"canBeNull": false
},
"requirement_category_full_name": {
"description": "The long-form name of the requirement category",
"value": "Mathematics",
"type": "string",
"canBeNull": false
},
"requirement_category_is_non_credit": {
"description": "Indicates whether the requirement check category only looks at pass/fail status (as opposed to number of credits received)",
"value": false,
"type": "boolean",
"canBeNull": false
},
"requirement_category_credits_required": {
"description": "The number of credits required to satisfy the category",
"value": 40,
"type": "number",
"canBeNull": false
},
"requirement_category_is_satisfied": {
"description": "Indicates whether the category has been satisfied by the student",
"value": false,
"type": "boolean",
"canBeNull": false
},
"requirement_category_credits_received": {
"description": "The number of credits the student has completed toward the category",
"value": 20,
"type": "number",
"canBeNull": false
},
"requirement_category_credits_in_progress": {
"description": "The number of credits the student is currently taking toward fulfillment of the category",
"value": 5,
"type": "number",
"canBeNull": false
},
"requirement_category_credits_scheduled": {
"description": "The number of credits the student has scheduled in the future toward fulfillment of the category",
"value": 5,
"type": "number",
"canBeNull": false
},
"user_id": {
"description": "The internal System ID for this User.",
"value": 1234,
"type": "number",
"canBeNull": false
},
"user_api_key": {
"description": "The Api User Public Key.",
"value": "421B33B6E85C",
"type": "string",
"canBeNull": false
},
"user_api_secret": {
"description": "The Api User Secret Key.",
"value": "2ada48db1c211392399c57a718c7b29e75e1c588",
"type": "string",
"canBeNull": false
}
}
}
Raw
scrape-api-docs.js
// Run this in the Chrome developer console at:
// https://demo.illuminateed.com/dna/?ApiDocumentation
// It will copy the output to your clipboard automatically
var requestProperties = {},
responseProperties = {},
sections = {};
$('section.box').each(function () {
var $section = $(this),
section = {},
resource = $section.attr('id'),
tmp;
// Skip introductory headers, all class names start with an uppercase letter
if (!/[A-Z]/.test(resource .charAt(0))) {
return;
}
tmp = $section.find('.api-description');
section.description = tmp[0].textContent;
section.method = tmp[1].textContent;
section.urls = [
tmp[2].textContent.replace('demo', '<subdomain>').replace('dna', '<root_dir>')
];
section.responseExample = JSON.parse($section.find('.response.json')[0].textContent);
section.responseDescription = $section.find('div.api-response > ul > li > span.item-description')[0].textContent;
section.responseProperties = {};
section.requestParameters = {};
section.returnsArray = section.responseDescription.toLowerCase().indexOf('list') !== -1 ||
section.responseDescription.toLowerCase().indexOf('array') !== -1;
tmp = $section.find('.args.json-payload');
if (tmp.length) {
section.requestExample = JSON.parse(tmp[0].textContent);
}
$section.find('div.api-response > ul > li').each(function () {
var $this = $(this),
prop = $this.children('.item-title').text().trim(),
description = $this.children('.item-description').text().trim();
if (prop !== '') {
section.responseProperties[prop] = description;
responseProperties[prop] = { description: description };
}
});
$section.find('div.api-parameters > ul > li').each(function () {
var $this = $(this),
prop = $this.children('.item-title').text().trim(),
description = $this.children('.item-description').text().trim(),
required = !!$this.children('.item-required').length;
if (prop !== '') {
section.requestParameters[prop] = {
description: description,
required: required,
format: (prop.indexOf('date') !== -1 || prop.indexOf('Date') !== -1) ? 'YYYY-MM-DD' :
(prop === 'limit') ? '<=200' : null
};
requestProperties[prop] = section.requestParameters[prop];
}
});
if (section.requestExample) {
tmp = Array.isArray(section.requestExample) ? section.requestExample[0] : section.requestExample;
for (var prop in tmp) {
requestProperties[prop] = requestProperties[prop] || {};
requestProperties[prop].value = tmp[prop];
requestProperties[prop].type = typeof tmp[prop];
}
}
if (section.responseExample) {
tmp = Array.isArray(section.responseExample) ? section.responseExample[0] : section.responseExample;
for (var prop in tmp) {
responseProperties[prop] = responseProperties[prop] || {};
responseProperties[prop].value = tmp[prop];
responseProperties[prop].type = typeof tmp[prop];
responseProperties[prop].canBeNull = (tmp[prop] === null);
}
}
sections[resource] = section;
});
copy(JSON.stringify({
endPoints: sections,
requestParameters: requestProperties,
responseProperties: responseProperties
}, null, ' '));
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment