This object describes learners assigned to take an assessment or component grouping (can represent a markbook, exam entry, or an cohort objective).
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AssessmentLearnerSet | This object describes learners assigned to take an assessment or component grouping (can represent a markbook, exam entry, or an cohort objective). | |||
@ | RefId | M | The ID (GUID) that uniquely identifies an instance of this object. | RefIdType |
@ | AssessmentResultComponentGroupRefId | M | The assessment result component group (test or assessment) associated with the set of listed learners. | IdRefType |
CreationDateTime | M | Date/time assignment is created. | xs:dateTime | |
LocalId | O | Value supplied by publishing vendor/supplier. | xs:normalizedString | |
LearnerList | C | A list of learners who are to take the test.
Required when | List | |
LearnerList/LearnerPersonalRefId | MR | The ID (GUID) of a learner assigned to take an assessment. | IdRefType | |
SchoolGroupRefId | C | Optional reference to the class group(s) to which this will be/are drawn.
Note that this is required when | IdRefType | |
WorkforcePersonalRefId | O | The ID (GUID) that uniquely identifies the teacher or staff member who created the learner set. | IdRefType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object describes a single component of the assessment or test paper/quiz taken by a learner. A response component has one or more responses.
SIF_Events are not reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AssessmentResponseComponent | This object describes a single component of the assessment or test paper/quiz taken by a learner. A response component has one or more responses. | |||
@ | RefId | M | The GUID that uniquely identifies an instance of this object. | RefIdType |
Name | M | The identifier used within the publishing application. | xs:normalizedString | |
LocalId | O | Optional reference to the school associated with the administration. | xs:normalizedString | |
SupplierName | O | The supplier/originator/designer/owner of the described component. | xs:normalizedString | |
Description | M | Longer text describing features of the component. | xs:normalizedString | |
YearList | O | A list of specific years in which this component is applicable. By convention, if a list is not supplied then this component is assumed to be always available. | List | |
YearList/Year | MR | A year with which the component grouping is applicable (by convention this is the end year of an academic year eg: 2007/8 resolves to 2008). | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
High level container describing components of the actual assessment or test paper/quiz taken by the learner. A response component group contains one or more components.
SIF_Events are not reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AssessmentResponseComponentGroup | High level container describing components of the actual assessment or test paper/quiz taken by the learner. A response component group contains one or more components. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies an instance of this object. | RefIdType |
@ | AssessmentSessionRefId | M | The ID (GUID) of the assessment session in which the responses were collected. | IdRefType |
Name | M | Name of the assessment/test/taken. | xs:normalizedString | |
LocalId | O | The identifier used for this entity within the publishing application. | xs:normalizedString | |
SupplierName | O | The supplier/originator/designer/owner of the described component grouping. | xs:normalizedString | |
ComponentList | M | A list of the components contained within this component group. | List | |
ComponentList/AssessmentResponseComponentRefId | MR | The SIF identifier for an assessment response component. | IdRefType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
A psychological construct measured by the assessment. Operationally, an assessment component or subtest is a class of scores within an assessment that might collectively represent a column within a mark book. Some assessments may consist of only one component, aspect or subtest although it is more common for assessments to have several.
Similar to AssessmentSubTest
in US model.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AssessmentResultComponent | A psychological construct measured by the assessment. Operationally, an assessment component or subtest is a class of scores within an assessment that might collectively represent a column within a mark book. Some assessments may consist of only one component, aspect or subtest although it is more common for assessments to have several.
Similar to | |||
@ | RefId | M | The ID (GUID) of this aspect or subtest. | RefIdType |
Name | M | The name used to identify this component or aspect. | xs:normalizedString | |
LocalId | O | The identifier used within the publishing application. | xs:normalizedString | |
ShortDescription | M | Shorter description used for column headers in marksheets, etc. | xs:normalizedString | |
Description | M | Longer text describing features of the component. | xs:normalizedString | |
YearList | O | A list of specific years in which this component is applicable. By convention, if a list is not supplied then this component is assumed to be always available. | List | |
YearList/Year | MR | A year with which the component grouping is applicable (by convention this is the end year of an academic year eg: 2007/8 resolves to 2008). | xs:normalizedString | |
AssessmentSubjectList | O | A list of subject areas associated with this assessment component or aspect. | List | |
AssessmentSubjectList/Subject | MR | A subject area associated with this assessment component or aspect. | UKAssessmentSubjectType | |
StageList | O | List of the stages that this component can be used to assess. | List | |
StageList/Stage | MR | The assessed stage (this may well be a Keystage List, but there is no reason why it couldn’t be used for other concepts such as NcYear applicability, Level Exam Level GCSE, A-Level etc.). | UKAssessmentStageType | |
AssessmentResultGradeSetRefId | C | The gradeset associated with the component or aspect.
Required if | IdRefType | |
MarkSetList | C |
Required if | List | |
MarkSetList/MarkSet | MR | Defines a mark range. | ||
MarkSetList/MarkSet/StartDate | O | Start date of the range validity - ranges should not overlap. If not supplied then assumed to have always been valid in the past. | xs:date | |
MarkSetList/MarkSet/EndDate | O | End date of the range validity - ranges should not overlap. If not supplied then assumed to always will be valid in the future. | xs:date | |
MarkSetList/MarkSet/MinValue | M | The minimum value in the range of marks. | xs:decimal | |
MarkSetList/MarkSet/MaxValue | M | The maximum value in the range of marks. | xs:decimal | |
ComponentType | M | Defines the associated result format. | values:
| |
ResultQualifier | M | Defines the format or type of result(s) awarded. | UKAssessmentResultQualifierType | |
AssessmentMethod | M | The method or format of the Assessment. | UKAssessmentMethodType | |
SupplierName | O | The supplier/originator/designer/owner of the aspect. | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
High level container describing an assessment or test or common goal. Each component group contains one or more components, also known as subtests, aspects, or sub-assessments.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AssessmentResultComponentGroup | High level container describing an assessment or test or common goal. Each component group contains one or more components, also known as subtests, aspects, or sub-assessments. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies a component group. | RefIdType |
Name | M | Name of the assessment/test/goal. | xs:normalizedString | |
LocalId | O | The identifier used for this entity within the publishing application. | xs:normalizedString | |
SupplierName | O | The supplier/originator/designer/owner of the described component grouping. | xs:normalizedString | |
ComponentList | M | A list of the components contained within this component group. | List | |
ComponentList/AssessmentResultComponentRefId | MR | A SIF identifier for an assessment result component. | IdRefType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
Represents a range of valid grades (over time) for a result.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AssessmentResultGradeSet | Represents a range of valid grades (over time) for a result. | |||
@ | RefId | M | The ID (GUID) of this grade set. | RefIdType |
LocalId | O | The locally assigned identifier for this grade set. | xs:normalizedString | |
Name | M | The descriptive identifier for the grade set. | xs:normalizedString | |
Notes | O | Explanatory/usage notes for grade set. | xs:normalizedString | |
SupplierName | O | The supplier/originator/designer/owner of the gradeset. | xs:normalizedString | |
GradeSets | M | Collection of versions of a grade set (dated, non-overlapping). | List | |
GradeSets/GradeSet | MR | A specific version of a grade set. | ||
GradeSets/GradeSet/StartDate | M | The start date from which this version is valid. | xs:date | |
GradeSets/GradeSet/EndDate | O | The end date until which this version is valid. | xs:date | |
GradeSets/GradeSet/Grades | M | The list of grades in the set. | List | |
GradeSets/GradeSet/Grades/ Grade | MR | Description of an individual grade in the set. | ||
GradeSets/GradeSet/Grades/ Grade/Title | M | The visual representation of the grade. | xs:normalizedString | |
GradeSets/GradeSet/Grades/ Grade/Description | M | The meaning of the grade. | xs:normalizedString | |
GradeSets/GradeSet/Grades/ Grade/RankOrder | M | The rank position of the grade within the set where the highest value is assumed to be the best. While duplicate ranks are allowed they are discouraged. | xs:unsignedInt | |
GradeSets/GradeSet/Grades/ Grade/NumericValue | M | The numeric equivalent value of the grade. | xs:decimal | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
A session is an event where an activity is performed by or on a learner set which contributes to the attainment of the objective. Occurs at a place and time (e.g., a test is taken, assignments are handed in, a test is marked).
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
AssessmentSession | A session is an event where an activity is performed by or on a learner set which contributes to the attainment of the objective. Occurs at a place and time (e.g., a test is taken, assignments are handed in, a test is marked). | |||
@ | RefId | M | The ID (GUID) of this session. | RefIdType |
@ | AssessmentLearnerSetRefId | M | The ID (GUID) of the set of people the session refers to. | IdRefType |
SessionDate | O | The date on which the activity takes place or starts. | xs:date | |
SessionEndDate | O | The date on which this assessment ends, if different from the start date set in SessionDate. | xs:date | |
Description | O | A title or description for the activity, e.g Math Test. | xs:normalizedString | |
SchoolInfoRefId | O | The ID (GUID) of the school that the event takes place. | IdRefType | |
Activity | O | The activity which takes place. | values:
| |
Status | O | The current status of the session. | values:
| |
StaffList | O | A list of the teachers or other staff responsible for administering or assisting the learner with this assessment. | List | |
StaffList/WorkforcePersonalRefId | MR | The GUID that uniquely identifies a teacher or other staff member responsible for administering or assisting the learner with this assessment. | IdRefType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ContactPersonal | This object describes any person created as a contact at a school, LEA, or other institution, or associated with a Learner or other Workforce person. | |||
@ | RefId | M | The ID (GUID) of a person referenced as a contact. Note that this GUID may be the same GUID assigned to a LearnerPersonal and/or WorkforcePersonal object record. | RefIdType |
LocalId | O | The locally-assigned identifier for this person. | LocalId | |
PersonalInformation | M | Name, demographic, address, email, and phone information for a person acting as a contact. | PersonalInformation | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
Cycle | The timetable cycle | |||||
@ | RefId | M | Unique GUID for this cycle | RefIdType | ||
@ | SchoolInfoRefId | O | The RefId of the SchoolInfo to which this Cycle belongs. This is optional to preserve backwards compatibility but it is very strongly advised that it should be correctly populated and considered mandatory in this version of the specification. | IdRefType | ||
CycleName | O | A label for this cycle | xs:normalizedString
| |||
CycleDays | M | Number of days in cycle | xs:integer | |||
PeriodsPerDay | M | (Max) Number of periods per day (see Rectangular Grid Representation above) | xs:integer | |||
StandardPeriodList | M | Period/ShortName and Period/LongName are Mandatory in this list. | List | |||
StandardPeriodList/Period | MR | Periods in a "standard timetable day" | Period | |||
TTDayList | M | List all the days of the cycle | List | |||
TTDayList/TTDay | MR | The days in the cycle | ||||
TTDayList/TTDay/TTDayId | M | A unique local ID for this day | xs:normalizedString
| |||
TTDayList/TTDay/ShortName | M | A short day label | xs:normalizedString
| |||
TTDayList/TTDay/LongName | M | A long day label | xs:normalizedString
| |||
TTDayList/TTDay/DayIndex | M | The day’s position in the cycle (1,2,3,etc). | xs:integer | |||
TTDayList/TTDay/PeriodList | O | List of the periods on this day – only need to list the periods that are different from the "standard timetable day" – any period not listed here is taken to be the same as in the "standard timetable day". Period/LongName and Period/ShortName are optional in this list. | List | |||
TTDayList/TTDay/PeriodList/ Period | MR | A period | Period | |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object allows a system that stores network identities and/or passwords to share them with other applications through SIF. The provider of the Identity
object may only support providing an identity or a password, or it may support both.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
Identity |
This object allows a system that stores network identities and/or passwords to share them with other applications through SIF. The provider of the | |||
@ | RefId | M | The SIF RefId that uniquely identifies this object. | RefIdType |
SIF_RefId | M |
The SIF RefId of a | IdRefType | |
@ | SIF_RefObject | M |
The type of SIF object that the | values:
|
MainRole | O | Indicates whether or not the Person that this object refers to is the main role for this Identity. | values:
| |
AuthenticationSource | M |
The type of source system that produced this See implementation notes for provider requirements. | values:
| |
IdentityAssertions | O | The list of identity assertions for this user. | ActionList (IdentityAssertion/@SchemaName) | |
IdentityAssertions/IdentityAssertion | MR | The identification string for this user. | xs:normalizedString | |
@ | SchemaName | M | The name of the field. See implementation notes for details on required schema elements. Examples | xs:normalizedString |
PasswordList | O | Allows a provider or publisher to specify the same password using multiple algorithms, if supported. | List | |
PasswordList/Password | MR | A representation of the user's password using the given algorithm. | xs:base64Binary | |
@ | Algorithm | M | The method used to encrypt the user's password. See the implementation details below. | values:
|
@ | KeyName | M | The name of the key to be used for decryption of the password. Left blank for hash algorithms (MD5 and SHA1). | xs:normalizedString |
AuthenticationSourceGlobalUID | O | The globally unique identifier that links together separate Identity objects which reference the same Person. | IdRefType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
Junction | A representation of the Curriculum Diagram. | |||||
@ | RefId | M | A unique local identifier for this junction | RefIdType | ||
Label | M | A free-format label that describes the junction. Used for display purposes in the MIS and/or TT-Software. | xs:normalizedString
| |||
ShortLabel | M | A shorter version of Label, for display purposes. | xs:normalizedString
| |||
LocalType | O | An optional way for the TT-Software to provide information about the "type" of junction (eg: "band" or "block") | xs:normalizedString
| |||
InputList | M | List of one or more input groups | List | |||
InputList/Input | MR | The input(s) into this junction | ||||
InputList/Input/Type | C | Conditional and has only one value: "SC". "SC" has special meaning – it means this is the top of the "tree" and the input is the whole school. | values:
| |||
InputList/Input/GroupLocalId | C | If Type != "SC", this is the LocalId of another junction output | xs:normalizedString
| |||
OutputList | M | List of one or more output junctions | List | |||
OutputList/Output | MR | |||||
OutputList/Output/Type | M | "TG" has special meaning – it means this is the bottom of the "tree" and the output is a TeachingGroup. "YR" means a year (or "principal division") within the school (7,8,9,etc). | values:
| |||
OutputList/Output/LocalType | O | An optional way for the TT-Software to provide information about the "type" of junction (eg: "band" or "block"). | xs:normalizedString
| |||
OutputList/Output/GroupLocalId | C | Unique LocalID of this junction output | xs:normalizedString
| |||
OutputList/Output/TeachingGroupRefId | C | If Type = "TG" then include here the TeachingGroupID (see TeachingGroup) | RefIdType | |||
OutputList/Output/Desc | C | Description. Required if Type is not "TG". Optional if Type is “TG” (since a TG has its own ShortName and LongName already) | xs:normalizedString
| |||
OutputList/Output/ShortDesc | C | A shorter version of Desc, for display purposes | xs:normalizedString
| |||
OutputList/Output/NCYearList | C | Can only be present if 'Output/Type' = "YR" and even then, it is optional. Used to denote the NC Year Group of the "YR" (or give more than one NC Year Group if this is a combined-year population) | List | |||
OutputList/Output/NCYearList/ NCYear | MR | NC Year Group | NCYearGroup | |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
LEAInfo
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LAInfo |
This object contains information about a Local Authority (LA). Compare with US/Canada object: LEAInfo .
| |||
@ | RefId | M | The GUID of the LA whose information this is. | RefIdType |
LAId | M | The 3-digit LA number assigned by DfES. | LAId | |
LAName | M | The LA's short name to be used for reporting purposes. Normally, the word "Council" should not be included. | LAName | |
LAFullName | M | The LA's full name. | xs:normalizedString | |
LAURL | O | URL for the main LA website. | xs:anyURI | |
LAAddress | O | The LA's main address information. | Address | |
AddressList | O | A list of the LA's other addresses, if any. | AddressList | |
LAPhoneNumber | O | The LA's primary phone number. | PhoneNumber | |
PhoneNumberList | O | A list of the LA's other phone number(s). | PhoneNumberList | |
LAContactList | O | A list of contacts within the LA. | ContactList | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
The set of all responses provided by a learner while taking an assessment. This information represents the raw input data that is then evaluated to produce one or more scores, marks, or grades for the learner.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearnerAssessmentResponseSet | The set of all responses provided by a learner while taking an assessment. This information represents the raw input data that is then evaluated to produce one or more scores, marks, or grades for the learner. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies this response set. | RefIdType |
@ | AssessmentResponseComponentRefId | M | The ID (GUID) of the assessment response component that the responses are associated with | IdRefType |
@ | LearnerPersonalRefId | M | The ID (GUID) of the Learner for whom these responses are. | IdRefType |
Items | M | A container for item responses. | List | |
Items/Item | OR | An item contains response data and metadata. An item is defined as the stimuli presented to a learner to evoke a response for the purpose of evaluation. In most cases an item equates to a single question on the assessment. | ||
Items/Item/Response | M | Learner selection or response in raw format. | xs:string | |
Items/Item/ResponseStatus | O | Status of the response. | values:
| |
Items/Item/ResponseTime | O | The length of time the learner took to respond. | xs:duration | |
Items/Item/Mark | O | The mark achieved for this item as evaluated by the assessment tool at the time of assessment. | xs:normalizedString | |
Items/Item/Group | O | The item group within the assessment. | xs:normalizedString | |
Items/Item/ItemName | O | Identifies the item on the assessment by name. | xs:token | |
Items/Item/ItemNumber | O | Identifies the item by number on the assessment. | xs:token | |
Items/Item/OrderAsked | O | The order in which the item was asked. | xs:decimal | |
Items/Item/NumberOfAttempts | O | The number of times a learner changes their answer or attempts a response. | xs:unsignedInt | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
A single result for a learner.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearnerAssessmentResult | A single result for a learner. | |||
@ | RefId | M | The ID (GUID) of this result. | RefIdType |
@ | AssessmentComponentRefId | M | The assessment component that the result is for. | IdRefType |
@ | LearnerPersonalRefId | M | The ID (GUID) of the learner achieving the results. | IdRefType |
SchoolInfoRefId | M | The school at which the assessment was taken. | IdRefType | |
AchievementDate | M | The date the results were achieved. | xs:date | |
Result | M | A grade title, a comment, or a mark (dependent on ComponentType of associated aspect). Marks and grades should be valid in the grade set or mark set on the date the assessment was achieved. | xs:normalizedString | |
ResultStatus | M | Indicates whether the result is estimated, an interim result, provisional, actual result or a target. | UKAssessmentResultStatusType | |
AssessmentSessionList | O | The sessions which led to the result generation. | List | |
AssessmentSessionList/AssessmentSessionRefId | MR | The ID (GUID) that uniquely identifies the session associated with the result. | IdRefType | |
WorkforcePersonalRefId | O | The ID (GUID) that uniquely identifies the teacher or staff member who created the result. | IdRefType | |
Note | O | Explanatory/usage notes for result. | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | Use extended elements to define additional information to be preserved with this result data including any learner demographic data known to be valid at the time of assessment and not otherwise specified. | SIF_ExtendedElements |
This object provides attendance information for a particular learner in a particular school for a particular period of time. The time can be specified as before, during, or after school and may be for any period of time, including lessons.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearnerAttendance | This object provides attendance information for a particular learner in a particular school for a particular period of time. The time can be specified as before, during, or after school and may be for any period of time, including lessons. | |||
@ | RefId | M | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType |
@ | LearnerPersonalRefId | M | The ID (GUID) of the learner for which this attendance mark is recorded. | IdRefType |
@ | SchoolInfoRefId | M | The school where the attendance mark was taken. | IdRefType |
AttendanceDate | M | The date of the attendance period. | xs:date | |
TimeIn | O | The time when the learner began the attendance period. | xs:time | |
StartTime | C | The time the attendance period started. StartTime is required when this object represents a lesson | xs:time | |
FinishTime | O | The time the attendance period finished. | xs:time | |
Session | C | The session within which this attendance mark applies (e.g. AM/PM). Session is required when StartTime is not specified and the object refers to a session attendance mark (i.e. AttendanceDomain is session). | UKAttendanceSessionType | |
SessionLabel | O | A label associated with the session to further describe the session, when applicable. | xs:normalizedString | |
AttendanceDomain | M | The attendance type. | UKAttendanceDomainType | |
AttendanceCode | M | The attendance mark/code. | UKAttendanceCodeType | |
AttendanceNote | C | Additional comments. Required when record is specified as a correction. | xs:normalizedString | |
RecordTimestamp | O | The date/time when recorded. When more than one record exists using the same RefId, the record with the latest timestamp is assumed to be the most current. This is possible when a record is republished due to corrections. | xs:dateTime | |
InputSource | M | The source of the attendance record data. Could be Workforce member, biometric device, or other. | UKAttendanceSourceType | |
WorkforcePersonalRefId | O | The ID (GUID) of the staff member responsible for recording this attendance information. | IdRefType | |
SchoolGroupRefId | O | The ID (GUID) of the group that this attendance applies to. Useful when the attendance period corresponds to a lesson time. | IdRefType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
StudentAttendanceSummary
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearnerAttendanceSummary |
This object provides a summary of a learner's daily attendance and membership information for a given school during the time period between the StartDate and EndDate, inclusive. As such, there may be multiple instances of this object for a learner in a school over the course of an academic school year. Note that sessions are defined by each school and in most cases is two but can be any number in the range 1-10. Compare with US/Canada object: StudentAttendanceSummary .
| |||
@ | RefId | M | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType |
@ | LearnerPersonalRefId | M | The ID (GUID) of the learner for whom this attendance information is being reported. | IdRefType |
@ | SchoolInfoRefId | M | The ID (GUID) of the school for which this attendance information is being reported. | IdRefType |
SchoolYear | M | School year for which this information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006/07 school year). | SchoolYear | |
StartDate | M | Starting date of this attendance reporting period. | xs:date | |
EndDate | M | Ending date of this attendance reporting period. | xs:date | |
ReasonsList | M | An enumeration of sessions by reason code within the reporting period. | List | |
ReasonsList/Reason | MR | Learner attendance marks by code and number. | ||
ReasonsList/Reason/Code | M | The attendance code. | UKAttendanceCodeType | |
ReasonsList/Reason/Type | M | The attendance code type. | values:
| |
ReasonsList/Reason/Status | M | The authorised status of the attendance code. | values:
| |
ReasonsList/Reason/Total | M | The total number of sessions attributed to this reason between StartDate and EndDate for the specified reason. | xs:unsignedInt | |
SessionsAttendedTotal | M | The number of sessions the learner attended school when school was in session between the StartDate and EndDate, inclusive. | xs:unsignedInt | |
SessionsPossible | M | The number of sessions the learner was present plus the number of sessions the learner was absent (authorised and unauthorised) when school was in session during the period between the StartDate and EndDate, inclusive. | xs:unsignedInt | |
AuthorisedAbsences | O | The number of sessions the learner was absent from school with a valid excuse when school was in session between the StartDate and EndDate, inclusive. Note that ts column can be derived from Reason Status. | xs:unsignedInt | |
UnauthorisedAbsences | O | The number of sessions the learner was absent from school without a valid excuse when school was in session between the StartDate and EndDate, inclusive. Note that this column can be derived from Reason Status. | xs:unsignedInt | |
AlternativeTuitionHours | O | Number of Alternative Tuition (whole) hours attended between the StartDate and EndDate, inclusive. | UKTuitionHoursType | |
DfeStatutorySessionAttendanceString | O | Learner morning and afternoon session registration marks as per DfE statutory definition. This data item is a concatenation of all DfE statutory session attendance codes recorded for the given Learner starting on the morning session of the StartDate this object refers to and ending on the afternoon session of EndDate. | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
Object to represent a behaviour incident at an educational establishment
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
LearnerBehaviourIncident | Object to represent a behaviour incident at an educational establishment | |||||||||
@ | RefId | M | The ID (GUID) that uniquely identifies a particular incident | RefIdType | ||||||
SchoolInfoRefId | M | The ID (GUID) of the school that the event takes place. | IdRefType | |||||||
BehaviourType | M | The type of this Behaviour | ||||||||
BehaviourType/Weighting | M | An indicator of the positive / Negative nature and severity of behaviour | xs:integer
| |||||||
BehaviourType/Classification | M | Agreed Classification for this behaviour type | union of: UKPupilExclusionReasonType additional values:
| |||||||
BehaviourType/SubClassification | C | Free text string to precisely define the type of behaviour (if classification is Other then sub classification is mandatory else optional) | xs:normalizedString | |||||||
Incident | M | |||||||||
Incident/Date | M | Date and time Incident took place (started to take place) | xs:dateTime | |||||||
Incident/Duration | O | How long incident lasted (minutes) | xs:integer | |||||||
Incident/Location | M | The Location the Incident (mostly) took place | values:
| |||||||
Incident/Comments | O | free text comments about the incident | xs:normalizedString | |||||||
Incident/PrecursorRefId | O | A Preceding LearnerBehaviourIncidentRefID to which this behaviour is linked | IdRefType | |||||||
Incident/Confidentiality | M | May indicate the type of persons that this should be displayed to | values:
| |||||||
Participants | M | people involved in the incident | ||||||||
Participants/Employees | M | List | ||||||||
Participants/Employees/Employee | MR | |||||||||
@ | WorkforcePersonalRefId | M | The REFID of the member of Staff | IdRefType | ||||||
Participants/Employees/Employee/ ParticipationTypes | M | The capacities in which this staff member was involved | ||||||||
Participants/Employees/Employee/ ParticipationTypes/ParticipationType | MR | The capacity of Involvement | values:
| |||||||
Participants/Employees/Employee/ ParticipationComment | O | free text comments about the individuals Involvement In the incident | xs:normalizedString | |||||||
Participants/Learners | M | Must be at least one learner participating as the person who perpetrated the incident | List | |||||||
Participants/Learners/Learner | MR | |||||||||
@ | LearnerPersonalRefId | M | The REFID of the learner | IdRefType | ||||||
Participants/Learners/Learner/ ParticipationTypes | M | The capacities in which this learner member was involved | ||||||||
Participants/Learners/Learner/ ParticipationTypes/ParticipationType | MR | The capacity of Involvement | values:
| |||||||
Participants/Learners/Learner/ ParticipationComment | O | free text comments about the individuals Involvement In the incident | xs:normalizedString | |||||||
Participants/Learners/Learner/ Motivation | O | Any recorded Motivation for participation | values:
| |||||||
Participants/Learners/Learner/ Weighting | O | How many Points awarded for the participation (indicator of the positive / Negative nature and severity of individuals behaviour) | xs:integer
| |||||||
Participants/Learners/Learner/ Actions | O | List | ||||||||
Participants/Learners/Learner/ Actions/Action | MR | Actions/Outcomes which have or will occur for this individual | ||||||||
Participants/Learners/Learner/ Actions/Action/Classification | M | The classification Of Outcome | values:
| |||||||
Participants/Learners/Learner/ Actions/Action/SubClassification | O | Free text string to precisely define the action (if classification is Other then sub classification is mandatory else optional) | xs:normalizedString | |||||||
Participants/Learners/Learner/ Actions/Action/Date | M | Date and time Action has or Will take place | xs:dateTime | |||||||
Participants/Learners/Learner/ Actions/Action/Person | O | The PersonRefId of the person (student/ Employee/ parent) who will carry out the action | IdRefType | |||||||
Participants/Learners/Learner/ Actions/Action/Comment | O | free text comments about the Action | xs:normalizedString | |||||||
SIF_Metadata | O | SIF_Metadata | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
StudentContact
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
LearnerContact |
This object contains information related to a contact person for a learner. Compare with US/Canada object: StudentContact .
| |||||||
@ | RefId | M | The ID (GUID) assigned to uniquely identify this attendance record. | RefIdType | ||||
@ | LearnerPersonalRefId | M | The ID (GUID) of the learner whose contact this is. | IdRefType | ||||
@ | ContactPersonalRefId | M | The ID (GUID) of this contact. | IdRefType | ||||
Relationship | M | Defines the relationship of the contact to the learner. | UKRelationshipType | |||||
LocalId | O | The locally-assigned identifier for this contact. | LocalId | |||||
ContactFlags | M | Contains Yes/No characteristics of the contact person's role. Provide a Yes value for all that apply. Otherwise No is assumed. At least one of the child elements of ContactFlags must have a Yes value. | ||||||
ContactFlags/ParentLegalGuardian | C | Does the individual have parental or legal guardianship responsibility for the learner? | values:
| |||||
ContactFlags/PickupRights | C | Does the contact have pickup rights? | values:
| |||||
ContactFlags/LivesWith | C | Does the learner live with this contact? | values:
| |||||
ContactFlags/AddressDisclosure | C | Can address information be disclosed? | values:
| |||||
ContactFlags/EmailCommunication | C | Does the contact prefer written communcation via email? Otherwise, postal mail will be used. | values:
| |||||
ContactFlags/EmergencyContact | C | Should this contact be notified in case of emergency? | values:
| |||||
ContactFlags/DisciplinaryContact | C | Is this person to be contacted in case of disciplinary action? | values:
| |||||
ContactFlags/HomeDuringDay | C | Is the contact at home during normal daytime hours? | values:
| |||||
ContactFlags/MemberOfArmedForces | C | Is this person a member of the armed forces? | values:
| |||||
ContactFlags/PrimaryCareProvider | C | Does this person provide daily living or personal assistance to the learner? | values:
| |||||
ContactFlags/RequiresInterpreter | C | Does the contact need a translator or interpreter? | values:
| |||||
ContactFlags/TransferAddress | C | Should this contact be transferred with the Learner if and when the Learner moves? | values:
| |||||
ContactSequence | O | Number (1-10) indicating the order in which the person should be contacted. Note that 2 or more contacts may have the same value. | xs:unsignedInt
| |||||
ContactSequenceSource | O | Indicates the person who provided the contact sequence order. | UKSourceCodeType | |||||
SIF_Metadata | O | SIF_Metadata | ||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearnerEntitlement | ||||
@ | RefId | M | The ID (GUID) that uniquely identifies a particular entitlement. | RefIdType |
LearnerPersonalRefId | M | The ID (GUID) of the learner to whom this entitlement is linked. | RefIdType | |
SchoolInfoRefId | M | The ID (GUID) of the school to which this entitlement applies. | RefIdType | |
EntitlementType | M | The type of this Entitlement | xs:normalizedString | |
StartDate | M | Date Specific Entitlement starts. | xs:date | |
EndDate | O | Date Specific Entitlement Ends has to be on or after Start date. | xs:date | |
Note | O | A note relating to entitlement period. | xs:normalizedString | |
Value | O | Numeric value %discount or monetary value associated with entitlement, relative to @EntitlementType. | ||
ProviderId | O | The LA or Provider identifier of awarding organisation if relevant. | IdRefType | |
@ | ProviderType | M | LA or Provider type | xs:normalizedString |
NextReviewDate | O | Advises the date for next review of the listed entitlement, this element is not expected to be provided for instances where the EndDate is in the past as it refers to the entitlement, not periods of entitlement. Note that a review date could be prior to the end date of a current entitlement, and so is recorded separately. | xs:date | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
LearnerExclusion | This object contains information related to a learner being excluded from one or more sessions of school. | |||||||
@ | RefId | M | The ID (GUID) of this exclusion. | RefIdType | ||||
@ | LearnerPersonalRefId | M | The ID (GUID) of the excluded learner. | IdRefType | ||||
Category | M | Exclusion category. | values:
| |||||
Reason | M | Reason for exclusion. | UKExclusionReasonType | |||||
StartDate | M | Date exclusion takes effect irrespective of any review or appeal. Normally this will not be the same as Date of Leaving (exitDate) and it should be noted that the learner will remain on the schools's roll for a period after this start date. | xs:date | |||||
StartSession | M | Session to begin exclusion, starting with 1 for the first session of the day. In most cases there are two sessions per day but this is not always the case. Validation: Number between 1 and 10. | xs:unsignedInt
| |||||
EndDate | O | Date exclusion concludes. | xs:date | |||||
ActualSessions | O | Total number of sessions for which the exclusion is in effect. For lunchtime exclusions, each lunchtime for which the exclusion applies is one session. For fixed term and permanent exclusions, this is one session during the school day. For exclusions that are followed by reinstatement the actual, not the planned number of sessions should be recorded. (Exclusion sessions are used only to calculate the total allowable in a term or academic year and are not the same as an attendance session.) | xs:unsignedInt | |||||
Appeal | O | Is there an appeal against permanent exclusion? | values:
| |||||
AppealDate | O | Date for appeal against permanent exclusion. | xs:date | |||||
AppealResult | O | The result of the appeal against permanent exclusion. | values:
| |||||
ReinstatementDate | O | Date learner was reinstated, if appropriate. | xs:date | |||||
HeadTeacherNotificationDate | O | Date head teacher notified parents, school LA, and home LA (if different) of exclusion. | xs:date | |||||
GovernorMeetingDate | O | Date of Governors' meeting with respect to exclusion. | xs:date | |||||
HearingNoticeOfAppealDate | O | Date of exclusion hearing/expiration of notice of appeal. | xs:date | |||||
SIF_Metadata | O | SIF_Metadata | ||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
StudentSectionEnrollment
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearnerGroupEnrolment |
This object contains information about a learner's enrolment in a course (teaching group) or other (class, homeroom or registration) group. Compare with US/Canada object: StudentSectionEnrollment .
| |||
@ | RefId | M | The ID (GUID) that uniquely identifies this LearnerGroupEnrolment entity. | RefIdType |
@ | LearnerPersonalRefId | M | The ID (GUID) of the learner to whom the enrolment information applies. | IdRefType |
@ | SchoolGroupRefId | M | The ID (GUID) of the group in which this learner is enroled. | IdRefType |
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006/07 school year). Where a group membership is valid across multiple years, the current year at the time of publication will be used. | SchoolYear | |
EntryDate | O | Date from when this enrolment is valid. | xs:date | |
ExitDate | O | Date on which the learner's enrolment ends or has ended. | xs:date | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains personal information related to a learner. As most learners are enroled in the school or establishment publishing this object, basic enrolment information is also provided to aid in overall SIF performance.
Compare with US/Canada object: StudentPersonal
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
LearnerPersonal | This object contains personal information related to a learner. As most learners are enroled in the school or establishment publishing this object, basic enrolment information is also provided to aid in overall SIF performance.
Compare with US/Canada object: | |||||
@ | RefId | M | The ID (GUID) of the learner. Note that this GUID may be the same one assigned to this person when this person is either a contact (ContactPersonal) or a member of the workforce (WorkforcePersonal). | RefIdType | ||
LocalId | O | The locally-assigned identifier for this learner. This can be the internal pupil number or any other number as determined by the publishing agent. | LocalId | |||
AlertMsgList | O | List | ||||
AlertMsgList/AlertMsg | MR | This is an alert message that is associated with the person. | xs:normalizedString | |||
@ | Type | M | This attribute specifies what type of alert message this is. | values:
| ||
MedicalAlertMsgList | O | List | ||||
MedicalAlertMsgList/MedicalAlertMsg | MR | Medical alert associated with the person. | xs:normalizedString | |||
@ | Severity | M | The level of severity of this medical alert. | values:
| ||
PersonalInformation | M | Personal name, demographic, address, email, and phone information for this learner. | PersonalInformation | |||
UIPI | O | Unique Internal Pupil Number. | xs:normalizedString | |||
UPN | O | Unique Pupil Number (UPN) allocated to each learner in maintained schools in England and Wales. It is an identifier for use in the educational context during a child's school career only and subject to Data Protection restrictions. | xs:normalizedString | |||
UPNAllocationDate | O | Date UPN was allocated by the LA. | xs:date | |||
FormerUPNList | O | A list of former UPN's assigned to the learner, since it is possible that a learner could have more than one assigned. | List | |||
FormerUPNList/UPN | MR | A former UPN assigned to the pupil whilst at a school (eg temporary UPN was allocated when the pupil was first admitted to the school but subsequently replaced by the permanent UPN being retrieved from a previous school). | xs:normalizedString | |||
ULN | O | Unique Learner Number (ULN), a 10-digit number where zero is not allowed as the leading digit. | xs:normalizedString
| |||
ExternalLearnerIdentifierList | O | A list of one or more external values currently associated with a learner which are specific to only a person of type Learner, for which no other Identity element in LearnerPersonal can accommodate. (i.e., one would not put UPN here) | List | |||
ExternalLearnerIdentifierList/ ExternalLearnerIdentifier | MR | An external identifier as described by the IdentifierType attribute. | xs:normalizedString | |||
@ | IdentifierType | M | A code that defines the type of identifier. | values:
| ||
FamilyStructure | O | Indicates type of family structure learner is living in. | UKFamilyStructureType | |||
InCare | O | Information relating to whether the learner is "looked after" as defined by the Children Act 1989, which refers to children who are subject to care orders and those who are accommodated. | ||||
InCare/Current | M | Indicates if the learner is "looked after" currently. | values:
| |||
InCare/Type | O | Type of care the learner is in (eg fostering, children's home). | UKInCareTypeType | |||
InCare/LAId | M | The 'originating' authority where the learner was originally placed in public care and which looks after the child for the purposes of the Children Act 1989. | LAId | |||
InCare/AtCurrentSchool | O | Indicates if the learner has ever been in care while at this school. | values:
| |||
InCare/PersonalEducationPlan | O | Indicates if the learner in care has a personal education plan. | values:
| |||
ConnexionsAgreement | O | Indicates if parents have consented to allow learner data to be shared with Connexions (Middle, Secondary and Special Schools only). | UKConnexionsAgreementType | |||
ChildProtectionRegister | O | Information relating to the Child Protection Register as it pertains to this learner. | ||||
ChildProtectionRegister/IsRegistered | M | Indicates if the learner has been registered on the Child Protection Register. | values:
| |||
ChildProtectionRegister/LAId | O | The LA in which the learner was registered for protection. | LAId | |||
ChildProtectionRegister/SiblingRegistered | O | Indicates if the learner has a sibling that is also on the Child Protection Register. | values:
| |||
GiftedTalented | O | Learner qualifies for Gifted/Talented status. | values:
| |||
HomeLA | O | The LA in which the learner lives but not necessarily the one in which they attend school. | LAId | |||
LearnerIdentity | O | Classification of national identity. (Wales) | UKLearnerIdentityType | |||
ModeOfTravel | O | The usual mode of travel normally used by the learner for the greater part (in distance) of the journey to and from school. | UKUsualModeOfTravelType | |||
Pregnant | O | Learner is pregnant. | values:
| |||
SiblingList | O | List of siblings also in same school. | List | |||
SiblingList/Sibling | MR | A sibling of this learner in the same school. | ||||
SiblingList/Sibling/LearnerPersonalRefId | M | The ID (GUID) of the LearnerPersonal record for this sibling. | IdRefType | |||
SiblingList/Sibling/UIPI | M | The Unique Internal Pupil Number for a sibling of this learner. | xs:normalizedString | |||
UniformAllowance | O | Learner is paid a uniform allowance. | values:
| |||
CurrentSchoolEnrolment | O | This container reflects key enrolment data for the current or current main (home) school or establishment linked to a learner. This element is required except when there is no current enrolment for the learner within the school or establishment. It must also accurately reflect the data in the corresponding LearnerSchoolEnrolment object and generate change events for this object when change events are detected for LearnerSchoolEnrolment. | ||||
@ | LearnerSchoolEnrolmentRefId | M | The ID (GUID) of the LearnerSchoolEnrolment record associated with this learner that is also designated as the current or current main enrolment. | IdRefType | ||
@ | MembershipType | O | The type of this enrolment as it relates to the school identified by SchoolInfoRefId. | UKLearnerEnrolmentStatusType | ||
CurrentSchoolEnrolment/SIF_RefId | O |
The SIF RefId of a | IdRefType | |||
@ | SIF_RefObject | O |
The type of SIF object that the | values:
| ||
CurrentSchoolEnrolment/LAId | M | The DfES assigned number for the LA in which the learner is currently enroled with respect to their current or current main (home) school. | LAId | |||
CurrentSchoolEnrolment/EstablishmentId | M | The DfES assigned number for the school or establishment in which the learner is currently enroled with respect to their current or current main (home) school. | EstablishmentId | |||
CurrentSchoolEnrolment/NCYearGroup | M | The current or most recent National Curriculum Year Group of the learner in the LA. | NCYearGroup | |||
PreviousEstablishmentList | O | A list of known previous schools or establishments. | List | |||
PreviousEstablishmentList/ PreviousEstablishment | OR | A previous school or establishment. | ||||
PreviousEstablishmentList/ PreviousEstablishment/EstablishmentId | O | Establishment Number for this school | EstablishmentId | |||
PreviousEstablishmentList/ PreviousEstablishment/EstablishmentName | O | School's name as indicated on the Annual Schools Census. | xs:normalizedString | |||
PreviousEstablishmentList/ PreviousEstablishment/LAId | O | The 3-digit LA number assigned by DfES. | LAId | |||
PreviousEstablishmentList/ PreviousEstablishment/EntryDate | O | The date the learner entered this school or establishment. | xs:date | |||
PreviousEstablishmentList/ PreviousEstablishment/ExitDate | O | The date the learner exited this school or establishment. | xs:date | |||
PreviousEstablishmentList/ PreviousEstablishment/ExitType | O | Code indicating the type of exit from this school or establishment. | UKLeavingReasonType | |||
PreviousEstablishmentList/ PreviousEstablishment/LastSchool | O | An indication of whether the described school or establishment was the last establishment the learner attended. Note that it is possible that more than one establishment can be marked as LastSchool when a learner is enroled in more than one school simultaneously. | values:
| |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object defines information related to a learner's enrolment within a particular school or establishment.The current status on an enrolment is based on EntryDate and ExitDate. Future enrolments are supported where EntryDate is in the future. ExitDate may also be specified as a future occurance.
The publisher of this object must respond to all queries given EntryDate and ExitDate, when specified.
Compare with US/Canada object: StudentSchoolEnrollment
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
LearnerSchoolEnrolment | This object defines information related to a learner's enrolment within a particular school or establishment.The current status on an enrolment is based on EntryDate and ExitDate. Future enrolments are supported where EntryDate is in the future. ExitDate may also be specified as a future occurance. The publisher of this object must respond to all queries given EntryDate and ExitDate, when specified.
Compare with US/Canada object: | |||||
@ | RefId | M | The ID (GUID) that uniquely identifies a particular enrolment. | RefIdType | ||
@ | LearnerPersonalRefId | M | The ID (GUID) of the learner to whom this information is linked. | IdRefType | ||
@ | SchoolInfoRefId | M | The ID (GUID) of the school to which this enrolment applies. | IdRefType | ||
@ | MembershipType | M | The type of this enrolment as it relates to the school identified by SchoolInfoRefId. | UKLearnerEnrolmentStatusType | ||
EntryDate | M | The date from when this enrolment is valid. | xs:date | |||
NCYearGroupActual | M | The year group in which the learner is taught for the majority of their time, regardless of their chronological age. | NCYearGroup | |||
ClassType | O | Indicates if the learner is in a nursery class. Must be set to 'O' if age on August 31 is >= 6. | UKClassTypeType | |||
ExitDate | C | The ending date of this enrolment. If the learner has exited before the end of the school year, ExitDate must have a value. | xs:date | |||
ExitType | O | |||||
ExitType/Code | M | Code indicating the type of exit for this enrolment. | UKLeavingReasonType | |||
ExitType/Destination | O | Describes the destination of this learner upon exit. | ||||
ExitType/Destination/Code | M | Code indicating the destination type. | UKLeavingDestinationType | |||
ExitType/Destination/LAId | O | The LA number for destination school or college. | LAId | |||
ExitType/Destination/EstablishmentId | O | The DfES number for destination school or college. | EstablishmentId | |||
ExitType/Destination/Name | O | Name of institution/employer of learner's destination. | xs:normalizedString | |||
Sessions | O | Number of learner sessions (half days) per week. A maximum of 10 is possible per week. | xs:unsignedInt
| |||
FTPTStatus | O | An indication of whether the learner is enroled only part time. | values:
| |||
Boarder | O | Indicates whether the learner is a boarder at the school or not. | UKBoarderTypeType | |||
AlternativeTuition | O | Describes any alternative tuition received by the learner. | ||||
AlternativeTuition/Category | M | Reason for alternative tuition. | UKTuitionCategoryType | |||
AlternativeTuition/StartDate | M | Beginning date for alternative tuition. | xs:date | |||
AlternativeTuition/EndDate | O | End date for alternative tuition. | xs:date | |||
AlternativeTuition/TotalHours | O | The total number of hours provided for with the tuition. | xs:unsignedInt | |||
AlternativeTuition/ProvisionType | M | Alternative tuition provision type. | UKAlternativeTuitionProvisionTypeType | |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object contains information regarding a special education need (SEN) for a learner when provisioned within a school or establishment. A new object exists for each provision. The current status of any provision can be determined by querying StartDate and EndDate. Both dates are allowed to be in the future. The publisher of this object must support queries on these dates.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
LearnerSpecialNeeds | This object contains information regarding a special education need (SEN) for a learner when provisioned within a school or establishment. A new object exists for each provision. The current status of any provision can be determined by querying StartDate and EndDate. Both dates are allowed to be in the future. The publisher of this object must support queries on these dates. | |||
@ | RefId | M | The ID (GUID) that uniquely identifies a learner special need (provision). | RefIdType |
@ | LearnerPersonalRefId | M | The ID (GUID) of the learner with special educational needs. | IdRefType |
@ | SchoolInfoRefId | M | The ID (GUID) that uniquely identifies the school provisioned to work with the learner's special needs. | IdRefType |
UnitMember | O | Is this learner with special education needs (SEN) in a mainstream school a member of an SEN Unit (sometimes called special class)? | values:
| |
ResourcedProvisionMember | O | Is this learner with special education needs (SEN) in a mainstream school a member of a resourced provision? | values:
| |
NextReviewDate | O | Date of learner's next SEN review. | xs:date | |
Provision | M | A provision (stage) accommodated for this learner within this school. | UKSENProvisionType | |
StartDate | M | Date when learner was placed on the current SEN stage. Date may be in the future. | xs:date | |
EndDate | O | Date when learner finished this SEN stage. Assumed to be current unless a date in the past is specified here. | xs:date | |
SENTypeList | O | A list of Special Educational Needs types for this learner. Note that each SEN type must have its own unique ranking, and all rankings must be consecutive starting with 1. | List | |
SENTypeList/SENType | MR | The code for a Special Educational Need (type) for this learner. | UKSENTypeType | |
@ | Ranking | M | A value (starting at 1) indicating the order of significance of special educational need in relation to other SEN types listed here. | xs:unsignedInt |
AdviceAndAssessmentLevel | O | Level of provision for Advice and Assessment. (Wales) | UKAdviceAndAssessmentWalesType | |
GroupingAndSupportLevel | O | Level of provision for Grouping and Support. (Wales) | UKGroupingAndSupportWalesType | |
SpecialisedResourcesLevel | O | Level of provision for Specialised Resources. (Wales) | UKSpecialisedResourcesWalesType | |
TeachingMethodsLevel | O | Level of provision for Curriculum and Teaching Methods. (Wales) | UKCurriculumAndTeachingMethodsWalesType | |
EmbeddedBasicSkillsSupport | O | Provision of Embedded Basic Skills support beyond the attainment of formal qualification. | union of: UKBasicSkillsSupportWalesType | |
LiteracyLevelStart | O | Level of literacy at start of this SEN stage. (Wales) | xs:normalizedString | |
LiteracyLevelEnd | O | Level of literacy achieved by the end of this SEN stage. (Wales) | xs:normalizedString | |
NumeracyLevelStart | O | Level of numeracy at start of this SEN stage. (Wales) | xs:normalizedString | |
NumeracyLevelEnd | O | Level of numeracy achieved by the end of this SEN stage. (Wales) | xs:normalizedString | |
NationalCurriculumList | O | A list of National Curriculum subjects that have been modified or disapplied for this Learner. | List | |
NationalCurriculumList/NationalCurriculum | MR | A National Curriculum subject that has been modified or disapplied for this Learner. | ||
NationalCurriculumList/NationalCurriculum/ Modification | M | How is the National Curriculum used for this learner? | values:
| |
NationalCurriculumList/NationalCurriculum/ Subject | M | National Curriculum subject(s) for which modification or disapplication applies. | UKGeneralSubjectType | |
MedicalFlag | O | Is there medical information on this Learner? | values:
| |
ParamedicalSupport | O | Type of therapy needed by Learner. | values:
| |
MedicalNotes | O | Summary of learner's medical condition. | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
Lesson | A lesson on the timetable | |||||
@ | RefId | M | RefIdType | |||
@ | CycleRefId | O | The RefId of the Cycle to which this Lesson belongs. This is optional to preserve backwards compatibility but it is very strongly advised that it should be correctly populated and considered mandatory in this version of the specification. | IdRefType | ||
TTDayId | M | Day this lesson is scheduled | xs:normalizedString
| |||
PeriodIndex | M | Index of period this lesson/meeting starts | xs:integer | |||
Type | M | Lesson/meeting type The value here determines whether a TeachingGroupID or an NTCode is required | values:
| |||
Length | O | Length of lesson in periods (1=single, 2=double, etc). Can omit if just a single. | xs:integer | |||
TeachingGroupRefId | C | The Teaching Group being taught (may not be one if Type != "T") (see TeachingGroup) | IdRefType | |||
NTCodeRef | C | If there is no TeachingGroupRefID (see NTCode) | IdRefType | |||
TeacherList | O | List | ||||
TeacherList/TTTeacherRefId | OR | The teacher(s) teaching / supervising this lesson (see TTTeacher) | IdRefType | |||
TTRoomRefId | O | The room (or location) where this lesson is taking place (see TTRoom) | IdRefType | |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
NonTeachingActivity | A "non-teaching activity" is used to represent times when a teacher is not teaching a Teaching Group but is nonetheless "busy". Examples are meetings, part-time teachers who are not in school, PPA time, etc. | |||||
@ | RefId | M | A unique local identifier for this junction | RefIdType | ||
NTCode | M | A unique code for the non-teaching activity | xs:normalizedString
| |||
Description | M | A description of the non-teaching activity | xs:normalizedString
| |||
Type | M | Lesson/meeting type Note this Type over-rides the period type in the cycle definition (in case, for eg, Period 1 is Registration for some classes but not others) | values:
| |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PersonDietaryPreference | ||||
@ | RefId | M | RefIdType | |
PersonRefId | M | The ID (GUID) of the person to whom the Dietary preference is linked. | IdRefType | |
WeeklyMealPatternList | O | Periods of Meal requirements on Certain days | List | |
WeeklyMealPatternList/WeeklyMealPattern | MR | Weekly Meal Pattern | ||
WeeklyMealPatternList/WeeklyMealPattern/ StartDate | M | Date Specific pattern starts | xs:date | |
WeeklyMealPatternList/WeeklyMealPattern/ EndDate | M | Date Specific pattern Ends. | xs:date | |
WeeklyMealPatternList/WeeklyMealPattern/ Note | O | A note relating to pattern | xs:normalizedString | |
WeeklyMealPatternList/WeeklyMealPattern/ Meals | M | List of Meals Required during Period | List | |
WeeklyMealPatternList/WeeklyMealPattern/ Meals/Meal | MR | Has a Day , Time and Type defined below it | ||
WeeklyMealPatternList/WeeklyMealPattern/ Meals/Meal/Day | M | The Day of week that Meal is required | values:
| |
WeeklyMealPatternList/WeeklyMealPattern/ Meals/Meal/MealTime | M | Which meal of the day is required | values:
| |
WeeklyMealPatternList/WeeklyMealPattern/ Meals/Meal/MealType | M | What type of meal is required | values:
| |
DietaryPreferenceList | O | Periods of Meal requirements on Certain days | List | |
DietaryPreferenceList/DietaryPreference | MR | Dietary weekly Meal Pattern | ||
DietaryPreferenceList/DietaryPreference/ PreferenceType | M | The Type of preference | values:
| |
DietaryPreferenceList/DietaryPreference/ MealComponent | M | The component of meal | xs:normalizedString | |
DietaryPreferenceList/DietaryPreference/ Note | O | A note relating to dietary preference | xs:normalizedString | |
DietaryPreferenceList/DietaryPreference/ MealEffect | C | Should the Meal component be Included or Excluded from the meal. Default is Exclude | values:
| |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
StudentPicture
and EmployeePicture
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
PersonPicture |
This object either contains or references a person's picture. Compare with US/Canada objects: StudentPicture and EmployeePicture .
| |||
@ | PersonRefId | M | This is the GUID of the person whose picture this is. It is important to note that using the same GUID a person may have a LearnerPersonal record, a WorkforcePersonal record, and a ContactPersonal record all at the same time. This same picture is applicable regardless of the associated object type(s). | IdRefType |
SIF_RefObjectList | MR | A list of one or more "personal" object type codes representing objects that can be requested for this person using the specified PersonRefId. | List | |
SIF_RefObjectList/SIF_RefObject | M | The name of a "personal" object that can be requested for this person using the specified PersonRefId. | values:
| |
SchoolYear | M | School year for which this picture is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006/07 school year). | SchoolYear | |
PictureSource | M | This element defines the picture. If the Type attribute is URL, this is the location of the picture in [JPEG] format; if Type is JPEG, this is the [JPEG] image data encoded using the Base64 Content-Transfer-Encoding defined in Section 6.8 of [RFC 2045]. | URIOrBinaryType | |
@ | Type | M | The way the picture is specified (URL or JPEG). | values:
|
OKToPublish | O | Can the picture be published? | values:
| |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolDiaryEntry | Container for school diary events such as open evenings, sports days, etc. Not for description of term start and end dates (see TermInfo) or timetabled events such as lessons (see TT*, Cycle, Lesson objects). | |||
@ | RefId | M | The ID (GUID) that uniquely identifies a particular SchoolDiaryEntry. | RefIdType |
@ | SchoolInfoRefId | M | The ID (GUID) of the school to which this SchoolDiaryEntry applies. | IdRefType |
StartDate | M | Date the specific SchoolDiaryEntry starts. | xs:date | |
StartTime | O | Specific time that SchoolDiaryEntry starts. If omitted then assumed to be an all day event. | xs:time | |
EndDate | M | Date the specific DiaryEntry ends. If a single day event then it is same value as StartDate | xs:date | |
EndTime | O | Specific time that the SchoolDiaryEntry ends. If omitted then the SchoolDiaryEntry is assumed to be an all day event. | xs:time | |
Title | M | The name of the event. | xs:normalizedString | |
Description | O | A description relating to the event. | xs:normalizedString | |
Category | O | The user-defined, free text category of the diary entry. For example Open Evenings, Parent Evenings or Sports Events. | xs:normalizedString | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SectionInfo
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolGroup |
This object describes a specific group and includes resource and time tabling information. All groups are based upon a SchoolGroupType record. However, there are courses which are not based upon any subject area and likewise may not have any teachers or other staff assigned. Compare with US/Canada object: SectionInfo .
| |||
@ | RefId | M | The ID (GUID) that uniquely identifies this group entity. | RefIdType |
@ | SchoolGroupTypeRefId | M | The ID (GUID) that identifies a course upon which this group is centered. Note that this element is mandatory when GroupType is associated with a course (teaching group). | IdRefType |
@ | SchoolYear | M | School year for which the group is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006/07 school year). Where a group membership is valid across multiple years, the current year at the time of publication will be used. | SchoolYear |
LocalId | M | The locally-assigned (unique) identifier for this group. | LocalId | |
GroupName | M | The name associated with this group for display purposes. | xs:normalizedString | |
Description | O | A textual description. | xs:normalizedString | |
ParentSchoolGroupRefId | O | The parent group associated with this group, if any. | IdRefType | |
ScheduleInfoList | O | List | ||
ScheduleInfoList/ScheduleInfo | MR | The schedule-related information for a section repeating for each term in which the section is scheduled. | ||
ScheduleInfoList/ScheduleInfo/ TeacherList | O | A list of teachers, staff, or other non-learners associated with this group. | List | |
ScheduleInfoList/ScheduleInfo/ TeacherList/Teacher | MR | A teacher, staff, or other non-learner associated with this group. | ||
@ | WorkforcePersonalRefId | M | The ID (GUID) of a teacher, staff member, or other employee participating in a non-learner capacity within this group. | IdRefType |
ScheduleInfoList/ScheduleInfo/ TeacherList/Teacher/Role | O | The role associated with this person in the context of this group. | UKGroupRoleType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SchoolCourseInfo
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolGroupType |
This object describes a high-level course or class grouping organised and/or taught within a school or establishment. Note that not all courses are based upon a subject area. One such course is "Class Group" which is the same as a homeroom or registration group. Compare with US/Canada object: SchoolCourseInfo .
| |||
@ | RefId | M | The GUID that uniquely identifies a school course. | RefIdType |
@ | SchoolInfoRefId | M | The ID (GUID) that references the school or establishment where the course is offered or the registration group exists. | IdRefType |
@ | SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006/07 school year). Where a group membership is valid across multiple years, the current year at the time of publication will be used. | SchoolYear |
@ | GroupType | M | The group type. Teaching groups are used to teach subjects while other groups are organised for various other reasons. | values:
|
Code | O | The school defined local code for the group (or course). | xs:normalizedString | |
Title | O | Title associated with this group. | xs:normalizedString | |
Description | O | Textual description for the group. | xs:normalizedString | |
SubjectAreaList | O | Subject matter areas taught as part of the course, if any. | SubjectAreaList | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SchoolInfo | This object contains basic information about a school or other educational establishment. Compare with US/Canada object with the same name. | |||
@ | RefId | M | The GUID that identifies this school. | RefIdType |
@ | LAInfoRefId | O | The ID (GUID) assigned to the LA of which this school is a member. | IdRefType |
LocalId | O | An ID assigned by the publishing agent for this school or establishment. This may be set to any value. | xs:normalizedString | |
EstablishmentId | M | DfES Establishment Number for this school. | EstablishmentId | |
LAId | M | The 3-digit LA number assigned by DfES. | LAId | |
SchoolName | M | School's name as indicated on the Annual Schools Census. | xs:normalizedString | |
SchoolFullName | O | School's full name as stated in the Instrument of Government. | xs:normalizedString | |
URN | O | School Unique Reference Number. This number is an alternate to the Establishment Number. | SchoolURN | |
SchoolURL | O | URL for the school. | SchoolURL | |
SchoolAddress | O | The school's published address. | Address | |
AddressList | O | Other addresses associated with the school. | AddressList | |
SchoolPhoneNumber | O | The main phone number for this school/establishment. | PhoneNumber | |
OtherPhoneNumberList | O | A list of the school's phone numbers. | PhoneNumberList | |
SchoolEmail | O | School's email address for general correspondence. | ||
SchoolContactList | O | A list of contacts at the school. | ContactList | |
HeadTeacherInfo | O | Name and title fo the school's Head Teacher. | ||
HeadTeacherInfo/ContactName | M | The name of the head Teacher. | xs:normalizedString | |
HeadTeacherInfo/ContactTitle | O | The official title of the Head Teacher. | xs:normalizedString | |
Phase | O | The high level code indicating the level of the educational institution. | UKPhaseTypeType | |
SchoolType | O | An indication of the level of the educational institution. | UKSchoolTypeType | |
Governance | O | Governance afforded to this school. | UKGovernanceTypeType | |
Intake | O | Intake type. | values:
| |
NCYearGroupList | O | Collection of National Curriculum Year Groups offered in this school or establishment. | NCYearGroupList | |
GenderOfEntry | O | Gender of learners allowed for entry to school. | values:
| |
GenderSixthForm | O | Gender of learners allowed for entry to Sixth Form. | values:
| |
Boarders | O | Indicates whether the school supports boarders or not. | values:
| |
SessionsPerDay | M | The number of sessions in the usual school day (usually two). | xs:unsignedInt | |
Nursery | O | Indicates whether the school maintains a nursery class or not. Must be NO if Phase is set to MP, MS or SY. Must be YES if Phase is set to NY or EY. | values:
| |
Special | O | Indicates whether the school has a special class/unit or not. Must be Yes if Phase = SP. Any details will be stored in the associated SchoolInfoDetail object. | values:
| |
OperationalStatus | O | Operational condition of a school. | UKOperationalStatusType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
Scope | Scope of this timetable, ie: a general description of what dates the timetable covers, etc | |||||
@ | RefId | M | Unique GUID for this Timetable transfer | RefIdType | ||
TTScopeName | M | A short label for reference in screen displays. | xs:normalizedString
| |||
SupplierName | M | The supplier of the software that created this message | xs:normalizedString
| |||
SupplierURL | O | A URL to a page on the supplier’s website that gives information about the transfer and/or contact details for the supplier. | xs:anyURI | |||
Product | M | The product that created this message | xs:normalizedString
| |||
Version | M | The version of that Product | xs:normalizedString
| |||
SchoolInfoRefId | M | The unique school ID, taken from the existing SchoolInfo object (requested from ZIS) | IdRefType | |||
SchoolName | M | The school name in plain text – to help a person to see immediately this is the correct school | xs:normalizedString
| |||
ScheduleCreationDate | C | Date schedule was created or last edited (omitted for "Basic data only" message) | xs:date | |||
ScheduleName | C | Name given to schedule by timetabler. The TT-Software may contain more than one schedule, so this tells us which one is being sent. | xs:normalizedString
| |||
SchoolYear | M | The academic year the timetable or basic data relates to (given as year the academic year ends in) | SchoolYear | |||
StartDate | C | First day of the timetable | xs:date | |||
EndDate | C | Last day of the timetable | xs:date | |||
Status | M | The "Status" of the timetable transfer 'BT' and 'ET' are sent by TTSoftware when sending a timetable. The others are sent by the MIS after receiving a timetable. (See also "Reasons for Status" below). | values:
| |||
PhoneNumberList | O | The supplier's phone number(s). | PhoneNumberList | |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
TeachingGroup | A Teaching Group | |||||
@ | RefId | M | Unique local ID | RefIdType | ||
SchoolGroupRefId | O | The RefId of the SchoolGroup (typically in the MIS) that represents this TeachingGroup. (This will typically be known if the information is coming from an MIS; but typically not known if the information is coming from timetabling software.) | IdRefType | |||
GroupDefinition | C | Required if MISRefId omitted (ie: if this is a new (proposed) TG) Optional if MISRefId included | ||||
GroupDefinition/ShortName | M | A short free-format label that describes the group. Used for display purposes in the MIS or TT-Software. | xs:normalizedString
| |||
GroupDefinition/LongName | M | A longer label to help office staff understand the meaning of the group | xs:normalizedString
| |||
GroupDefinition/TTSubjectRefId | M | Subject being taught - see TTSubject NB: We do not allow a TG to have no subject | IdRefType | |||
GroupDefinition/Set | O | Set number (typically 1,2,3,etc or A,B,C, etc but could be a longer label). Can be useful when office staff are trying to "recognise" a TG | xs:normalizedString
| |||
GroupDefinition/Block | O | Block number or letter (eg: "A") Can be useful when office staff are trying to "recognise" a TG | xs:normalizedString
| |||
GroupDefinition/Level | O | Level / Assessment Stage, eg "KS3" (if known / relevant) | UKAssessmentStageType | |||
MainTeacherRefId | OR | The main teacher / supervisor / etc for this group (for reporting / recognition purposes) (see TTTeacher) | IdRefType | |||
GroupTeacherList | O | A list of teachers associated with this TG | List | |||
GroupTeacherList/GroupTeacher | MR | A teacher associated with this TG | ||||
GroupTeacherList/GroupTeacher/ TTTeacherRefId | M | The teacher (see TTTeacher) | IdRefType | |||
GroupTeacherList/GroupTeacher/ Type | M | The teacher’s relationship with the TG | values:
| |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
TermInfo
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||
---|---|---|---|---|---|---|---|---|
TermInfo |
This object provides information about a term; i.e., a reportable period of time. Compare with US/Canada object: TermInfo .
| |||||||
@ | RefId | M | The ID (GUID) that uniquely identifies this TermInfo entity. | RefIdType | ||||
@ | SchoolInfoRefId | M | The ID (GUID) that identifies the school where the term is used. | IdRefType | ||||
SchoolYear | M | School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006/07 school year). Where a group membership is valid across multiple years, the current year at the time of publication will be used. | SchoolYear | |||||
StartDate | M | Starting date of the term. | xs:date | |||||
EndDate | M | Ending date of the term. | xs:date | |||||
Description | O | Text-based description of the term. | xs:normalizedString | |||||
TermCode | O | Locally-defined code. Use 'AUT', 'SPR', or 'SUM' for a 3 term year. Otherwise specify the term number within the year. | xs:normalizedString | |||||
TermsPerYear | O | The number of terms in a given year (3-6). | xs:unsignedInt
| |||||
MarkingTerm | O | Does this TermInfo represent a marking period? | values:
| |||||
SchedulingTerm | O | Does this TermInfo represent a scheduling term? | values:
| |||||
AttendanceTerm | O | Does this TermInfo represent an attendance term? | values:
| |||||
SIF_Metadata | O | SIF_Metadata | ||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
TTRoom | A room (or learning space) used on the timetable. This may or may not be a "real" room stored in the MIS yet. | |||||
@ | RefId | M | RefIdType | |||
Code | M | Unique Code local to TT-Software (short name) | xs:normalizedString
| |||
Description | M | This is the description of the room (long name) It is used by the MIS to help the user manually match to a room in the MIS (or decide on some other appropriate action). The recommended maximum length of the string is 32 characters. | xs:normalizedString | |||
SiteRefId | O | Which "site" this room is on. It may also be used by the MIS. References the TTSite object. | IdRefType | |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
TTSite | A site used on the timetable. This may or may not be a “real” site stored in the MIS yet. | |||||
@ | RefId | M | Unique GUID for this Site | RefIdType | ||
Code | M | Unique Code local to TT-Software | xs:normalizedString
| |||
Description | M | This is the description of the site. It is used by the MIS to help the user manually match to a site in the MIS (or decide on some other appropriate action). | xs:normalizedString
| |||
Type | O | What "type" of site this is. It is used by the MIS to help with any manual matching. | values:
| |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
TTSubject | A subject used on the timetable. This may or may not be a subject stored in the MIS yet. | |||||
@ | RefId | M | RefIdType | |||
Code | M | Unique Code local to TT-Software (could be Teacher Initials, Staff Code, etc) | xs:normalizedString
| |||
Description | M | This is the description of the subject (long name). The recommended maximum length of the string is 32 characters. | xs:normalizedString SIF_Metadata | |||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
TTTeacher | A teacher (or teaching post) used on the timetable. This may or may not be a "real" teacher stored in the MIS yet. | |||||
@ | RefId | M | Unique GUID for this Timetable Teacher | RefIdType | ||
Code | M | Unique Code local to TT-Software (could be Teacher Initials, Staff Code, etc) | xs:normalizedString
| |||
WorkforcePersonalRefId | O | If this teacher is known to the MIS, this is the "WorkforcePersonalId" | IdRefType | |||
Description | M | This is the description of the teacher (or "post", etc). It may be a name "John Smith" or it may just be a description such as "New Maths Teacher". If WorkforcePersonalId is not supplied, this Description is used by the MIS to help theuser manually match to a teacher in the MIS (or decide on some other appropriate action). | xs:normalizedString
| |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
WorkforceAbsence | Details the absence of a Workforce person for a duration and reason. If the reason is sickness then additional detail can be provided in line with typical HR requirements. If the absence only relates to a specific assignment, e.g. an individual who is a kitchen assistant and midday supervisor takes the morning off only then this association can be made. | |||
@ | RefId | M | The ID (GUID) of the WorkforceAbsence object. | RefIdType |
@ | WorkforcePersonalRefId | M | RefId of WorkforcePersonal object this applies to. | RefIdType |
AbsenceStartDate | M | Date this absence started. | xs:date | |
AbsenceStartTime | O | Time on AbsenceStartDate that this absence started, assumed midnight if not included. | xs:time | |
AbsenceEndDate | O | Date this absence ended, if omitted it is assumed that the absence is ongoing. | xs:date | |
AbsenceEndTime | O | Time on AbsenceEndDate that this absence ended, assumed midnight if not included. | xs:time | |
AbsenceType | M | Type of absence. | UKAbsenceReasonType | |
AbsenceIllness | O | Specific illness if AbsenceType is Sickness. | UKIllnessCategoryType | |
WorkforceAssignmentRefId | O | For use if this absence relates to a specific WorkforceAssignment. | RefIdType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |
---|---|---|---|---|
WorkforceAssignment | A more detailed, temporal and referenced view of the posts a person holds compared to the WorkforcePersonal CurrentAssignmentList element. Based around the US SIF 2.4 EmployeeAssignment object. | |||
@ | RefId | M | The ID (GUID) of the WorkforceAssignment object. | RefIdType |
@ | WorkforcePersonalRefId | M | RefId of WorkforcePersonal object this applies to. | RefIdType |
SIF_RefId | O |
The SIF RefId of a | IdRefType | |
@ | SIF_RefObject | O |
The type of SIF object that the | values:
|
AssignmentStartDate | M | The date this assignment commenced. | xs:date | |
AssignmentEndDate | O | The date this assignment ends. | xs:date | |
Post | M | The post held under this particular assignment | UKAssignmentPostType | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||||||
---|---|---|---|---|---|---|---|---|---|---|
WorkforceContract | Extends the details specified in a WorkforceAssignment to include details of contracts governing WorkforceAssignments. This is a stub only at the moment and may be expanded in the future to contain additional contract details such as renumeration. Based around the US SIF 2.4 EmployeeContract object. | |||||||||
@ | RefId | M | The ID (GUID) of the WorkforceContract object. | RefIdType | ||||||
@ | WorkforceAssignmentRefId | M | RefId of WorkforceAssignment object this applies to. | RefIdType | ||||||
ContractStartDate | M | Date this contract becomes effective. | xs:date | |||||||
ContractEndDate | O | Date this contract ceases effect. | xs:date | |||||||
ContractAssignmentCode | M | Reference identifying this contract and assignment. | xs:string | |||||||
ContractHoursPerWeek | O | Employed hours per week on this contract. | xs:decimal
| |||||||
ContractWeeksPerYear | O | Employed weeks per year on this contract. | xs:decimal
| |||||||
ContractFTE | O | Full-time job equivalent ratio for this assignment. (Format is x.xx; an employee who is full-time and who spends 50% of their time on this assignment would be represented as 0.50). | xs:decimal
| |||||||
SIF_Metadata | O | SIF_Metadata | ||||||||
SIF_ExtendedElements | O | SIF_ExtendedElements |
EmployeePersonal
and StaffPersonal
.
SIF_Events are reported for this object.
Element/@Attribute | Char | Description | Type | |||
---|---|---|---|---|---|---|
WorkforcePersonal |
This object contains key personal information relating to a workforce member, who might be a teacher or other employee of the school or LA. Compare with US/Canada objects: EmployeePersonal and StaffPersonal .
| |||||
@ | RefId | M | The ID (GUID) of the workforce member. Note that the same GUID may be assigned to this person when they are also a learner (via LearnerPersonal) and/or a contact (via ContactPersonal). | RefIdType | ||
LocalId | M | The locally-assigned identifier for this workforce member. | LocalId | |||
AlertMsgList | O | List | ||||
AlertMsgList/AlertMsg | MR | This is an alert message that is associated with the person. | xs:normalizedString | |||
@ | Type | M | This attribute specifies what type of alert message this is. | values:
| ||
MedicalAlertMsgList | O | List | ||||
MedicalAlertMsgList/MedicalAlertMsg | MR | Medical alert associated with the person. | xs:normalizedString | |||
@ | Severity | M | The level of severity of this medical alert. | values:
| ||
PersonalInformation | M | Personal name, demographic, address, email, and phone information for this person. | PersonalInformation | |||
TeacherNumber | O | The DfES Teacher Reference number. For those who have one this is a unique number. | xs:normalizedString | |||
NINumber | O | National Insurance Number. Do not specify temporary numbers. Format: AAnnnnnnA | xs:normalizedString
| |||
ExternalWorkforceIdentifierList | O | A list of one or more external values currently associated with an employee which are specific to only a person of type Workforce, for which no other Identity element in WorkforcePersonal can accommodate. (i.e., one would not put TeacherNumber here) | List | |||
ExternalWorkforceIdentifierList/ ExternalWorkforceIdentifier | MR | An external identifier as described by the IdentifierType attribute. | xs:normalizedString | |||
@ | IdentifierType | M | A code that defines the type of identifier. | values:
| ||
CurrentAssignmentList | O | A list of assignments associated with a workforce member, including school and role. This list serves as a quick lookup for information relating to a workforce member's postings or assignments to an LA, School, or other establishment. An agent will operate more eficiently if the data represented here is sufficient. Otherwise, it will be necessary for the agent to also request the WorkforceAssignment object(s). | List | |||
CurrentAssignmentList/CurrentAssignment | MR | A workforce member's assignment. | ||||
CurrentAssignmentList/CurrentAssignment/ SIF_RefId | O |
The SIF RefId of a | IdRefType | |||
@ | SIF_RefObject | O |
The type of SIF object that the | values:
| ||
CurrentAssignmentList/CurrentAssignment/ LAId | O | The DfES assigned number for the LA in which the workforce member is working, if associated. | LAId | |||
CurrentAssignmentList/CurrentAssignment/ EstablishmentId | O | The DfES assigned number for the school or establishment in which the workforce member is working. Note that the school may not necessarily be in the same LA listed as the LAId. | EstablishmentId | |||
CurrentAssignmentList/CurrentAssignment/ Posts | O | A list of posts that are applicable to the workforce member's association with this school or LA. | List | |||
CurrentAssignmentList/CurrentAssignment/ Posts/Post | MR | The post assigned to the workforce member in the context of the school or LA. | UKAssignmentPostType | |||
SIF_Metadata | O | SIF_Metadata | ||||
SIF_ExtendedElements | O | SIF_ExtendedElements |