This API allows third party applications to interact and communicate with the Illuminate system. Follow on Twitter and subscribe to notifications to receive news and information about updates to this API.

Do you want to get access? Access is given to districts and 3rd party vendors on an as needed basis. Just contact help@illuminateed.com and tell us about your application and how you will use our API. If you are a 3rd party vendor, be sure to tell us which districts you are working with.

The Illuminate API is a REST based API, meaning that it accepts traditional HTTP requests. Currently all requests and responses are handled in JSON encoded strings.

OAuth is used for user centric Web Service Authentication. OAuth is an open, simple and secure protocol that enables applications to authenticate users and interact with the Illuminate system on behalf of those users.

For general non user interactive Web Service Authentication, some of the same principals of OAuth are used. The API Request security will use the same Public Keys, Secrets, and Signature methodology as used with OAuth. The only major differences being that the User Access Token and Secret will be pre-generated and Browser Redirection will not take place.

Consumer Key & Secret

Every application that will communicate with the Web Service is known as a Consumer. Each instance of your application will need it's own Consumer Key and Secret. Every request made will need to include the Consumer Key as a parameter. The Consumer Secret will be used to create a Signature for every request made to the API.

User Token & Secret

Every request made to the server must also include a Token specifically representing an individual user. This will be combined with a User Secret Key and will be used for generating the Signature along with the Consumer Key & Secret.

Signing Requests & Calling the API

You must sign all requests to the Illuminate system using HMAC-SHA1 signature encryption.

To create a signature you must first create a base string from your request details. The base string is constructed by concatenating the HTTP request method, the encoded request URL, and any request parameters encoded, sorted by name, and separated with the '&' symbol.

For example, the following Request:

URL:

https://demo.illuminateed.com/dna/rest_server.php/Api/Students
?page=2
&limit=50

Authorization Parameters:

oauth_consumer_key=653e7a6ecc1d528c516cc8f92cf98611
oauth_nonce=bfa41b93ec995f9385b5f34027181dc4
oauth_signature_method=HMAC-SHA1
oauth_timestamp=1305583298
oauth_version=1.0
oauth_token=72157626737672178-022bbd2f4c2f3432

Would have a base string of the following:

GET&https%3A%2F%2Fdemo.illuminateed.com%2Fdna%2Frest_server.php%2FApi%2FStudents&limit%3D50%26oauth_consumer_key%3D653e7a6ecc1d528c516cc8f92cf98611%26oauth_nonce%3Dbfa41b93ec995f9385b5f34027181dc4%26oauth_signature_method%3DHMAC-SHA1%26oauth_timestamp%3D1305583298%26oauth_token%3D72157626737672178-022bbd2f4c2f3432%26oauth_version%3D1.0%26page%3D2

Concatenate the consumer secret and user secret separated with the '&' symbol when running it through HMAC-SHA1 encryption:

4f88a6d17f8b9ad90e00005f&fccb68c4e6103197

Which would be used to create the following signature using HMAC-SHA1 encryption:

xGCh4eS0ochHLAiR5cR0Ht0oy/Q=

You would then create the OAuth Authorization HTTP Header string. OAuth Authorization Parameters currently must be included as part of the Authorization HTTP Header and not the Query Parameters. To create the string, concatenate the OAuth parameters with a comma while in the format key="value". Don't forget to include the generated signature. You will also need to prefix the string 'OAuth '.

OAuth oauth_consumer_key="653e7a6ecc1d528c516cc8f92cf98611",oauth_nonce="bfa41b93ec995f9385b5f34027181dc4",oauth_signature_method="HMAC-SHA1",oauth_timestamp="1305583298",oauth_version="1.0",oauth_token="72157626737672178-022bbd2f4c2f3432",oauth_signature="xGCh4eS0ochHLAiR5cR0Ht0oy/Q="

Server Errors

Server Errors will have a HTTP Response Status Code and the response body will be blank unless otherwise noted.

  • 400 - Bad Request (Invalid request, see response body for details)
  • 401 - Unauthorized (Invalid or missing authentication credentials)
  • 403 - Forbidden (Valid authentication credentials, Unauthorized permission to API Method or element)
  • 404 - Not Found (Invalid API method or element not found)
  • 405 - Method Not Allowed (GET, POST, PUT, or DELETE not allowed for API method)
  • 500 - System Error (Internal Application Error)

Returns a list of District and School sites.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Sites/

Response

  • A list or array of multiple Sites. [
    • site_id The internal System ID for this Site.
    • local_site_code An optional local identifier for each site. Possibly a district school code.
    • site_name The site name.
    • state_school_id The State ID for this Site.
    • start_grade_level_id The grade level ID of the beginning of the range of grades taught.
    • end_grade_level_id The grade level ID of the end of the range of grades taught.
    • site_type_name The school type.
    • address The street address of the site.
    • address2 Address continued.
    • city City.
    • state State.
    • zip Zip Code.
    • num_hours Annual number of hours.
    • num_weeks Annual number of weeks of instruction.
    • parent_site_id The hierarchical parent Site or District.
    ]

Example

[{"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}]

Returns a list of Grade Levels and their IDs.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/GradeLevels/

Response

  • A list or array of multiple Grade Levels. [
    • grade_level_id The internal System ID for this Grade Level.
    • short_name The short description of the grade level.
    • long_name The long description of the grade level.
    • standard_age The typical student age.
    • state_id The State's Grade Level ID.
    • sort_order The numeric value representing the display order.
    ]

Example

[{"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}]

Returns a paginated list of Students.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Students/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • district_student_id (optional) Filter results using the District ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • student_id The internal System ID for this Student.
    • district_student_id The District's ID for this Student.
    • state_student_id The State's ID for this Student.
    • last_name Last Name.
    • first_name First Name.
    • middle_name Middle Name or initial.
    • username Student username.
    • email Student E-Mail.
    • birth_date Date of Birth.
    • gender Gender.
    • ethnicity_1 Race 1.
    • ethnicity_2 Race 2.
    • ethnicity_3 Race 3.
    • is_hispanic Is Hispanic. (boolean)
    • primary_language Primary Language.
    • correspondence_language Correspondence Language.
    • language_fluency English Proficiency / Language Fluency.
    • reclassification_date EL Reclassification Date.
    • reclassification_date EL Reclassification Date.
    • primary_disability Primary Disability.
    • us_entry_date US School Entry Date.
    • school_entry_date School Entry Date.
    • district_entry_date District Entry Date.
    • parent_education_level Parent Education Level.
    • birth_city Birth City.
    • birth_state Birth State.
    • birth_country Birth Country.
    • academic_year Academic Year. 2012 = 2011-2012 School Year.
    ]

Example

{"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},{"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}]}

Returns a paginated list of Students and their Counselors.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/StudentCounselors/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • student_id (optional) Filter results using the internal System ID for a Student.
  • district_student_id (optional) Filter results using the District ID for a Student.
  • counselor_id (optional) Filter results using the internal System ID for a Counselor.
  • district_counselor_id (optional) Filter results using the District ID for a Counselor.
  • date (optional) Filter student set for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter student set for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter student set for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • student_id The internal System ID for this Student.
    • district_student_id The District's ID for this Student.
    • state_student_id The State's ID for this Student.
    • last_name Student Last Name.
    • first_name Student First Name.
    • middle_name Student Middle Name or initial.
    • counselor_id The internal System ID for this Counselor.
    • district_counselor_id The District's ID for this Counselor.
    • counselor_last_name Counselor Last Name.
    • counselor_name Counselor First Name.
    • counselor_email Counselor E-Mail Address.
    • start_date Counselor Assigned Date.
    • end_date Counselor Unassigned Date.
    ]

Example

{"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}]}

Returns a paginated list of Users.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Users/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • user_id (optional) Limit to a single user using the internal System ID for a User.
  • district_user_id (optional) Limit to a single user using the District's User ID.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • user_id The internal System ID for this User.
    • district_user_id The District's ID for this User.
    • last_name Last Name.
    • first_name First Name.
    • middle_name Middle Name or initial.
    • birth_date Date of Birth.
    • gender Gender.
    • username The login account name.
    • state_user_id The State's ID for this User.
    • suffix The Name Suffix.
    • name_former_last Former Last Name.
    • name_former_first Former First Name.
    • name_former_middle Former Middle Name or initial.
    • primary_ethnicity Race 1.
    • is_hispanic Is Hispanic. (boolean)
    • address The street address of the user.
    • city City.
    • state State.
    • zip Zip Code.
    • job_title The User's Job Title.
    • staff_education_level Staff Education Level.
    • hire_date Hire Date.
    • exit_date Exit Date.
    • active Active User. (boolean)
    ]

Example

{"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"}]}

Returns a paginated list of User Roles.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/UserRoles/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • user_id (optional) Limit to a single user using the internal System ID for a User.
  • district_user_id (optional) Limit to a single user using the District's User ID.
  • academic_year (optional) Limit to a single Academic Year. (2013-2014 = 2014).
  • site_id (optional) Limit to a single Site ID.
  • term_id (optional) Limit to a single Term ID.
  • role_id (optional) Limit to a single Role ID.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • user_id The internal System ID for this User.
    • district_user_id The District's ID for this User.
    • site_id Site ID.
    • academic_year Academic Year.
    • term_id Term ID.
    • role_id Role ID.
    • role_name Role Name.
    ]

Example

{"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"}]}

Returns a paginated list of Terms.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Terms/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'. Defaults to the session start date if not provided.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'. Defaults to the session end date if not provided.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • term_id The internal System ID for this Term.
    • site_id The Site ID for this Term.
    • term_name The Name of this Term.
    • term_num Term Number.
    • state_date The Term Start Date.
    • end_date The Term End Date.
    • term_type Type of Term.
    • session_type_id Session Type ID.
    • session_type Session Type Name.
    • academic_year Academic Year. 2012 = 2011-2012 School Year.
    • district_term_id District Term ID.
    ]

Example

{"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}]}

Returns a paginated list of Courses.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Courses/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • course_id The internal System ID for this Course.
    • school_course_id The School's ID for this Course.
    • long_name The detailed Name of the Course.
    • short_name The abbreviated Name of the Course.
    • department_name The Department Name for the Course.
    • start_grade_level_id The grade level ID of the beginning of the range of grades taught.
    • end_grade_level_id The grade level ID of the end of the range of grades taught.
    • site_ids A list of Site IDs that teach this course.
    • is_active Course is active. (boolean)
    • weight Course Weight.
    • description Detailed Course Description.
    • credits Credits Possible
    • has_variable_credits Has Variable Credits. (boolean)
    • max_credits Maximum Number of Course Credits.
    • is_specialed Is Special Education Course. (boolean)
    • max_capacity Maximum Number of Students for Course.
    • is_intervention Is Intervention Course. (boolean)
    • nclb_instructional_level NCLB Instructional Level
    • course_content Course Content
    • educational_service Educational Service
    • instructional_strategy Instructional Strategy
    • program_funding_source Program Funding Source
    • tech_prep Tech Prep. (boolean)
    ]

Example

{"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"}]}

Returns a paginated list of Enrollment records.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Enrollment/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • student_id The internal System ID for the Student.
    • district_student_id The District's ID for the Student.
    • state_student_id The State's ID for the Student.
    • last_name Last Name.
    • first_name First Name.
    • middle_name Middle Name or initial.
    • birth_date Date of Birth.
    • site_id The Site ID.
    • entry_date Enrollment Start Date.
    • leave_date Enrollment End Date.
    • grade_level_id Grade Level ID.
    • academic_year Academic Year. 2012 = 2011-2012 School Year.
    • is_primary_ada Is Primary ADA. (boolean)
    • attendance_category Attendance Category.
    • enrollment_exit_reason Enrollment Exit Reason.
    • session_type_id Session Type ID.
    ]

Example

{"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}]}

Returns a paginated list of Sections.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/MasterSchedule/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • section_id The internal System ID for this Section.
    • district_section_id The District's ID for this Section.
    • site_id The Site ID at which this section is offered.
    • term_id The Term ID during which this section is offered.
    • term_name The Term Name during which this section is offered.
    • course_id The internal System ID for this Section's Course.
    • user_id The internal System ID for the teacher of this Section.
    • period The Period Name of this Section.
    • academic_year Academic Year. 2012 = 2011-2012 School Year.
    • room_number Section Room Number.
    • session_type_id Session Type ID.
    • district_term_id The District's Term ID during which this section is offered.
    • quarter_num The Quarter Number of this Section.
    • user_start_date The First Date that the Teacher taught this Section.
    • user_end_date Last Date that the Teacher taught this Section.
    • primary_teacher Designates this Teacher as the Primary Teacher for this Section.
    ]

Example

{"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"}]}

Returns a paginated list of Roster records.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Roster/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • district_student_id (optional) Filter results using the District ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • student_id The internal System ID for the Student.
    • district_student_id The District's ID for the Student.
    • state_student_id The State's ID for the Student.
    • last_name Last Name.
    • first_name First Name.
    • middle_name Middle Name or initial.
    • birth_date Date of Birth.
    • section_id Section ID in which this student is registered.
    • site_id Site ID at which this student is registered.
    • course_id Course ID in which this student is registered.
    • user_id User ID of the Teacher who is teaching this student in the section/course.
    • entry_date The date this student first entered this section/course.
    • leave_date The date this student exited this this section/course.
    • grade_level_id The Grade Level ID of the student in this section/course.
    • academic_year Academic Year. 2012 = 2011-2012 School Year.
    • session_type_id The Session Type ID.
    ]

Example

{"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}]}

Returns a paginated list of Assessments records.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Assessments/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • assessment_id (optional) The internal system Assessment ID.
  • local_assessment_id (optional) The external District Assessment ID.
  • author_id (optional) The author's internal system User ID.
  • district_author_id (optional) The author's external District User ID.
  • subject_id (optional) The internal System Subject ID.
  • scope_id (optional) The internal System Scope ID.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • assessment_id The internal system ID for the assessment.
    • local_assessment_id The external District ID for the assessment.
    • title The title of the assessment.
    • description The description of the assessment.
    • author_id The author's internal system User ID.
    • district_author_id The author's District User ID.
    • author_first The author's first name.
    • author_last The author's last name.
    • created_at The date the assessment was created.
    • updated_at The date the assessment was last updated.
    • scope_id An optionally set Scope ID.
    • scope An optionally set Scope.
    • subject_id An optionally set Subject Area ID.
    • subject An optionally set Subject Area.
    • grade_levels A comma separated list of optionally set Grade Levels.
    ]

Example

{"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"}]}

Submit student scores to an assessment.

Method

POST

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Assessment/{assessment_id}/Scores/

Parameters

  • [
    • [
      • local_student_id (required) The local (aka district) student id the scores belong to. This is not the same as the system student id.
      • version (optional) The version number the student took. DEFAULT is 1. A version defines an alternate question order.
      • responses (required) An array of student responses, A,B,C...etc. Rubric scores can be submitted as whole integers 0,1,2...etc. Ordered by version question order.
      • text_responses (optional) An array of student text responses. Used for submitting Constructed Response text. Ordered by version question order.
      • date_taken (optional) The date the student took the assessment. Format YYYY-MM-DD. Defaults to the current date.
      ]
    ]

Example URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Assessment/12345/Scores/

Example Payload

[{"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"]}]

Response

  • scores_added number of student scores saved.

Example

{"scores_added":2}

Returns a paginated list of aggregated student scores for an assessment.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/AssessmentAggregateStudentResponses/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • assessment_id (optional) Filter results using the internal System ID for an Assessment.
  • date_taken_start (optional) Filter results using the students date taken for an Assessment.
  • date_taken_end (optional) Filter results using the students date taken for an Assessment.
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • assessment_id The internal system ID for an Assessment.
    • title The assessment title
    • local_student_id The student's district student id
    • first_name The student's first name.
    • last_name The student's last name.
    • middle_name The student's middle name.
    • version The student's version number they took on the assessment.
    • version_label The student's version label they took.
    • date_taken The date the student took the assessment.
    • points The number of points the student received
    • points_possible The number of points possible for the assessment.
    • percent_correct The student's percent correct on the assessment
    • performance_band_level The student's performance band level on the assessment
    • performance_band_label The student's performance band label
    • mastered Returns wether or not the student mastered the assessment.
    ]

Example

{"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"}]}

Returns a paginated list of aggregated student scores for an assessment by question group.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/AssessmentAggregateStudentResponsesGroup/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • assessment_id (optional) Filter results using the internal System ID for an Assessment.
  • date_taken_start (optional) Filter results using the students date taken for an Assessment.
  • date_taken_end (optional) Filter results using the students date taken for an Assessment.
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • assessment_id The internal system ID for an Assessment.
    • title The assessment title
    • local_student_id The student's district student id
    • first_name The student's first name.
    • last_name The student's last name.
    • middle_name The student's middle name.
    • reporting_group The question group (reporting group) name.
    • date_taken The date the student took the assessment.
    • points The number of points the student received on the reporting group
    • points_possible The number of points possible for the reporting group.
    • percent_correct The student's percent correct on the reporting group
    • performance_band_level The student's performance band level on the reporting group
    • performance_band_label The student's performance band label
    • mastered Returns wether or not the student mastered the reporting group.
    ]

Example

{"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"}]}

Returns a paginated list of aggregated student scores for an assessment by standard.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/AssessmentAggregateStudentResponsesStandard/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • assessment_id (optional) Filter results using the internal System ID for an Assessment.
  • date_taken_start (optional) Filter results using the students date taken for an Assessment.
  • date_taken_end (optional) Filter results using the students date taken for an Assessment.
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • assessment_id The internal system ID for an Assessment.
    • title The assessment title
    • local_student_id The student's district student id
    • first_name The student's first name.
    • last_name The student's last name.
    • middle_name The student's middle name.
    • academic_benchmark_guid The Academic Benchmark GUID for the standard.
    • standard_code The state standard code provided by Academic Benchmarks.
    • standard_description The standard description.
    • date_taken The date the student took the assessment.
    • points The number of points the student received on the standard
    • points_possible The number of points possible for the standard.
    • percent_correct The student's percent correct on the standard
    • performance_band_level The student's performance band level on the standard
    • performance_band_label The student's performance band label
    • mastered Returns wether or not the student mastered the standard.
    ]

Example

{"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"}]}

Returns a paginated list of aggregated student scores for a pool assessment.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/PoolAssessmentAggregateStudentResponses/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • pool_assessment_id (optional) Filter results using the internal System ID for a Pool Assessment.
  • date_taken_start (optional) Filter results using the students date taken for a Pool Assessment.
  • date_taken_end (optional) Filter results using the students date taken for a Pool Assessment.
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • pool_assessment_id The internal system ID for a Pool Assessment.
    • title The pool assessment title
    • local_student_id The student's district student id
    • first_name The student's first name.
    • last_name The student's last name.
    • middle_name The student's middle name.
    • date_taken The date the student took the pool assessment.
    • points The number of points the student received
    • points_possible The number of points possible for the pool assessment.
    • percent_correct The student's percent correct on the pool assessment
    • performance_band_level The student's performance band level on the pool assessment
    • performance_band_label The student's performance band label
    • mastered Returns wether or not the student mastered the pool assessment.
    ]

Example

{"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"}]}

Returns a paginated list of aggregated student scores for a pool assessment by standard.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/PoolAssessmentAggregateStudentResponsesStandard/

Parameters

  • page (required) Which page number to return results for.
  • limit (optional) How many records to return per page. Max: 200
  • pool_assessment_id (optional) Filter results using the internal System ID for a Pool Assessment.
  • date_taken_start (optional) Filter results using the students date taken for a Pool Assessment.
  • date_taken_end (optional) Filter results using the students date taken for a Pool Assessment.
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.
  • date (optional) Filter results for a single date. Format 'YYYY-MM-DD'. Defaults to today (or nearest in session date) if not provided.
  • start_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.
  • end_date (optional) Filter results for a date range. Format 'YYYY-MM-DD'.

Example

{"page":2,"limit":50}

Response

  • 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. [
    • pool_assessment_id The internal system ID for a Pool Assessment.
    • title The pool assessment title
    • local_student_id The student's district student id
    • first_name The student's first name.
    • last_name The student's last name.
    • middle_name The student's middle name.
    • academic_benchmark_guid The Academic Benchmark GUID for the standard.
    • standard_code The state standard code provided by Academic Benchmarks.
    • standard_description The standard description.
    • date_taken The date the student took the pool assessment.
    • points The number of points the student received on the standard
    • points_possible The number of points possible for the standard.
    • percent_correct The student's percent correct on the standard
    • performance_band_level The student's performance band level on the standard
    • performance_band_label The student's performance band label
    • mastered Returns wether or not the student mastered the standard.
    ]

Example

{"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"}]}

View the information in an assessment.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Assessment/{assessment_id}/View/

Parameters

  • None

Example URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Assessment/12345/View/

Response

  • 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. [
    • performance_band_set_id The internal system ID for this performance band set.
    • description The description of this performance band set.
    • performance_bands A list or array of performance band levels that make up this set. [
      • minimum_value Minimum percentage value of the band level.
      • label The name of the performance band level.
      • label_number The numeric value of the performance band level.
      • color Hex color code of the band level.
      • is_mastery Boolean value representing the band level's mastery status.
      ]
    ]
  • assessment The assessment structure. [
    • title The name of the assessment.
    • description The description of the assessment.
    • created_at The date this assessment was created.
    • updated_at The date this assessment was last updated.
    • administered_at The defined date this assessment should be administered.
    • academic_year The academic year of the assessment used for filtering. 2013 = 2012-2013
    • guid A unique identifier for this assessment.
    • tags Comma separated list of tags used for filtering.
    • subject_area The academic subject area used for filtering.
    • scope The scope or category used for filtering .
    • grade_levels A list or array of grade levels used for filtering. [  ]
    • standards A list or array of Academic Benchmark GUIDs that exist within the assessment and associated performance band set for aggregate standard scores. [
      • guid An Academic Benchmarks GUID representing this standard.
      • performance_band_set_id The performance band set id to use for reporting aggregate scores.
      ]
    • groups A list or array of question groups that exist within the assessment and associated performance band set for aggregate group scores. [
      • sort_order An integer used to specify reporting group sort order.
      • performance_band_set_id The performance band set id to use for reporting aggregate scores.
      • label The name of this reporting group.
      ]
    • versions A list or array of assessment versions. A version defines an alternate question or answer choice order. [
      • number The version number used for identifying this version.
      • label The name of this version.
      • created_at The date this version was created.
      • updated_at The date this version was last modified.
      ]
    • fields A list or array of fields or questions within the assessment. [
      • order The zero based index position of this question in the master version.
      • maximum The maximum points possible for this question.
      • created_at The date this assessment question was created.
      • updated_at The date this assessment question was last modified.
      • body N/A.
      • sort_order A comma separated list containing the zero based index position of the question within each version. Surrounded by parenthesis.
      • is_rubric Boolean value determining if question is scored using a rubric.
      • sheet_label The sheet label of this question.
      • sheet_responses A comma separated list of possible answer choices. Surrounded by parenthesis.
      • responses A list or array of responses and their points for this question. Usually only contains the correct responses. [
        • points Points given for this response.
        • choice N/A
        • rationale N/A
        • version_number The version number for which this response is valid. Versions are used for randomized answer choice ordering.
        • response The actual response label, A,B,C,D,E...etc for Multiple Choice or 1,2,3...etc for rubric scores.
        ]
      • standards An array or list of Academic Benchmark GUIDs aligned to this question. [  ]
      • groups An array or list of question group names aligned to this question. [  ]
      ]

Example

{"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"]}]}}

Submit data to a summary assessment or demographic, AKA repository.

Method

POST

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Repository/{repository_id}/Data/

Example URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Repository/12345/Data/
or
https://demo.illuminateed.com/dna/rest_server.php/Api/Repository/local_repository_id/abc123/Data/
to lookup the repository using the local_repository_id

Example Payload

[{"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."}]

Response

  • success string success.

Example

{"success":true}

Retrieve attendance daily records for a particular date.

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Attendance/Daily/

Parameters

  • date (required) The date you would like to retrieve the daily records for.
  • flag_code The attendance flag display code that you would like to filter the daily records by.
  • user_id (optional) Filter results using the internal System ID for a User.
  • student_id (optional) Filter results using the internal System ID for a Student.
  • site_id (optional) Filter results using the internal System ID for a Site.
  • section_id (optional) Filter results using the internal System ID for a Section.
  • course_id (optional) Filter results using the internal System ID for a Course.
  • grade_level_id (optional) Filter results using the internal System ID for a Grade Level.

Example

{"date":"2012-05-05","flag_code":"Abs"}

Response

  • 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. [
    • district_student_id The student's ID as provided by the student information service.
    • flag_code The flag (display) code of the attendance flag associated with the student's daily record.
    • flag_title The descriptive title of the attendance flag associated with the student's daily record.
    • site_id The site ID the attendance record is associated with.
    • date The date of the attendance mark.
    • last_name The student's last name.
    • first_name The student's first name.
    • middle_name The student's middle name.
    • birth_date The student's birth date.
    • gender The student's gender.
    • contact_first_name The student's primary contact's first name.
    • contact_middle_name The student's primary contact's middle name.
    • contact_last_name The student's primary contact's last name.
    • contact_name_suffix The student's primary contact's name suffix.
    • contact_email_address The student's primary contact's email address.
    • contact_name_prefix The student's primary contact's name prefix.
    • contact_gender The student's primary contact's gender.
    • contact_birth_date The student's primary contact's birth date.
    • email_opt_out False ('f') if the student's primary contact opted out of emails.
    • contact_type_code The code key associated with the contact type of the student's primary contact.
    • contact_type The code translation (description) associated with the contact type of the student's primary contact.
    • correspondence_language_code The code key associated with the correspondence language of the student's primary contact.
    • correspondence_language The code translation (description) associated with the correspondence language of the student's primary contact.
    • marital_status_code The code key associated with the marital status of the student's primary contact.
    • marital_status The code translation (description) associated with the marital status of the student's primary contact.
    • address The first line of the student's primary contact's address.
    • address_2 The second line of the student's primary contact's address.
    • city The city the student's primary contact's address belongs to.
    • zip The zip code the student's primary contact's address belongs to.
    • state The state the student's primary contact's address belongs to.
    • household_name The name of the household the student's primary contact is associated with.
    • local_dwelling_block_id The dwelling ID the student's primary contact is associated with.
    • dwelling_block_name The name of the dwelling the student's primary contact is associated with.
    • contact_phone The student's primary contact's primary phone number.
    • contact_phone_type_code The code key associated with the student's primary contact's primary phone number.
    • contact_phone_type The code translation (description) associated with the student's primary contact's primary phone number.
    ]

Example

{"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"}]}

Retrieve list of attendance flags

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/Attendance/Flags/

Parameters

  • None

Response

  • 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.

Example

[{"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}]

Retrieve status of course requirement checks (both graduation and UC checks) for all students

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/CourseRequirementChecks/

Parameters

  • site_id (optional) 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.
  • as_of_date (optional) Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.

Response

  • 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

Example

[{"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}]

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

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/CreateUserApiKeys/

Parameters

  • username (required) The username for the user that you would like to create or return api keys for.
  • password (required) The password for the user that you would like to create or return api keys for.

Example

username: bob
password: mySecret123

Response

The Response will either return the user information or an error.

  • 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.

Valid Example (HTTP Response 200)

{"user_id":1234,"user_api_key":"421B33B6E85C","user_api_secret":"2ada48db1c211392399c57a718c7b29e75e1c588"}

Invalid Example (HTTP Response 400)

{"error":{"code":"invalid_credentials","message":"Invalid User Credentials"}}

Retrieve GradeBook scores for all students

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/GradebookScores/

Parameters

  • date (optional) Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.
  • local_student_id (optional) Retrieve data for a specific student. If not specified, all students will be returned.
  • session_type (optional) Limit results to a specific session type. If not specified, data for all sessions will be returned.
  • section_name (optional) Limit results to a specific section. If not specified, data for all sections will be returned.

Response

  • 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. [
    • local_student_id The student's district student ID
    • gradebook_name The GradeBook where the student's score belongs to
    • assignment_name Assignment where the score belongs to
    • category_name Category name where the assignment belongs to
    • is_excused Determines if the student is excused for this assignment
    • is_missing Determines if the student is missing this assignment
    • points Points received for this assignment
    • score Score received for this assignment
    • percentage Percentage received for this assignment
    • use_for_calc Determines if this score shall be included in the student's overall grade computation
    • use_for_aggregate Determines whether or not the assignment score should be used for aggregate scores
    • use_category_weights Determines if the score will use category weights in computing for the overall grade
    • last_updated Date when this data was last updated
    • calculated_at Date when this score was calculated
    • mark Mark received for this assignment
    • entry Custom marks received for this assignment
    ]

Example

{"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"}}

Retrieve overall GradeBook scores for all students

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/GradebookOverallScores/

Parameters

  • date (optional) Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.
  • local_student_id (optional) Retrieve data for a specific student. If not specified, all students will be returned.
  • session_type (optional) Limit results to a specific session type. If not specified, data for all sessions will be returned.
  • section_name (optional) Limit results to a specific section. If not specified, data for all sections will be returned.

Response

  • 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. [
    • local_student_id The student's district student ID
    • gradebook_name The GradeBook where the student's score belongs to
    • possible_points Total possible points for this GradeBook
    • points_earned Total points earned for this GradeBook
    • percentage Total percentage earned for this GradeBook
    • mark Overall mark received for this GradeBook
    • color Mark color
    • missing_count Total number of missing assignments for this GradeBook
    • assignment_count Total number of assignments for this GradeBook
    • zero_count Total number of assignments in which the student received zero points
    • excused_count Total number of excused assignments for this GradeBook
    • time_frame_start_date Time frame start date used for calculating the total score
    • time_frame_end_date Time frame end date used for calculating the total score
    • calculated_at Date when this score was calculated
    ]

Example

{"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"}}

Retrieve GradeBook scores per category for all students

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/GradebookCategoryScores

Parameters

  • date (optional) Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.
  • local_student_id (optional) Retrieve data for a specific student. If not specified, all students will be returned.
  • session_type (optional) Limit results to a specific session type. If not specified, data for all sessions will be returned.
  • section_name (optional) Limit results to a specific section. If not specified, data for all sections will be returned.

Response

  • 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. [
    • local_student_id The student's district student ID
    • gradebook_name The GradeBook where the student's score belongs to
    • possible_points Total possible points for this category
    • points_earned Total points earned for this category
    • percentage Percentage received for this category
    • category_name Category Name
    • weight Weight of this category
    • mark Mark received for this category
    • mark_color Mark color
    • missing_count Total number of missing assignments for this category
    • assignment_count Total number of assignments for this category
    • zero_count Total number of assignments in which the student received zero points for this category
    • excused_count Total number of excused assignments for this category
    • calculated_at Date when this score was calculated
    • time_frame_start_date Time frame start date used for calculation
    • time_frame_end_date Time frame end date used for calculation
    ]

Example

{"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"}}

Retrieve GradeBook scores per standard for all students

Method

GET

URL

https://demo.illuminateed.com/dna/rest_server.php/Api/GradebookStandardsScores

Parameters

  • date (optional) Retrieve data for students enrolled as of a particular date. If no date is specified, data for currently enrolled students will be returned.
  • local_student_id (optional) Retrieve data for a specific student. If not specified, all students will be returned.
  • session_type (optional) Limit results to a specific session type. If not specified, data for all sessions will be returned.
  • section_name (optional) Limit results to a specific section. If not specified, data for all sections will be returned.

Response

  • 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. [
    • local_student_id The student's district student ID
    • gradebook_name The GradeBook where the student's score belongs to
    • standard Standard ID
    • percentage Percentage received for this standard
    • mark Mark received for this standard
    • points_earned Total points earned for this standard
    • possible_points Total possible points for this standard
    • color Mark color
    • missing_count Total number of missing assignments for this standard
    • assignment_count Total number of assignments for this standard
    • zero_count Total number of assignments in which the student received zero points for this standard
    • excused_count Total number of excused assignments for this standard
    • timeframe_start_date Time frame start date used for calculation
    • timeframe_end_date Time frame end date used for calculation
    • calculated_at Date when this score was calculated
    ]

Example

{"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"}}