Trainee object
trainee_id
-
string (limited to 24 characters)
The unique ID of the trainee in the Register system. Used to identify the trainee when using endpoints which require a
trainee_id
.Example:
37T2Vm9aipqSVokbhWUMjedu
provider_trainee_id
-
string (limited to 50 characters)
The unique ID of the trainee in the Provider’s student record system (SRS).
Example:
99157234
application_id
-
integer
The unique ID of the application choice in the Apply system.
Example:
123456
trn
-
string (limited to 7 characters)
The reference number allocated to each trainee prior to course completion.
Example:
2248531
first_names
-
string (limited to 60 characters), required
The first names of the trainee.
Example:
Ruby Joy
last_name
-
string (limited to 60 characters), required
The last name of the trainee.
Example:
Smith
previous_last_name
-
string (limited to 60 characters)
The last name of the trainee immediately before their current last name.
Example:
Jones
date_of_birth
-
string, required
This field records the date of birth of the student.
Example:
2000-01-01
sex
-
string (limited to 2 characters), required
The sex of the trainee. Possible values:
10
- Female11
- Male12
- Other96
- Information refused99
- Not available
Example:
10
nationality
-
string (limited to 2 characters)
The nationality of the trainee. Coded according to the HESA nationality field
Example:
GB
email
-
string (limited to 80 characters), required
This must be a trainee’s personal email address. DfE uses this to communicate to trainees after they have left their training course, for example, regarding their QTS.
Example:
trainee123@example.com
ethnicity
-
string (limited to 3 characters)
The ethnicity of the trainee. Coded according to the HESA ethnicity field. The values for
ethnic_background
andethnic_group
will be set based on theethnicity
value.Note: If no ethnicity value is provided (blank or null), the system will automatically set this field to
997
(Not provided).Example:
120
disability1
todisability9
-
string (limited to 2 characters)
The type of disabilities that the trainee has. Coded according to the HESA disability field
Example:
58
itt_aim
-
string (limited to 3 characters), required
The general qualification aim of the course in terms of qualifications and professional statuses. Possible values:
201
- Professional status only202
- Both professional status and academic award
Example:
201
training_route
-
string (limited to 2 characters), required
The training route that the trainee is on.
Possible values:
02
- School Direct tuition fee03
- School Direct salaried09
- Undergraduate Opt-in10
- Postgraduate teaching apprenticeship11
- Primary and Secondary Undergraduate Fee Funded12
- Primary and Secondary Postgraduate Fee Funded14
- Teacher Degree Apprenticeship
Example:
11
itt_qualification_aim
-
string (limited to 3 characters), required if
itt_aim
is202
The qualification aim of the trainee’s course. Possible values:
007
- BA008
- BA (Hons)001
- BEd002
- BEd (Hons)003
- BSc004
- BSc (Hons)020
- Postgraduate Certificate in Education021
- Postgraduate Diploma in Educatio028
- Undergraduate Master of Teaching031
- Professional Graduate Certificate in Education032
- Masters, not by research
Example:
004
course_subject_one
,course_subject_two
,course_subject_three
-
string (limited to 6 characters),
course_subject_one
is requiredThe subjects included in the trainee’s course. The first subject is the main one. It represents the bursary or scholarship available if applicable. Coded according to the HESA subject of ITT course field.
Note: For primary education courses (when the course maximum age is 11 or below),
course_subject_one
is automatically set to "Primary Teaching" (HESA code100511
). Any subjects provided in the request will be preserved and shifted tocourse_subject_two
andcourse_subject_three
as needed.Example:
100425
study_mode
-
string (limited to 2 characters), required
This indicates whether the trainee’s course is full-time or part-time. Possible values:
01
- Full-time according to funding council definitions02
- Other full-time31
- Part-time63
- Dormant - previously full-time64
- Dormant - previously part-time
Example:
01
itt_start_date
-
string, required (must not be more than one year in the future)
The start date of the Initial Teacher Training part of their course.
Example:
2024-03-11
itt_end_date
-
string, required
The end date of the Initial Teacher Training part of their course. Includes planned assessment periods, or planned writing-up periods. Update this field if there’s a change, for example, resits, agreed breaks or transferring between courses.
Example:
2025-03-11
course_year
-
string (limited to 2 characters), required
The year number of the course that the trainee is currently studying. Possible values:
0
- Foundation year1
- First year2
- Second year3
- Third year
Example:
2
course_min_age
-
integer
The lower bound of the age range of children taught on the course (read-only).
Example:
7
course_max_age
-
integer
The upper bound of the age range of children taught on the course (read-only).
Example:
11
course_age_range
-
string (limited to 5 characters), required
The age range of children taught on the course. Coded according to the HESA ITT phase/scope field
Example:
13918
The following values are invalid for this field:
99801
- Teacher training qualification: Further education/Higher education99803
- Teacher training qualification: Other
lead_partner_urn
-
string (limited to 6 characters)
The Unique Reference Number (URN) of the lead partner for the trainee. Other possible values:
900000
- Establishment outside England and Wales900020
- Other establishment without a URN900030
- Not available
Note: The system validates the provided URN against the Register database. If the URN is not found in Register, the request will not return an error but the lead partner association may not be established correctly.
Example:
123456
lead_partner_ukprn
-
string (limited to 8 characters)
The UK Provider Reference Number (UKPRN) of the lead partner for the trainee. If
lead_partner_urn
andlead_partner_ukprn
are both provided, thelead_partner_urn
will be used.Example:
12345678
trainee_start_date
-
string (must be in the past and not more than 10 years ago)
The start date of the trainee on their ITT course.
Note: If
trainee_start_date
is not provided, it will be automatically set to the value ofitt_start_date
. Thetrainee_start_date
is validated to ensure it is not more than 10 years in the past, and cannot be in the future unless it matchesitt_start_date
.Example:
2024-03-11
pg_apprenticeship_start_date
-
string
The start date of a trainee’s postgraduate teaching apprenticeship.
Example:
2024-03-11
employing_school_urn
-
string (limited to 6 characters)
The Unique Reference Number (URN) of the employing school for School Direct salaried trainees.
Example:
123456
900000
- Establishment outside England and Wales900020
- Other establishment without a URN900030
- Not available
fund_code
-
string (limited to 1 characters), required
Possible values:
2
- not eligible for student finance7
- eligible for student finance
Note: Use
7
if the trainee chooses not to receive the finance they are eligible for.Example:
7
funding_method
-
string (limited to 1 characters), required
The bursary level awarded to the trainee. Possible values:
4
- Scholarship6
- No bursary, scholarship or grant awardedB
- Undergraduate bursaryC
- Veteran Teaching undergraduate bursaryD
- Postgraduate bursaryE
- Grant
Example:
4
training_initiative
-
string (limited to 3 characters)
This field identifies students who are part of a specific scheme that is to be monitored independently. Valid entries will change from year to year to reflect current schemes. Possible values:
001
- Abridged ITT course009
- Maths and Physics Chairs Programme011
- Primary mathematics specialist019
- Additional ITT place for PE with a priority subject025
- Transition to Teach026
- Now Teach036
- International relocation payment
Example:
026
additional_training_initiative
-
string (limited to 3 characters)
The secondary training initiative that the trainee is on. Coded according to the HESA initiatives field
Example:
025
hesa_id
-
string (must be 13 or 17 characters), required
The HESA unique student identifier for the trainee.
Example:
12100071451234560
ni_number
-
string (limited to 9 characters)
The trainee’s National Insurance number.
Example:
BX5867459C
reinstate_date
-
date
The trainee’s reinstate date. (read-only)
Example:
2023-10-01
course_education_phase
-
string
The trainee’s course education phase. (read-only)
Example:
primary
record_source
-
string
The trainee’s record source. (read-only)
Possible values:
manual
api
csv
hesa
apply
dttp
state
-
string
The trainee’s record state. (read-only)
Possible values:
draft
submitted_for_trn
trn_received
recommended_for_award
withdrawn
deferred
awarded