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). Coded according to the HESA provider’s own identifier for student field.

  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

  The date of birth of the trainee. Coded according to the HESA date of birth field

  Example: 2000-01-01

• sex:

  string (limited to 2 characters), required

  The sex of the trainee. Coded according to the HESA sex identifier field

  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

  The email address of the trainee. Coded according to the HESA email addresses field

  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 and ethnic_group will be set based on the ethnicity value.

  Example: 120

• disability1 to disability9:

  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. Coded according to the HESA ITT qualification aim field

  Example: 201

• training_route:

  string (limited to 2 characters), required

  The training route that the trainee is on.

  Possible values:

  • 02 - School Direct tuition fee
  • 03 - School Direct salaried
  • 09 - Undergraduate Opt-in
  • 10 - Postgraduate teaching apprenticeship
  • 11 - Primary and Secondary Undergraduate Fee Funded
  • 12 - Primary and Secondary Postgraduate Fee Funded
  • 14 - Teacher Degree Apprenticeship

  Example: 11

• itt_qualification_aim:

  string (limited to 3 characters), required if itt_aim is 202

  The qualification aim of the trainee’s course. Coded according to the HESA qualification aim field.

  Example: 004

• course_subject_one, course_subject_two, course_subject_three:

  string (limited to 6 characters), course_subject_one is required

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

  Example: 100425

• study_mode:

  string (limited to 2 characters), required

  This indicates whether the trainee’s course is full-time or part-time. Coded according to the HESA mode of study field.

  Example: 01

• itt_start_date:

  string, required

  The start date of the Initial Teacher Training part of their course. Dates should be in ISO 8601 format.

  Example: 2024-03-11

• itt_end_date:

  string, required

  The end date of the Initial Teacher Training part of their course. Dates should be in ISO 8601 format.

  Example: 2025-03-11

• course_year:

  string (limited to 2 characters), required

  The year number of the course that the trainee is currently studying. Coded according to the HESA year of course field

  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 HESA values are invalid for this field:

  • 99801 - Teacher training qualification: Further education/Higher education
  • 99803 - Teacher training qualification: Other

• lead_partner_urn:

  string (limited to 6 characters)

  The Unique Reference Number (URN) of the lead partner for the trainee.

  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 and lead_partner_ukprn are both provided, the lead_partner_urn will be used.

  Example: 12345678

• trainee_start_date:

  string

  The start date of the trainee on their ITT course. Dates should be in ISO 8601 format.

  Example: 2024-03-11

• pg_apprenticeship_start_date:

  string

  The start date of a trainee’s postgraduate teaching apprenticeship. Dates should be in ISO 8601 format.

  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

• fund_code:

  string (limited to 1 characters), required

  The funding eligibility of the trainee. Coded according to the HESA fundability code field

  Example: 7

• funding_method:

  string (limited to 1 characters), required

  The bursary level awarded to the trainee. Coded according to the HESA bursary level award field

  Example: 4

• training_initiative:

  string (limited to 3 characters)

  The main training initiative that the trainee is on. Coded according to the HESA initiatives field

  Example: 009

• 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 (limited to 17 characters), required

  The HESA unique student identifier for the trainee. Coded according to the HESA unique student identifier field

  Example: 1210007145123456

• 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