This is a one page representation of the Assembly Platform Data Model. You can click on the name of a resource to access our developer documentation for it.
Resource - Academic Years
An academic_year object represents a school year within a particular school.
||Internal stable ID given to academic year on Platform||4|
||Name of academic year||"2015/2016"|
||Date on which academic year starts||"2015-09-01"|
||Date on which academic year ends||"2016-07-21"|
||Provides details of the individual terms that make up the academic year|
Resource - Terms Dates
If the access token also has the
calendar scope, then term dates will also be included with academic_years where available (currently for SIMS schools only).
||Internal stable ID given to term_dates on Platform||2032|
||Name of the term||"Summer Term"|
||Date on which term begins||"2016-04-11T00:00:00.000Z"|
||Date on which term ends||"2016-07-22T23:59:00.000Z|
Resource - School Details
Returns details for the school associated with the provided
||Internal stable ID given to all schools on Platform||1231|
||Name of the school||"Test School"|
||Unique Reference Number (URN) of the school||"123456"|
||The code of the local authority that the school belongs to||123|
||The name of the local authority that the school belongs to||"City of London"|
||The school's establishment or "DfE number"||4321|
||The type of establishment||"Community School"|
||The phase of the school (i.e. "Secondary, "Primary" or "All through")||"Secondary"|
||The street that the school is on||"High Street"|
||The town that the school is in||"London"|
||The postcode of the school||"SE1 1AA"|
||The school's head teacher name||"Mrs A Smith"|
Resource - OAuth
The OAuth endpoints are available to gain authorisation to access a school's data.
|access_token||string||Access token grants authorisation to school data (currently validfor a period of 30 days)|| "U10.cre0RDDZ_xfGz0"
|refresh_token||string||Refresh tokens should be used to aquire a new access token upon expiry of access tokens||"34g9hp0obobgo9g23"|
|token_type||string|| Provides the client with the information to utilise the access token to make a resource request
|level||string||Details whether the token gives access to application level resources or school data.||"app"|
|expires_in||string||The amount of time (in seconds) that the access token is valid for||"108000"|
|school_id||number||Internal Platform ID for school that the token applies to||143|
Resource - Staff Members
A staff_member object represents a single staff member within a school.
||Internal stable ID given to each staff member in the Platform||24|
||The first name of the staff member||"Trevor"|
||The middle name of the staff member||"Lance"|
||The last name of the staff member||"Taylor"|
||The title of the staff member||"Mr"|
||The email address of the staff member.|| "trevor.taylor @assembly.education"
||Indicates whether the staff member is a teacher|| true
Resource - Students
A student object represents a single student within a school.
||Internal stable ID given to staff members in the Platform||48|
||The first name of the student||"Duncan"|
||The middle name of the student||"Peter"|
||The last name of the student||"Smith"|
||The date of birth of the student||"17/05/2004"|
||The year group the student currently belongs to||"7"|
||Unique Pupil Number (UPN) - a DfE-mandated 13-character code that identifies each pupil||"M3334321444109"|
||The ID of a student from the MIS||"A1234"|
|| A student's "pupil admission number". This field is exposed in the front end of the MIS, and may be the same as
||Date when the student joined the school||"2016-03-31T00:00:00.000Z"|
||Date when the student left the school (this will default to 2079-06-06T23:59:00.000Z)||"2017-07-21T00:00:00.000Z"|
||The enrolment status of the student||"Current (Single Registration)"|
|| Demographics information about the student (this will only be returned if
|| List of contact IDs for the student (this will only be returned if
|| The home address and postcode of a student (this will only be returned if
Resource - Student Demographics
Demographic information about the student.
||A detailed way of categorising the ethnicity of a student. There are roughly 100 DfE standard codes||"MOTH"|
||A broader categorisation of ethnicity that is standardised across the country, with all ethnicity codes grouped in to 8 sections||"Mixed/ Dual Background"|
||The gender of the student||"M"|
|| Looked after status - indicates whether the student is 'looked after' by the local authority (this field will only be returned if
|| English as an Additional Language (EAL) - this field will be
||Free School Meals (FSM) - indicates if the student is eligible for free school meals||true|
||Pupil Premium (PP) - schools receive extra funding for students who qualify as Pupil Premium. The includes any student who has qualified for Free School Meals (FSM) in the last 6 years, and any student in local-authority care||true|
|| Special Education Need (SEN) - indicates a student has learning difficulties and requires special education provision. Can be
|| Information about a student's SEN Needs. This will only be returned if
Resource - Student SEN Needs
A student's home address and postcode.
Information about a student's SEN Needs.
||The id of the sen need||12|
||The start date for the need||"2014-09-01T00:00:00.000Z"|
||The code of the sen need||"VI"|
||The name of the sen need|| "Visual Impairment"
||The code for the broad need||"SENS"|
||The name of the broad need||"Sensory and/or physical"|
||The priority of the sen need||1|
Resource - Student Address
A student's home address and postcode.
||The first line of the address||"1 King Street"|
||The second line of the address||"Flat 1"|
||The town or city||"Maidstone"|
||The country||"United Kingdom"|
||The postcode||"A1 1AA"|
Resource - Subjects
A subject object represents an Assembly Platform subject. These subjects are mapped to one or multiple subjects within a school's MIS and are used to normalise school to school variance in subject naming to a known and fixed set within the Assembly Platform.
||Internal stable ID given to all subjects in the Platform||22|
||Full name of subject||"Mathematics"|
||Shortened code of subject||"MAT"|
Resource - Teaching Groups
A teaching_group object represents the grouping in which students are taught a subject.
||Internal stable ID given to all teaching groups in the Platform||12|
||Name of teaching group||"7/Ma1"|
||The start date of the teaching group||"2015-09-01T00:00:00.000Z"|
||The end date of the teaching group||"2016-08-31T23:59:00.000Z"|
||The IDs of supervisors associated with the teaching group||1, 15|
||The IDs of students associated with the teaching group||14, 15, 107, 222|
||The ID, code and name of the subject of the teaching group||22, "Mathematics", "MAT"|
Resource - Registration Groups
A registration_group object represents the grouping in which students take AM/PM roll call (morning and afternoon registers).
||Internal stable ID given to all registration groups on the Platform||124|
||Name of the registration group||"6-Oxford"|
||The IDs of students associated with the registration group||141, 151, 307|
||The IDs of staff members associated with the registration group||76, 234|
Resource - Year Groups
A year_group object represents the pastoral year group that a student belongs to.
||The code of the year that the student belongs to||7|
||The name of internal year group that the student belongs to||"Year 7"|
||The IDs of students associated with the year group||12, 233, 3323|
||The IDs of supervisors associated with the year group||1|
Resource - Contacts
A contact object represents a parent or guardian. Students are related to contacts through a student/contact relationship.
||Internal stable ID given to all contacts on the Platform||87|
||The first name of the contact||"Tony"|
||The middle name of the contact||"Peter"|
||The last name of the contact||"Smith"|
||The gender of the contact||"M"|
||The title of the contact||"Mr"|
||The salutation for the contact||"Mr Smith"|
||A list of emails for the contact - see the Email Addresses resource|
||A list of telephone numbers for the contact - see the Telephone Numbers resource||
||A list of student IDs that the contact is responsible for||
Resource - Student Contact Relationship
A student contact relationship object represents the relationship between a student and a contact.
||The relationship between the contact and the student||"Mother"|
||The priority of this contact for the student||1|
||Indicates whether the contact has parental responsibility for the student||true|
Resource - Telephone Numbers
|id||number||Internal stable ID given to all telephone numbers on the Platform||23|
|telephone_number||string||The telephone number||"0123 456789"|
|type||enum|| The location associated with the telephone number - can be
|is_primary||boolean||Indicates whether this is the primary telephone number||true|
Resource - Email Addresses
The email object is available for contacts and staff members, and contains the following fields.
|id||number||Internal stable ID given to all email addresses on the Platform||12|
|string||The email address||"firstname.lastname@example.org"|
|type||enum|| The location associated with the email address - can be
|is_primary||boolean||Indicates whether this is the primary email address||true|
Resource - Calendar Events
The calendar_events object provides details of school events. This resource is currently only available for SIMS.
||Internal stable ID given to all calendar events on the Platform||1|
||This details the user-defined "category" that the event is assigned to on SIMS.||"Meeting"|
||The name of the instance of the event, usually more detailed and specific than the "name"||"After School SLT Meeting"|
||Date and time of when the event starts||"2015-09-03T16:00:00.000Z"|
||Date and time of when the event ends||"2015-09-03T17:30:00.000Z"|
||Whether the event is active or not||true|
||Whether the event recurs and (soon) details of recurrences||true|
||Details the type of event - whether it is a regular calendar event, a staff meeting or inset day|
Resource - Assessments
The assessment is the grouping that knits together a range of concepts. The name of the assessment also refers to the source of the result (for example, a Key Stage national assessment, or a standardised assessment provider).
||Internal stable ID given to all assessments on the Platform||1|
||The name of the assessment||"Standardised Assessment - Standardised Score"|
Resource - Assessment Family
The Assessment Family groups together multiple assessments. In cases where Assembly gathers assessment data using multiple gradesets for the same test (e.g. a raw score, a standardised score and a percentile), the Assessment Family is the grouping that ties those multiple asessments together.
||Internal stable ID given to all assessment families on the Platform||2|
||The name of the assessment family||"Standardised Assessment Provider 1"|
Resource - Gradesets
Gradesets offer an acceptable range of values for any given assessment.
||Internal stable ID given to all gradesets on the Platform||2|
||The name of the assessment family||"Standardised Score"|
||See the grades resource for more information||
Resource - Grades
The grades are the acceptable values and ids that make up a gradeset.
||Internal stable ID given to all grades. Results should be written back to the Platform using the ID (as opposed to the "name")||2032|
||The name of the grade as a string||"110", "EXS", "8"|
||The value of the grade as a number||8.5, 100|
Resource - Facets
All results belong to one of four facets, with each facet reflecting a different type of grade. Facets can be used to compare 2 grades of the same assessment.
||Internal stable ID given to all facets on the Platform||6|
||The name of the facet||"achieved", "target", "prediction", "baseline"|
Resource - Assessment Points
An assessment point represents a point in the school key stage, year, term or half-term that results can be attached to.
||A stable number consistently assigned to assessment points across all environments. This field should be used to send results back to the Platform||122|
||The name of the assessment point||"Key Stage 2"|
||The time period that the assessment point relates to. This can be an entire key stage, an entire year, or a single term or half-term||"key_stage", "year", "term"|
||This field ties an assessment point to a year group.||"Year 6 Spring 2"|
Resource - Results
A result combines the other assessment principles and attaches them to a student.
||Internal stable ID given to all results on the Platform||101|
||The ID of the student that the result is attached to||923|
||The ID of the subject that the result is attached to||2|
||The ID of the assessment that the result is attached to||1|
||The rank of the assessment point||48|
||The ID of the aspect that the result is attached to||6|
||The ID of the grade||157|
||The date and time that the result was first created||"2017-06-07T09:24:06.991Z"|
||The date and time that the result was last updated||"2017-06-07T09:24:06.991Z"|
Resource - Attendances
The attendances resource details AM and PM roll call attendance marks for students.
||Internal stable ID given to all attendances on the Platform||2117|
||The ID of the student that the attendance is attached to||1085|
||The ID of the subject that the attendance is attached to||4682|
||The date of the attendance||"2017-05-19T13:00:00.000Z"|
||Denotes whether the attendance is an AM session or PM session (morning or afternoon)||"PM"|
||The attendance mark||"/"|
||If the attendance mark is "L" for "Late", how many minutes late the student was||15|
||Any additional comments||"Missed bus"|
Please note: the value of some fields may be
null where the MIS doesn't provide this data.
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.