Skip to main content

Lead provider API - 2.0.0

The lead provider API for DfE’s manage teacher CPD service

Base URLs

GET /api/v2/npq-applications

Retrieve multiple NPQ applications

Parameters

Parameter In Type Required Description Example
filter query object false

Refine NPQ applications to return.

This consumes a ListFilter schema.

filter[cohort]=2022&filter[updated_since]=2020-11-13T11:21:55Z
page query object false

Pagination options to navigate through the list of NPQ applications.

This consumes a Pagination schema.

page[page]=1&page[per_page]=5

Responses

Status Description
200

A list of NPQ applications

This response returns a MultipleNPQApplicationsResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A list of NPQ applications

This response returns a MultipleNPQApplicationsResponse schema. 

{
  "data": [
    {
      "id": "db3a7848-7308-4879-942a-c4a70ced400a",
      "type": "npq_application",
      "attributes": {
        "course_identifier": "npq-leading-teaching-development",
        "email": "isabelle.macdonald2@some-school.example.com",
        "email_validated": true,
        "employer_name": null,
        "employment_role": null,
        "full_name": "Isabelle MacDonald",
        "funding_choice": null,
        "headteacher_status": null,
        "ineligible_for_funding_reason": null,
        "participant_id": "53847955-7cfg-41eb-a322-96c50adc742b",
        "private_childcare_provider_urn": null,
        "teacher_reference_number": "0743795",
        "teacher_reference_number_validated": true,
        "school_urn": "123456",
        "school_ukprn": "12345678",
        "status": "pending",
        "works_in_school": true,
        "created_at": "2022-07-06T10:47:24Z",
        "updated_at": "2022-11-24T17:09:37Z",
        "cohort": "2022",
        "eligible_for_funding": true,
        "funded_place": true,
        "targeted_delivery_funding_eligibility": false,
        "teacher_catchment": true,
        "teacher_catchment_iso_country_code": "GBR",
        "teacher_catchment_country": "United Kingdom of Great Britain and Northern Ireland",
        "itt_provider": null,
        "lead_mentor": false
      }
    }
  ]
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

GET /api/v2/npq-applications.csv

Retrieve all NPQ applications in CSV format

Parameters

Parameter In Type Required Description Example
filter query object false

Refine NPQ applications to return.

This consumes a ListFilter schema.

updated_since=2020-11-13T11:21:55Z

Responses

Status Description
200

A CSV file of NPQ application

This response returns a MultipleNPQApplicationsCsvResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A CSV file of NPQ application

This response returns a MultipleNPQApplicationsCsvResponse schema.

401 - Unauthorized

This response returns a UnauthorisedResponse schema.

GET /api/v2/npq-applications/{id}

Get a single NPQ application

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the NPQ application.

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Responses

Status Description
200

A single NPQ application

This response returns a NPQApplicationResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A single NPQ application

This response returns a NPQApplicationResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "npq_application",
    "attributes": {
      "course_identifier": "npq-leading-teaching",
      "email": "isabelle.macdonald2@some-school.example.com",
      "email_validated": true,
      "employer_name": "Some Company Ltd",
      "employment_role": "Director",
      "full_name": "Isabelle MacDonald",
      "funding_choice": "trust",
      "headteacher_status": "no",
      "ineligible_for_funding_reason": "establishment-ineligible",
      "participant_id": "7a8fef46-3c43-42c0-b3d5-1ba5904ba562",
      "private_childcare_provider_urn": "EY944860",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "school_urn": "106286",
      "school_ukprn": "10079319",
      "status": "pending",
      "works_in_school": true,
      "created_at": "2021-05-31T02:21:32.000Z",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "cohort": "2022",
      "eligible_for_funding": true,
      "funded_place": true,
      "targeted_delivery_funding_eligibility": true,
      "teacher_catchment": true,
      "teacher_catchment_country": "France",
      "teacher_catchment_iso_country_code": "FRA",
      "itt_provider": "University of Southampton",
      "lead_mentor": true
    }
  }
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

POST /api/v2/npq-applications/{id}/accept

Accept an NPQ application

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the NPQ application to accept.

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a NPQApplicationAcceptRequest schema.

Request example

{
  "data": {
    "type": "npq-application-accept",
    "attributes": {
      "funded_place": true
    }
  }
}

Responses

Status Description
200

The NPQ application being accepted

This response returns a NPQApplicationResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - The NPQ application being accepted

This response returns a NPQApplicationResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "npq_application",
    "attributes": {
      "course_identifier": "npq-leading-teaching",
      "email": "isabelle.macdonald2@some-school.example.com",
      "email_validated": true,
      "employer_name": "Some Company Ltd",
      "employment_role": "Director",
      "full_name": "Isabelle MacDonald",
      "funding_choice": "trust",
      "headteacher_status": "no",
      "ineligible_for_funding_reason": "establishment-ineligible",
      "participant_id": "7a8fef46-3c43-42c0-b3d5-1ba5904ba562",
      "private_childcare_provider_urn": "EY944860",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "school_urn": "106286",
      "school_ukprn": "10079319",
      "status": "pending",
      "works_in_school": true,
      "created_at": "2021-05-31T02:21:32.000Z",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "cohort": "2022",
      "eligible_for_funding": true,
      "funded_place": true,
      "targeted_delivery_funding_eligibility": true,
      "teacher_catchment": true,
      "teacher_catchment_country": "France",
      "teacher_catchment_iso_country_code": "FRA",
      "itt_provider": "University of Southampton",
      "lead_mentor": true
    }
  }
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

POST /api/v2/npq-applications/{id}/reject

Reject an NPQ application

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the NPQ application to reject.

 14b1b4ab-fa81-4f7a-b4b5-f632412e8c5c

Responses

Status Description
200

The NPQ application being rejected

This response returns a NPQApplicationResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - The NPQ application being rejected

This response returns a NPQApplicationResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "npq_application",
    "attributes": {
      "course_identifier": "npq-leading-teaching",
      "email": "isabelle.macdonald2@some-school.example.com",
      "email_validated": true,
      "employer_name": "Some Company Ltd",
      "employment_role": "Director",
      "full_name": "Isabelle MacDonald",
      "funding_choice": "trust",
      "headteacher_status": "no",
      "ineligible_for_funding_reason": "establishment-ineligible",
      "participant_id": "7a8fef46-3c43-42c0-b3d5-1ba5904ba562",
      "private_childcare_provider_urn": "EY944860",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "school_urn": "106286",
      "school_ukprn": "10079319",
      "status": "pending",
      "works_in_school": true,
      "created_at": "2021-05-31T02:21:32.000Z",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "cohort": "2022",
      "eligible_for_funding": true,
      "funded_place": true,
      "targeted_delivery_funding_eligibility": true,
      "teacher_catchment": true,
      "teacher_catchment_country": "France",
      "teacher_catchment_iso_country_code": "FRA",
      "itt_provider": "University of Southampton",
      "lead_mentor": true
    }
  }
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

PUT /api/v2/npq-applications/{id}/change-funded-place

Change funded place

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the NPQ application to change funded place.

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a ChangeFundedPlaceRequest schema.

Request example

{
  "data": {
    "type": "npq-application-change-funded-place",
    "attributes": {
      "funded_place": true
    }
  }
}

Responses

Status Description
200

The NPQ application being accepted

This response returns a NPQApplicationResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

404

Not Found

This response returns a NotFoundResponse schema.

Response examples

200 - The NPQ application being accepted

This response returns a NPQApplicationResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "npq_application",
    "attributes": {
      "course_identifier": "npq-leading-teaching",
      "email": "isabelle.macdonald2@some-school.example.com",
      "email_validated": true,
      "employer_name": "Some Company Ltd",
      "employment_role": "Director",
      "full_name": "Isabelle MacDonald",
      "funding_choice": "trust",
      "headteacher_status": "no",
      "ineligible_for_funding_reason": "establishment-ineligible",
      "participant_id": "7a8fef46-3c43-42c0-b3d5-1ba5904ba562",
      "private_childcare_provider_urn": "EY944860",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "school_urn": "106286",
      "school_ukprn": "10079319",
      "status": "pending",
      "works_in_school": true,
      "created_at": "2021-05-31T02:21:32.000Z",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "cohort": "2022",
      "eligible_for_funding": true,
      "funded_place": true,
      "targeted_delivery_funding_eligibility": true,
      "teacher_catchment": true,
      "teacher_catchment_country": "France",
      "teacher_catchment_iso_country_code": "FRA",
      "itt_provider": "University of Southampton",
      "lead_mentor": true
    }
  }
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}
404 - Not Found

This response returns a NotFoundResponse schema. 

{
  "error": "Resource not found"
}

GET /api/v2/npq-enrolments.csv

Retrieve multiple NPQ enrolments

Parameters

Parameter In Type Required Description Example
filter query object false

Refine NPQ participants to return.

This consumes a ListFilter schema.

updated_since=2020-11-13T11:21:55Z

Responses

Status Description
200

A list of NPQ enrolments

This response returns a MultipleNPQEnrolmentsCsvResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A list of NPQ enrolments

This response returns a MultipleNPQEnrolmentsCsvResponse schema.

401 - Unauthorized

This response returns a UnauthorisedResponse schema.

GET /api/v2/participants/npq

Retrieve multiple NPQ participants

Parameters

Parameter In Type Required Description Example
filter query object false

Refine NPQ participants to return.

This consumes a ListFilter schema.

updated_since=2020-11-13T11:21:55Z
page query object false

Pagination options to navigate through the list of NPQ participants.

This consumes a Pagination schema.

page[page]=1&page[per_page]=5

Responses

Status Description
200

A list of NPQ participants

This response returns a MultipleNPQParticipantsResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A list of NPQ participants

This response returns a MultipleNPQParticipantsResponse schema. 

{
  "data": [
    {
      "id": "db3a7848-7308-4879-942a-c4a70ced400a",
      "type": "npq-participant",
      "attributes": {
        "email": "isabelle.macdonald2@some-school.example.com",
        "full_name": "Isabelle MacDonald",
        "teacher_reference_number": "1234567",
        "updated_at": "2021-05-31T02:21:32.000Z",
        "npq_enrolments": [
          {
            "course_identifier": "npq-headship",
            "schedule_identifier": "npq-leadership-autumn",
            "cohort": "2021",
            "npq_application_id": "db3a7848-7308-4879-942a-c4a70ced400a",
            "eligible_for_funding": true,
            "training_status": "active",
            "school_urn": "123456",
            "targeted_delivery_funding_eligibility": true,
            "funded_place": true
          }
        ]
      }
    }
  ]
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

GET /api/v2/participants/npq/{id}

Get a single NPQ participant

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the NPQ participant.

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Responses

Status Description
200

A single NPQ participant

This response returns a NPQParticipantResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A single NPQ participant

This response returns a NPQParticipantResponse schema. 

{
  "data": {
    "id": "ac3d1243-7308-4879-942a-c4a70ced400a",
    "type": "npq-participant",
    "attributes": {
      "email": "isabelle.macdonald2@some-school.example.com",
      "full_name": "Isabelle MacDonald",
      "teacher_reference_number": "1234567",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "npq_enrolments": [
        {
          "course_identifier": "npq-senior-leadership",
          "schedule_identifier": "npq-leadership-autumn",
          "cohort": "2021",
          "npq_application_id": "db3a7848-7308-4879-942a-c4a70ced400a",
          "eligible_for_funding": true,
          "training_status": "active",
          "school_urn": "123456",
          "targeted_delivery_funding_eligibility": true,
          "funded_place": true
        }
      ]
    }
  }
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

PUT /api/v2/participants/npq/{id}/change-schedule

Notify that an NPQ participant is changing training schedule

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a NPQParticipantChangeScheduleRequest schema.

Request example

{
  "data": {
    "type": "participant-change-schedule",
    "attributes": {
      "schedule_identifier": "npq-leadership-autumn",
      "course_identifier": "npq-leading-teaching",
      "cohort": "2021"
    }
  }
}

Responses

Status Description
200

The NPQ participant changing schedule

This response returns a NPQParticipantResponse schema.

Response examples

200 - The NPQ participant changing schedule

This response returns a NPQParticipantResponse schema. 

{
  "data": {
    "id": "ac3d1243-7308-4879-942a-c4a70ced400a",
    "type": "npq-participant",
    "attributes": {
      "email": "isabelle.macdonald2@some-school.example.com",
      "full_name": "Isabelle MacDonald",
      "teacher_reference_number": "1234567",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "npq_enrolments": [
        {
          "course_identifier": "npq-senior-leadership",
          "schedule_identifier": "npq-leadership-autumn",
          "cohort": "2021",
          "npq_application_id": "db3a7848-7308-4879-942a-c4a70ced400a",
          "eligible_for_funding": true,
          "training_status": "active",
          "school_urn": "123456",
          "targeted_delivery_funding_eligibility": true,
          "funded_place": true
        }
      ]
    }
  }
}

PUT /api/v2/participants/npq/{id}/defer

Notify that an NPQ participant is taking a break from their course

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant to defer

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a NPQParticipantDeferRequest schema.

Request example

{
  "data": {
    "type": "participant-defer",
    "attributes": {
      "reason": "parental-leave",
      "course_identifier": "npq-senior-leadership"
    }
  }
}

Responses

Status Description
200

The NPQ participant being deferred

This response returns a NPQParticipantResponse schema.

Response examples

200 - The NPQ participant being deferred

This response returns a NPQParticipantResponse schema. 

{
  "data": {
    "id": "ac3d1243-7308-4879-942a-c4a70ced400a",
    "type": "npq-participant",
    "attributes": {
      "email": "isabelle.macdonald2@some-school.example.com",
      "full_name": "Isabelle MacDonald",
      "teacher_reference_number": "1234567",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "npq_enrolments": [
        {
          "course_identifier": "npq-senior-leadership",
          "schedule_identifier": "npq-leadership-autumn",
          "cohort": "2021",
          "npq_application_id": "db3a7848-7308-4879-942a-c4a70ced400a",
          "eligible_for_funding": true,
          "training_status": "active",
          "school_urn": "123456",
          "targeted_delivery_funding_eligibility": true,
          "funded_place": true
        }
      ]
    }
  }
}

PUT /api/v2/participants/npq/{id}/resume

Notify that an NPQ participant is resuming their course

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant to resume

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a NPQParticipantResumeRequest schema.

Request example

{
  "data": {
    "type": "participant-resume",
    "attributes": {
      "course_identifier": "npq-leading-teaching-development"
    }
  }
}

Responses

Status Description
200

The NPQ participant being resumed

This response returns a NPQParticipantResponse schema.

Response examples

200 - The NPQ participant being resumed

This response returns a NPQParticipantResponse schema. 

{
  "data": {
    "id": "ac3d1243-7308-4879-942a-c4a70ced400a",
    "type": "npq-participant",
    "attributes": {
      "email": "isabelle.macdonald2@some-school.example.com",
      "full_name": "Isabelle MacDonald",
      "teacher_reference_number": "1234567",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "npq_enrolments": [
        {
          "course_identifier": "npq-senior-leadership",
          "schedule_identifier": "npq-leadership-autumn",
          "cohort": "2021",
          "npq_application_id": "db3a7848-7308-4879-942a-c4a70ced400a",
          "eligible_for_funding": true,
          "training_status": "active",
          "school_urn": "123456",
          "targeted_delivery_funding_eligibility": true,
          "funded_place": true
        }
      ]
    }
  }
}

PUT /api/v2/participants/npq/{id}/withdraw

Withdrawn a participant from a course

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant to withdraw

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a NPQParticipantWithdrawRequest schema.

Request example

{
  "data": {
    "type": "participant-withdraw",
    "attributes": {
      "reason": "quality-of-programme-other",
      "course_identifier": "npq-leading-teaching-development"
    }
  }
}

Responses

Status Description
200

The NPQ participant being withdrawn

This response returns a NPQParticipantResponse schema.

422

Unprocessable entity

This response returns a ErrorResponse schema.

Response examples

200 - The NPQ participant being withdrawn

This response returns a NPQParticipantResponse schema. 

{
  "data": {
    "id": "ac3d1243-7308-4879-942a-c4a70ced400a",
    "type": "npq-participant",
    "attributes": {
      "email": "isabelle.macdonald2@some-school.example.com",
      "full_name": "Isabelle MacDonald",
      "teacher_reference_number": "1234567",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "npq_enrolments": [
        {
          "course_identifier": "npq-senior-leadership",
          "schedule_identifier": "npq-leadership-autumn",
          "cohort": "2021",
          "npq_application_id": "db3a7848-7308-4879-942a-c4a70ced400a",
          "eligible_for_funding": true,
          "training_status": "active",
          "school_urn": "123456",
          "targeted_delivery_funding_eligibility": true,
          "funded_place": true
        }
      ]
    }
  }
}
422 - Unprocessable entity

This response returns a ErrorResponse schema. 

{
  "error": [
    {
      "title": "string",
      "detail": "string"
    }
  ]
}

GET /api/v2/participant-declarations

List all participant declarations

Parameters

Parameter In Type Required Description Example
filter query object false

Refine participant declarations to return.

This consumes a ListFilterDeclarations schema.

participant_id=ab3a7848-1208-7679-942a-b4a70eed400a&updated_since=2020-11-13T11:21:55Z
page query object false

Pagination options to navigate through the list of participant declarations.

This consumes a Pagination schema.

page[page]=1&page[per_page]=5

Responses

Status Description
200

A list of participant declarations

This response returns a MultipleParticipantDeclarationsResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A list of participant declarations

This response returns a MultipleParticipantDeclarationsResponse schema. 

{
  "data": [
    {
      "id": "01017c12-354b-4b2d-b621-3531ab729c43",
      "type": "participant-declaration",
      "attributes": {
        "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
        "declaration_type": "started",
        "declaration_date": "2021-05-31T02:21:32.000Z",
        "course_identifier": "ecf-mentor"
      }
    },
    {
      "id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "type": "participant-declaration",
      "attributes": {
        "participant_id": "ab3a7848-7308-4879-942a-c4a70ced400a",
        "declaration_type": "started",
        "declaration_date": "2021-05-31T02:21:32.000Z",
        "course_identifier": "ecf-mentor"
      }
    }
  ]
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

POST /api/v2/participant-declarations

Declare a participant has reached a milestone. Idempotent endpoint - submitting exact copy of a request will return the same response body as submitting it the first time.

Request body

This consumes a ParticipantDeclarationRequest schema.

Responses

Status Description
200

Successful

This response returns a SingleParticipantDeclarationResponse schema.

422

Bad or Missing parameter

This response returns a ErrorResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

400

Bad Request

This response returns a BadRequestResponse schema.

Response examples

200 - Successful

This response returns a SingleParticipantDeclarationResponse schema. 

{
  "data": {
    "id": "cd3a12347-7308-4879-942a-c4a70ced400a",
    "type": "participant-declaration",
    "attributes": {
      "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
      "declaration_type": "started",
      "declaration_date": "2021-05-31T02:21:32.000Z",
      "course_identifier": "ecf-induction",
      "state": "submitted",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "has_passed": true
    }
  }
}
422 - Bad or Missing parameter

This response returns a ErrorResponse schema. 

{
  "error": [
    {
      "title": "string",
      "detail": "string"
    }
  ]
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}
400 - Bad Request

This response returns a BadRequestResponse schema. 

{
  "bad_request": "string"
}

GET /api/v2/participant-declarations.csv

Retrieve all participant declarations in CSV format

Responses

Status Description
200

A CSV file of participant declarations

This response returns a MultipleParticipantDeclarationsCsvResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A CSV file of participant declarations

This response returns a MultipleParticipantDeclarationsCsvResponse schema.

401 - Unauthorized

This response returns a UnauthorisedResponse schema.

GET /api/v2/participant-declarations/{id}

Get single participant declaration

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant declaration ID

 9ed4612b-f8bd-44d9-b296-38ab103fadd2

Responses

Status Description
200

A single participant declaration

This response returns a SingleParticipantDeclarationResponse schema.

404

Not found

This response returns a NotFoundResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A single participant declaration

This response returns a SingleParticipantDeclarationResponse schema. 

{
  "data": {
    "id": "cd3a12347-7308-4879-942a-c4a70ced400a",
    "type": "participant-declaration",
    "attributes": {
      "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
      "declaration_type": "started",
      "declaration_date": "2021-05-31T02:21:32.000Z",
      "course_identifier": "ecf-induction",
      "state": "submitted",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "has_passed": true
    }
  }
}
404 - Not found

This response returns a NotFoundResponse schema. 

{
  "error": "Resource not found"
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

PUT /api/v2/participant-declarations/{id}/void

Void a declaration - it will not be soft-deleted

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the declaration to void

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Responses

Status Description
200

Successful

This response returns a SingleParticipantDeclarationResponse schema.

Response examples

200 - Successful

This response returns a SingleParticipantDeclarationResponse schema. 

{
  "data": {
    "id": "cd3a12347-7308-4879-942a-c4a70ced400a",
    "type": "participant-declaration",
    "attributes": {
      "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
      "declaration_type": "started",
      "declaration_date": "2021-05-31T02:21:32.000Z",
      "course_identifier": "ecf-induction",
      "state": "submitted",
      "updated_at": "2021-05-31T02:22:32.000Z",
      "has_passed": true
    }
  }
}

GET /api/v2/participants/npq/outcomes

List all participant NPQ outcomes

Parameters

Parameter In Type Required Description Example
filter query object false

Refine participant outcomes to return.

This consumes a NPQOutcomeFilter schema.

filter[created_since]=2020-11-13T11:21:55Z
page query object false

Pagination options to navigate through the list of participant NPQ outcomes.

This consumes a Pagination schema.

page[page]=1&page[per_page]=5

Responses

Status Description
200

A list of participant outcomes

This response returns a NPQOutcomesResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A list of participant outcomes

This response returns a NPQOutcomesResponse schema. 

{
  "data": [
    {
      "id": "cd3a12347-7308-4879-942a-c4a70ced400a",
      "type": "participant-outcome",
      "attributes": {
        "participant_id": "66218835-9430-4d0c-98ef-7caf0bb4a59b",
        "course_identifier": "npq-leading-teaching",
        "state": "passed",
        "completion_date": "2021-05-31",
        "created_at": "2021-05-31T02:21:32.000Z"
      }
    }
  ]
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

GET /api/v2/participants/npq/{participant_id}/outcomes

List NPQ outcomes for single participant

Parameters

Parameter In Type Required Description Example
participant_id path string true

The external ID of the participant

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Responses

Status Description
200

A list of participant outcomes

This response returns a NPQOutcomesResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A list of participant outcomes

This response returns a NPQOutcomesResponse schema. 

{
  "data": [
    {
      "id": "cd3a12347-7308-4879-942a-c4a70ced400a",
      "type": "participant-outcome",
      "attributes": {
        "participant_id": "66218835-9430-4d0c-98ef-7caf0bb4a59b",
        "course_identifier": "npq-leading-teaching",
        "state": "passed",
        "completion_date": "2021-05-31",
        "created_at": "2021-05-31T02:21:32.000Z"
      }
    }
  ]
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

POST /api/v2/participants/npq/{participant_id}/outcomes

Submit a NPQ outcome for a single participant

Parameters

Parameter In Type Required Description Example
participant_id path string true

The unique ID of the participant

 70885c85-f52b-45fe-b969-e09a93ffc6ee

Request body

This consumes a NPQOutcomeRequest schema.

Request example

{
  "data": {
    "type": "npq-outcome-confirmation",
    "attributes": {
      "course_identifier": "npq-leading-teaching",
      "state": "passed",
      "completion_date": "2021-05-31"
    }
  }
}

Responses

Status Description
200

Successfully submit a NPQ outcome

This response returns a NPQOutcomeResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - Successfully submit a NPQ outcome

This response returns a NPQOutcomeResponse schema. 

{
  "data": {
    "id": "cd3a12347-7308-4879-942a-c4a70ced400a",
    "type": "participant-outcome",
    "attributes": {
      "participant_id": "66218835-9430-4d0c-98ef-7caf0bb4a59b",
      "course_identifier": "npq-leading-teaching",
      "state": "passed",
      "completion_date": "2021-05-31",
      "created_at": "2021-05-31T02:21:32.000Z"
    }
  }
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

GET /api/v2/participants/ecf

Retrieve multiple participants, replaces /api/v2/participants

Parameters

Parameter In Type Required Description Example
filter query object false

Refine ECF participants to return.

This consumes a ListFilter schema.

filter[cohort]=2022&filter[updated_since]=2020-11-13T11:21:55Z
page query object false

Pagination options to navigate through the list of ECF participants.

This consumes a Pagination schema.

page[page]=1&page[per_page]=5

Responses

Status Description
200

A list of ECF participants

This response returns a MultipleECFParticipantsResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A list of ECF participants

This response returns a MultipleECFParticipantsResponse schema. 

{
  "data": [
    {
      "id": "db3a7848-7308-4879-942a-c4a70ced400a",
      "type": "participant",
      "attributes": {
        "email": "jane.smith@some-school.example.com",
        "full_name": "Jane Smith",
        "mentor_id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
        "school_urn": "106286",
        "participant_type": "ect",
        "cohort": "2021",
        "status": "active",
        "teacher_reference_number": "0012345",
        "teacher_reference_number_validated": true,
        "eligible_for_funding": true,
        "pupil_premium_uplift": false,
        "sparsity_uplift": true,
        "training_status": "active",
        "updated_at": "2021-05-31T02:22:32.000Z"
      }
    },
    {
      "id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "type": "participant",
      "attributes": {
        "email": "martin.jones@some-school.example.com",
        "full_name": "Martin jones",
        "school_urn": "106286",
        "participant_type": "mentor",
        "cohort": "2021",
        "status": "active",
        "teacher_reference_number": null,
        "teacher_reference_number_validated": false,
        "eligible_for_funding": null,
        "pupil_premium_uplift": true,
        "sparsity_uplift": false,
        "training_status": "deferred",
        "updated_at": "2021-05-31T02:22:32.000Z"
      }
    },
    {
      "id": "eb475531-bf08-48ae-b0ef-c2ff5e5bdef0",
      "type": "participant",
      "attributes": {
        "email": "null,",
        "full_name": null,
        "mentor_id": null,
        "school_urn": null,
        "participant_type": null,
        "cohort": null,
        "status": "withdrawn",
        "teacher_reference_number": null,
        "teacher_reference_number_validated": null,
        "eligible_for_funding": null,
        "pupil_premium_uplift": null,
        "sparsity_uplift": null,
        "training_status": "withdrawn",
        "updated_at": "2021-05-31T02:22:32.000Z"
      }
    }
  ]
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

GET /api/v2/participants/ecf.csv

Retrieve all participants in CSV format, replaces /api/v2/participants.csv

Parameters

Parameter In Type Required Description Example
filter query object false

Refine ECF participants to return.

This consumes a ListFilter schema.

updated_since=2020-11-13T11:21:55Z

Responses

Status Description
200

A CSV file of ECF participants

This response returns a MultipleECFParticipantsCsvResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A CSV file of ECF participants

This response returns a MultipleECFParticipantsCsvResponse schema.

401 - Unauthorized

This response returns a UnauthorisedResponse schema.

GET /api/v2/participants/ecf/{id}

Get a single ECF participant

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the ECF participant.

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Responses

Status Description
200

A single ECF participant

This response returns a ECFParticipantResponse schema.

401

Unauthorized

This response returns a UnauthorisedResponse schema.

Response examples

200 - A single ECF participant

This response returns a ECFParticipantResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "participant",
    "attributes": {
      "email": "jane.smith@some-school.example.com",
      "full_name": "Jane Smith",
      "mentor_id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "school_urn": "106286",
      "participant_type": "ect",
      "cohort": "2021",
      "status": "active",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "eligible_for_funding": true,
      "pupil_premium_uplift": true,
      "sparsity_uplift": true,
      "training_status": "active",
      "training_record_id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "schedule_identifier": "ecf-standard-january",
      "updated_at": "2021-05-31T02:22:32.000Z"
    }
  }
}
401 - Unauthorized

This response returns a UnauthorisedResponse schema. 

{
  "error": "HTTP Token: Access denied"
}

PUT /api/v2/participants/ecf/{id}/defer

Notify that an ECF participant is taking a break from their course

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant to defer

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a ECFParticipantDeferRequest schema.

Request example

{
  "data": {
    "type": "participant-defer",
    "attributes": {
      "reason": "career-break",
      "course_identifier": "ecf-mentor"
    }
  }
}

Responses

Status Description
200

The ECF participant being deferred

This response returns a ECFParticipantDeferResponse schema.

Response examples

200 - The ECF participant being deferred

This response returns a ECFParticipantDeferResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "participant",
    "attributes": {
      "email": "jane.smith@some-school.example.com",
      "full_name": "Jane Smith",
      "mentor_id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "school_urn": "106286",
      "participant_type": "ect",
      "cohort": "2021",
      "status": "active",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "eligible_for_funding": true,
      "pupil_premium_uplift": true,
      "sparsity_uplift": true,
      "training_status": "deferred",
      "schedule_identifier": "ecf-standard-january",
      "updated_at": "2021-05-31T02:22:32.000Z"
    }
  }
}

PUT /api/v2/participants/ecf/{id}/resume

Notify that an ECF participant is resuming their course

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant to resume

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a ECFParticipantResumeRequest schema.

Request example

{
  "data": {
    "type": "participant-resume",
    "attributes": {
      "course_identifier": "ecf-mentor"
    }
  }
}

Responses

Status Description
200

The ECF participant being resumed

This response returns a ECFParticipantResumeResponse schema.

Response examples

200 - The ECF participant being resumed

This response returns a ECFParticipantResumeResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "participant",
    "attributes": {
      "email": "jane.smith@some-school.example.com",
      "full_name": "Jane Smith",
      "mentor_id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "school_urn": "106286",
      "participant_type": "ect",
      "cohort": "2021",
      "status": "active",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "eligible_for_funding": true,
      "pupil_premium_uplift": true,
      "sparsity_uplift": true,
      "training_status": "active",
      "schedule_identifier": "ecf-standard-january",
      "updated_at": "2021-05-31T02:22:32.000Z"
    }
  }
}

PUT /api/v2/participants/ecf/{id}/withdraw

Notify that an ECF participant has withdrawn from their course

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant to withdraw

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a ECFParticipantWithdrawRequest schema.

Request example

{
  "data": {
    "type": "participant-withdraw",
    "attributes": {
      "reason": "left-teaching-profession",
      "course_identifier": "ecf-mentor"
    }
  }
}

Responses

Status Description
200

The ECF participant being withdrawn

This response returns a ECFParticipantWithdrawResponse schema.

Response examples

200 - The ECF participant being withdrawn

This response returns a ECFParticipantWithdrawResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "participant",
    "attributes": {
      "email": "jane.smith@some-school.example.com",
      "full_name": "Jane Smith",
      "mentor_id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "school_urn": "106286",
      "participant_type": "ect",
      "cohort": "2021",
      "status": "active",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "eligible_for_funding": true,
      "pupil_premium_uplift": true,
      "sparsity_uplift": true,
      "training_status": "withdrawn",
      "schedule_identifier": "ecf-standard-january",
      "updated_at": "2021-05-31T02:22:32.000Z"
    }
  }
}

PUT /api/v2/participants/ecf/{id}/change-schedule

Notify that an ECF participant is changing training schedule

Parameters

Parameter In Type Required Description Example
id path string true

The ID of the participant

 28c461ee-ffc0-4e56-96bd-788579a0ed75

Request body

This consumes a ECFParticipantChangeScheduleRequest schema.

Request example

{
  "data": {
    "type": "participant-change-schedule",
    "attributes": {
      "schedule_identifier": "ecf-standard-january",
      "course_identifier": "ecf-mentor",
      "cohort": "2021"
    }
  }
}

Responses

Status Description
200

The ECF participant changing schedule

This response returns a ECFParticipantResponse schema.

Response examples

200 - The ECF participant changing schedule

This response returns a ECFParticipantResponse schema. 

{
  "data": {
    "id": "db3a7848-7308-4879-942a-c4a70ced400a",
    "type": "participant",
    "attributes": {
      "email": "jane.smith@some-school.example.com",
      "full_name": "Jane Smith",
      "mentor_id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "school_urn": "106286",
      "participant_type": "ect",
      "cohort": "2021",
      "status": "active",
      "teacher_reference_number": "1234567",
      "teacher_reference_number_validated": true,
      "eligible_for_funding": true,
      "pupil_premium_uplift": true,
      "sparsity_uplift": true,
      "training_status": "active",
      "training_record_id": "bb36d74a-68a7-47b6-86b6-1fd0d141c590",
      "schedule_identifier": "ecf-standard-january",
      "updated_at": "2021-05-31T02:22:32.000Z"
    }
  }
}

Schemas

BadOrMissingParametersResponse

Request was missing data or contained invalid data

Name Type Required Description
bad_or_missing_parameters array true

An error message for each bad or missing attribute describing the problems

BadRequestResponse

Bad Request

Name Type Required Description
bad_request string false

An error message for bad request

Example

{
  "errors": [
    {
      "title": "Bad request",
      "detail": "correct json data structure required. See API docs for reference"
    }
  ]
}

ChangeFundedPlaceAttributesRequest

The NPQ Application acceptance request

Name Type Required Description
funded_place boolean false

Whether the participant has a funded place

ChangeFundedPlaceDataRequest

The NPQ Application change funded place request attributes

Name Type Required Description
type string true

The data type
data object true

The NPQ Application acceptance request

It conforms to ChangeFundedPlaceAttributesRequest schema.

ChangeFundedPlaceRequest

The NPQ Application change funded place request

Name Type Required Description
data object false

The NPQ Application change funded place request attributes

It conforms to ChangeFundedPlaceDataRequest schema.

Example

{
  "data": {
    "type": "npq-application-change-funded-place",
    "attributes": {
      "funded_place": true
    }
  }
}

ECFParticipant

The details of a participant

Name Type Required Description
id string true

The unique identifier of the participant record
type string true

The data type
attributes object true

The data attributes associated with an ECF participant

It conforms to ECFParticipantAttributes schema.

ECFParticipantAttributes

The data attributes associated with an ECF participant

Name Type Required Description
email string true

The email address registered for this ECF participant
full_name string true

The full name of this ECF participant
mentor_id string false

The unique identifier of this ECF participants mentor
school_urn string true

The Unique Reference Number (URN) of the school that submitted this ECF participant
participant_type string true

The type of ECF participant this record refers to

Possible values:

  • ect
  • mentor
cohort string true

Indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year.
status string true

The status of this ECF participant record

Possible values:

  • active
  • withdrawn
teacher_reference_number string false

The Teacher Reference Number (TRN) for this ECF participant
teacher_reference_number_validated boolean false

Indicates whether the Teacher Reference Number (TRN) has been validated
eligible_for_funding boolean false

Indicates whether this participant is eligible to receive DfE funded induction
pupil_premium_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to pupil premium
sparsity_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to sparsity
training_status string true

The training status of the ECF participant

Possible values:

  • active
  • deferred
  • withdrawn
training_record_id string true

The unique identifier of the participant training record
schedule_identifier string true

The schedule of the ECF participant

Possible values:

  • ecf-standard-september
  • ecf-standard-january
  • ecf-standard-april
  • ecf-reduced-september
  • ecf-reduced-january
  • ecf-reduced-april
  • ecf-extended-september
  • ecf-extended-january
  • ecf-extended-april
  • ecf-replacement-september
  • ecf-replacement-january
  • ecf-replacement-april
updated_at string true

The date the ECF participant was last updated

ECFParticipantChangeSchedule

An ECF participant change schedule action

Name Type Required Description
type string true

The data type

Possible values:

  • participant-change-schedule
attributes object true

An ECF participant change schedule action

It conforms to ECFParticipantChangeScheduleAttributes schema.

Example

{
  "type": "participant-change-schedule",
  "attributes": {
    "schedule_identifier": "ecf-standard-january",
    "course_identifier": "ecf-mentor"
  }
}

ECFParticipantChangeScheduleAttributes

An ECF participant change schedule action

Name Type Required Description
schedule_identifier string true

The new schedule of the participant

Possible values:

  • ecf-standard-september
  • ecf-standard-january
  • ecf-standard-april
  • ecf-reduced-september
  • ecf-reduced-january
  • ecf-reduced-april
  • ecf-extended-september
  • ecf-extended-january
  • ecf-extended-april
  • ecf-replacement-september
  • ecf-replacement-january
  • ecf-replacement-april
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor
cohort string false

Providers may not change the current value for ECF participants. Indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year.

Example

{
  "schedule_identifier": "ecf-standard-january",
  "course_identifier": "ecf-mentor",
  "cohort": "2021"
}

ECFParticipantChangeScheduleRequest

The change schedule request for a participant

Name Type Required Description
data object true

An ECF participant change schedule action

It conforms to ECFParticipantChangeSchedule schema.

Example

{
  "data": {
    "type": "participant-change-schedule",
    "attributes": {
      "schedule_identifier": "ecf-standard-january",
      "course_identifier": "ecf-mentor",
      "cohort": "2021"
    }
  }
}

ECFParticipantCsvRow

The details of an ECF participant

Name Type Required Description
id string true

The unique identifier of the ECF participant record
type string true

The data type

Possible values:

  • participant
email string true

The email registered for this ECF participant
full_name string true

The full name of the ECF participant
mentor_id string false

The unique identifier of the ECF participants mentor
school_urn string true

The Unique Reference Number (URN) of the school the submitted this ECF participant
participant_type string true

The type of ECF Participant this record refers to either ECT or Mentor

Possible values:

  • ect
  • mentor
cohort string true

Indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year.
status string true

The status of the ECF Participant record

Possible values:

  • active
  • withdrawn
teacher_reference_number string false

The Teacher Reference Number (TRN) for this ECF participant
teacher_reference_number_validated boolean false

Indicates whether the Teacher Reference Number (TRN) has been validated
eligible_for_funding boolean false

Indicates whether this participant is eligible to receive DfE funded induction
pupil_premium_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to pupil premium
sparsity_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to sparsity
training_status string true

The training status of the ECF Participant

Possible values:

  • active
  • deferred
  • withdrawn
training_record_id string true

The unique identifier of the participant training record
schedule_identifier string true

The schedule of the ECF participant

Possible values:

  • ecf-standard-september
  • ecf-standard-january
  • ecf-standard-april
  • ecf-reduced-september
  • ecf-reduced-january
  • ecf-reduced-april
  • ecf-extended-september
  • ecf-extended-january
  • ecf-extended-april
  • ecf-replacement-september
  • ecf-replacement-january
  • ecf-replacement-april
updated_at string true

The date the ECF participant was last updated

ECFParticipantDeclarationCompletedAttributesRequest

An ECF completed participant declaration

Name Type Required Description
participant_id string true

The unique ID of the participant
declaration_type string true

The event declaration type

Possible values:

  • completed
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor
evidence_held string true

The type of evidence that the lead provider holds on their platform to demonstrate that the participant has met the retention criteria for the current milestone period

Possible values:

  • training-event-attended
  • self-study-material-completed
  • other

ECFParticipantDeclarationExtendedAttributesRequest

An ECF extended participant declaration

Name Type Required Description
participant_id string true

The unique ID of the participant
declaration_type string true

The event declaration type

Possible values:

  • extended-1
  • extended-2
  • extended-3
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor
evidence_held string true

The type of evidence that the lead provider holds on their platform to demonstrate that the participant has met the retention criteria for the current milestone period

Possible values:

  • training-event-attended
  • self-study-material-completed
  • other

ECFParticipantDeclarationRetainedAttributesRequest

An ECF participant retained declaration

Name Type Required Description
participant_id string true

The unique ID of the participant
declaration_type string true

The event declaration type

Possible values:

  • retained-1
  • retained-2
  • retained-3
  • retained-4
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor
evidence_held string true

The type of evidence that the lead provider holds on their platform to demonstrate that the participant has met the retention criteria for the current milestone period

Possible values:

  • training-event-attended
  • self-study-material-completed
  • other

ECFParticipantDeclarationStartedAttributesRequest

An ECF started participant declaration

Name Type Required Description
participant_id string true

The unique ID of the participant
declaration_type string true

The event declaration type

Possible values:

  • started
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor

ECFParticipantDefer

The details of a participant deferral request

Name Type Required Description
type string true

The data type

Possible values:

  • participant-defer
attributes object true

An ECF participant deferral action

It conforms to ECFParticipantDeferAttributes schema.

ECFParticipantDeferAttributes

An ECF participant deferral action

Name Type Required Description
reason string true

The reason for the deferral

Possible values:

  • bereavement
  • long-term-sickness
  • parental-leave
  • career-break
  • other
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor

Example

{
  "reason": "career-break",
  "course_identifier": "ecf-mentor"
}

ECFParticipantDeferAttributesResponse

The data attributes associated with an ECF participant

Name Type Required Description
email string true

The email address registered for this ECF participant
full_name string true

The full name of this ECF participant
mentor_id string false

The unique identifier of this ECF participants mentor
school_urn string true

The Unique Reference Number (URN) of the school that submitted this ECF participant
participant_type string true

The type of ECF participant this record refers to

Possible values:

  • ect
  • mentor
cohort string true

Indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year.
status string true

The status of this ECF participant record

Possible values:

  • active
  • withdrawn
teacher_reference_number string false

The Teacher Reference Number (TRN) for this ECF participant
teacher_reference_number_validated boolean false

Indicates whether the Teacher Reference Number (TRN) has been validated
eligible_for_funding boolean false

Indicates whether this participant is eligible to receive DfE funded induction
pupil_premium_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to pupil premium
sparsity_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to sparsity
training_status string true

The training status of the ECF participant

Possible values:

  • active
  • deferred
  • withdrawn
schedule_identifier string true

The schedule of the ECF participant

Possible values:

  • ecf-standard-september
  • ecf-standard-january
  • ecf-standard-april
  • ecf-reduced-september
  • ecf-reduced-january
  • ecf-reduced-april
  • ecf-extended-september
  • ecf-extended-january
  • ecf-extended-april
  • ecf-replacement-september
  • ecf-replacement-january
  • ecf-replacement-april
updated_at string true

The date the ECF participant was last updated

ECFParticipantDeferRequest

The deferral request for a participant

Name Type Required Description
data object true

The details of a participant deferral request

It conforms to ECFParticipantDefer schema.

Example

{
  "data": {
    "type": "participant-defer",
    "attributes": {
      "reason": "career-break",
      "course_identifier": "ecf-mentor"
    }
  }
}

ECFParticipantDeferResponse

An ECF Participant

Name Type Required Description
data object true

The details of a participant

It conforms to ECFParticipantDeferResponseData schema.

ECFParticipantDeferResponseData

The details of a participant

Name Type Required Description
id string true

The unique identifier of the participant record
type string true

The data type
attributes object true

The data attributes associated with an ECF participant

It conforms to ECFParticipantDeferAttributesResponse schema.

ECFParticipantResponse

An ECF Participant

Name Type Required Description
data object true

The details of a participant

It conforms to ECFParticipant schema.

ECFParticipantResume

An ECF participant resume action

Name Type Required Description
type string true

The data type

Possible values:

  • participant-resume
attributes object true

An ECF participant resume action

It conforms to ECFParticipantResumeAttributes schema.

ECFParticipantResumeAttributes

An ECF participant resume action

Name Type Required Description
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor

Example

{
  "course_identifier": "ecf-mentor"
}

ECFParticipantResumeAttributesResponse

The data attributes associated with an ECF participant

Name Type Required Description
email string true

The email address registered for this ECF participant
full_name string true

The full name of this ECF participant
mentor_id string false

The unique identifier of this ECF participants mentor
school_urn string true

The Unique Reference Number (URN) of the school that submitted this ECF participant
participant_type string true

The type of ECF participant this record refers to

Possible values:

  • ect
  • mentor
cohort string true

Indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year.
status string true

The status of this ECF participant record

Possible values:

  • active
  • withdrawn
teacher_reference_number string false

The Teacher Reference Number (TRN) for this ECF participant
teacher_reference_number_validated boolean false

Indicates whether the Teacher Reference Number (TRN) has been validated
eligible_for_funding boolean false

Indicates whether this participant is eligible to receive DfE funded induction
pupil_premium_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to pupil premium
sparsity_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to sparsity
training_status string true

The training status of the ECF participant

Possible values:

  • active
  • deferred
  • withdrawn
schedule_identifier string true

The schedule of the ECF participant

Possible values:

  • ecf-standard-september
  • ecf-standard-january
  • ecf-standard-april
  • ecf-reduced-september
  • ecf-reduced-january
  • ecf-reduced-april
  • ecf-extended-september
  • ecf-extended-january
  • ecf-extended-april
  • ecf-replacement-september
  • ecf-replacement-january
  • ecf-replacement-april
updated_at string true

The date the ECF participant was last updated

ECFParticipantResumeRequest

The resume request for a participant

Name Type Required Description
data object true

An ECF participant resume action

It conforms to ECFParticipantResume schema.

Example

{
  "data": {
    "type": "participant-resume",
    "attributes": {
      "course_identifier": "ecf-mentor"
    }
  }
}

ECFParticipantResumeResponse

An ECF Participant

Name Type Required Description
data object true

The details of a participant

It conforms to ECFParticipantResumeResponseData schema.

ECFParticipantResumeResponseData

The details of a participant

Name Type Required Description
id string true

The unique identifier of the participant record
type string true

The data type
attributes object true

The data attributes associated with an ECF participant

It conforms to ECFParticipantResumeAttributesResponse schema.

ECFParticipantRetainedDeclaration

An ECF participant retained declaration request body

Name Type Required Description
type object false

The request data

Possible values:

  • participant-declaration
attributes object true

An ECF participant retained declaration

It conforms to ECFParticipantRetainedDeclarationAttributes schema.

ECFParticipantRetainedDeclarationAttributes

An ECF participant retained declaration

Name Type Required Description
participant_id string true

The unique id of the participant
declaration_type string true

The event declaration type

Possible values:

  • retained-1
  • retained-2
  • retained-3
  • retained-4
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor
evidence_held string true

The type of evidence that the lead provider holds on their platform to demonstrate that the participant has met the retention criteria for the current milestone period

Possible values:

  • training-event-attended
  • self-study-material-completed
  • other

Example

{
  "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
  "declaration_type": "retained-1",
  "declaration_date": "2021-05-31T02:21:32.000Z",
  "course_identifier": "ecf-induction",
  "evidence_held": "training-event-attended"
}

ECFParticipantStartedDeclaration

A participant started declaration request body

Name Type Required Description
type object false

The request data

Possible values:

  • participant-declaration
attributes object true

An ECF started and completed participant declaration

It conforms to ECFParticipantStartedDeclarationAttributes schema.

ECFParticipantStartedDeclarationAttributes

An ECF started and completed participant declaration

Name Type Required Description
participant_id string true

The unique id of the participant
declaration_type string true

The event declaration type

Possible values:

  • started
  • completed
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor

Example

{
  "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
  "declaration_type": "started",
  "declaration_date": "2021-05-31T02:21:32.000Z",
  "course_identifier": "ecf-mentor"
}

ECFParticipantWithdraw

An ECF participant withdrawal action

Name Type Required Description
type string false

The data type

Possible values:

  • participant-withdraw
attributes object false

An ECF participant withdrawal action

It conforms to ECFParticipantWithdrawAttributes schema.

ECFParticipantWithdrawAttributes

An ECF participant withdrawal action

Name Type Required Description
reason string true

The reason for the withdrawal

Possible values:

  • left-teaching-profession
  • moved-school
  • mentor-no-longer-being-mentor
  • school-left-fip
  • other
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor

Example

{
  "reason": "left-teaching-profession",
  "course_identifier": "ecf-mentor"
}

ECFParticipantWithdrawAttributesResponse

The data attributes associated with an ECF participant

Name Type Required Description
email string true

The email address registered for this ECF participant
full_name string true

The full name of this ECF participant
mentor_id string false

The unique identifier of this ECF participants mentor
school_urn string true

The Unique Reference Number (URN) of the school that submitted this ECF participant
participant_type string true

The type of ECF participant this record refers to

Possible values:

  • ect
  • mentor
cohort string true

Indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year.
status string true

The status of this ECF participant record

Possible values:

  • active
  • withdrawn
teacher_reference_number string false

The Teacher Reference Number (TRN) for this ECF participant
teacher_reference_number_validated boolean false

Indicates whether the Teacher Reference Number (TRN) has been validated
eligible_for_funding boolean false

Indicates whether this participant is eligible to receive DfE funded induction
pupil_premium_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to pupil premium
sparsity_uplift boolean false

Indicates whether this participant qualifies for an uplift payment due to sparsity
training_status string true

The training status of the ECF participant

Possible values:

  • active
  • deferred
  • withdrawn
schedule_identifier string true

The schedule of the ECF participant

Possible values:

  • ecf-standard-september
  • ecf-standard-january
  • ecf-standard-april
  • ecf-reduced-september
  • ecf-reduced-january
  • ecf-reduced-april
  • ecf-extended-september
  • ecf-extended-january
  • ecf-extended-april
  • ecf-replacement-september
  • ecf-replacement-january
  • ecf-replacement-april
updated_at string true

The date the ECF participant was last updated

ECFParticipantWithdrawDataResponse

The details of a participant

Name Type Required Description
id string true

The unique identifier of the participant record
type string true

The data type
attributes object true

The data attributes associated with an ECF participant

It conforms to ECFParticipantWithdrawAttributesResponse schema.

ECFParticipantWithdrawRequest

The withdrawal request for a participant

Name Type Required Description
data object true

An ECF participant withdrawal action

It conforms to ECFParticipantWithdraw schema.

Example

{
  "data": {
    "type": "participant-withdraw",
    "attributes": {
      "reason": "left-teaching-profession",
      "course_identifier": "ecf-mentor"
    }
  }
}

ECFParticipantWithdrawResponse

An ECF Participant

Name Type Required Description
data object true

The details of a participant

It conforms to ECFParticipantWithdrawDataResponse schema.

Error

An single error element

Name Type Required Description
title string false

A title of the error
detail string false

Additional details of the error

ErrorResponse

A list of errors

Name Type Required Description
error array false It conforms to Error schema.

ListFilter

Filter a list of records to return more specific results

Name Type Required Description
updated_since string false

Return only records that have been updated since this date and time (ISO 8601 date format)

ListFilterDeclarations

Filter a list of declarations records to return more specific results

Name Type Required Description
updated_since string false

Return only records that have been updated since this date and time (ISO 8601 date format)
participant_id string false

The unique id of the participant

MultipleECFParticipantsCsvResponse

A list of ECF participants in the Comma Separated Value (CSV) format

Name Type Required Description
data array true It conforms to ECFParticipantCsvRow schema.

MultipleECFParticipantsResponse

A list of ECF participants

Name Type Required Description
data array true It conforms to ECFParticipant schema.

MultipleNPQApplicationsCsvResponse

A list of participants in the Comma Separated Value (CSV) format

Name Type Required Description
data array true It conforms to NPQApplicationCsvRow schema.

MultipleNPQApplicationsResponse

A list of NPQ applications

Name Type Required Description
data array true It conforms to NPQApplication schema.

MultipleNPQEnrolmentsCsvResponse

A list of NPQ enrolments in the Comma Separated Value (CSV) format

Name Type Required Description
data array true It conforms to NPQEnrolmentCsvRow schema.

MultipleNPQParticipantsResponse

A list of NPQ participants

Name Type Required Description
data array true It conforms to NPQParticipant schema.

MultipleParticipantDeclarationsCsvResponse

A list of participant declarations in the Comma Separated Value (CSV) format

Name Type Required Description
data array true It conforms to ParticipantDeclarationCsvRow schema.

MultipleParticipantDeclarationsResponse

A list of participant declarations

Name Type Required Description
data array true It conforms to ParticipantDeclarationResponse schema.

NPQApplication

The details of an NPQ Application

Name Type Required Description
id string true

The unique identifier of the NPQ Application record
type string true

The data type

Possible values:

  • npq_application
attributes object true

The data attributes associated with an NPQ application

It conforms to NPQApplicationAttributes schema.

NPQApplicationAcceptAttributesRequest

The NPQ Application acceptance request

Name Type Required Description
funded_place boolean false

Whether the participant has a funded place

NPQApplicationAcceptDataRequest

The NPQ Application acceptance request attributes

Name Type Required Description
type string true

The data type
data object true

The NPQ Application acceptance request

It conforms to NPQApplicationAcceptAttributesRequest schema.

NPQApplicationAcceptRequest

The NPQ Application acceptance request

Name Type Required Description
data object false

The NPQ Application acceptance request attributes

It conforms to NPQApplicationAcceptDataRequest schema.

Example

{
  "data": {
    "type": "npq-application-accept",
    "attributes": {
      "funded_place": true
    }
  }
}

NPQApplicationAttributes

The data attributes associated with an NPQ application

Name Type Required Description
course_identifier string true

The NPQ course this NPQ application relates to

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco
email string true

The email address registered for this NPQ participant
email_validated boolean true

Indicates whether the email address has been validated
employer_name string false

The name of current employer of the participant if not currently employed by school
employment_role string false

Participant’s current role in the company they are employed in if not currently employed by school
full_name string true

The full name of this NPQ participant
funding_choice string false

Indicates how this NPQ participant has said they will funded their training

Possible values:

  • school
  • trust
  • self
  • another
  • employer
headteacher_status string false

Indicates whether this NPQ participant is or will be a head teacher

Possible values:

  • no
  • yes_when_course_starts
  • yes_in_first_two_years
  • yes_over_two_years
  • yes_in_first_five_years
  • yes_over_five_years
ineligible_for_funding_reason string false

Indicates why this NPQ participant is not eligible for DfE funding

Possible values:

  • establishment-ineligible
  • previously-funded
participant_id string true

The unique identifier of this NPQ participant
private_childcare_provider_urn string false

The Unique Reference Number (URN) of the private child care provider
teacher_reference_number string true

The Teacher Reference Number (TRN) for this NPQ participant
teacher_reference_number_validated boolean true

Indicates whether the Teacher Reference Number (TRN) has been validated
school_urn string false

The Unique Reference Number (URN) of the school where this NPQ participant is employed
school_ukprn string false

The UK Provider Reference Number (UK Provider Reference Number) of the school where this NPQ participant is employed
status string true

The current state of the NPQ application

Possible values:

  • pending
  • accepted
  • rejected
works_in_school boolean false

Indicates whether the participant is currently employed by school
created_at string true

The date the application was created
updated_at string true

The date the application was last updated
cohort string false

Indicates which call-off contract would fund this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year. Once a provider accepts an application, they may change a participant’s cohort up until the point of submitting a started declaration.
eligible_for_funding boolean true

Indicates whether or not this participant is eligible for DfE funding
funded_place boolean false

Indicates whether or not this participant’s training is being funded by DfE
targeted_delivery_funding_eligibility boolean false

Whether or not this application is eligible for Targeted Delivery Funding uplift
teacher_catchment boolean false

This field will indicate whether or not the participant is UK-based.

  • If true then the registration relates to a participant who is UK-based.
  • If false then the registration relates to a participant who is not UK-based.
teacher_catchment_country string false

This field shows the text entered by the participant during their NPQ online registration.
teacher_catchment_iso_country_code string false

This field identifies which non-UK country the participant has registered from. The API uses ISO 3166 alpha-3 codes, three-letter codes published by the International Organization for Standardization (ISO) to represent countries, dependent territories, and special areas of geographical interest.
itt_provider string false

This field contains the legal name of the ITT accredited provider from the list of providers.
lead_mentor boolean false

This field indicates whether the applicant is an ITT lead mentor.

NPQApplicationCsvRow

The details of an NPQ application

Name Type Required Description
id string true

The unique identifier of the NPQ Application record
type string true

The data type

Possible values:

  • npq-application
participant_id string true

The unique identifier of this NPQ participant
full_name string true

The full name of this NPQ participant
email string true

The email address registered for this NPQ participant
email_validated boolean true

Indicates whether the email address has been validated
teacher_reference_number string true

The Teacher Reference Number (TRN) for this NPQ participant
teacher_reference_number_validated boolean true

Indicates whether the Teacher Reference Number (TRN) has been validated
school_urn string true

The Unique Reference Number (URN) of the school where this NPQ participant is employed
headteacher_status string true

Indicates whether this NPQ participant is or will be a head teacher

Possible values:

  • false
  • yes_when_course_starts
  • yes_in_first_two_years
  • yes_over_two_years
  • yes_in_first_five_years
  • yes_over_five_years
eligible_for_funding boolean true

Indicates whether or not this participant is eligible for DfE funding
funded_place boolean true

Indicates whether this NPQ participant is funded by DfE
funding_choice string true

Indicates how this NPQ participant has said they will funded their training

Possible values:

  • school
  • trust
  • self
  • another
course_identifier string false

The Unique Reference Number (URN) of the NPQ course this NPQ application relates to

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco
status string false

The current state of the NPQ application

Possible values:

  • pending
  • accepted
  • rejected
created_at string true

The date the application was created
updated_at string true

The date the application was last updated
lead_mentor boolean false

This field indicates whether the applicant is an ITT lead mentor.
itt_provider string false

This field contains the legal name of the ITT accredited provider from the list of providers.

NPQApplicationResponse

An NPQ application

Name Type Required Description
data object true

The details of an NPQ Application

It conforms to NPQApplication schema.

NPQEnrolment

The details of an NPQ Participant enrolment

Name Type Required Description
course_identifier string true

The course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco
schedule_identifier string true

The schedule the participant is enrolled in

Possible values:

  • npq-aso-march
  • npq-aso-june
  • npq-aso-november
  • npq-aso-december
  • npq-ehco-march
  • npq-ehco-june
  • npq-ehco-november
  • npq-ehco-december
  • npq-leadership-autumn
  • npq-leadership-spring
  • npq-specialist-autumn
  • npq-specialist-spring
cohort string true

The value indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year. Providers may change an NPQ participant’s cohort up until the point of submitting a started declaration.
npq_application_id string true

The ID of the NPQ application that was accepted to create this enrolment
eligible_for_funding boolean true

Indicates whether or not this participant is eligible for DfE funding
training_status string true

The training status of the NPQ participant

Possible values:

  • active
  • deferred
  • withdrawn
school_urn string false

The URN of the school when the application was made, if any
targeted_delivery_funding_eligibility boolean false

Whether or not this enrolment is eligible for Targeted Delivery Funding uplift
funded_place boolean false

Indicates whether or not this participant’s training is being funded by DfE

NPQEnrolmentCsvRow

The details of an NPQ application

Name Type Required Description
participant_id string true

The unique identifier of this NPQ participant
course_identifier string true

The NPQ course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco
schedule_identifier string true

The schedule currently applied to this enrolment

Possible values:

  • npq-aso-march
  • npq-aso-june
  • npq-aso-november
  • npq-aso-december
  • npq-ehco-march
  • npq-ehco-june
  • npq-ehco-november
  • npq-ehco-december
  • npq-leadership-autumn
  • npq-leadership-spring
  • npq-specialist-autumn
  • npq-specialist-spring
cohort string true

The value indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year. Providers may change an NPQ participant’s cohort up until the point of submitting a started declaration.
npq_application_id string true

The unique identifier of this NPQ application that was accepted to create this enrolment
eligible_for_funding boolean true

Indicates whether or not this participant is eligible for DfE funding
funded_place boolean true

Indicates whether this NPQ participant is funded by DfE
training_status string true

The training status of the ECF participant

Possible values:

  • active
  • deferred
  • withdrawn
school_urn string true

The Unique Reference Number (URN) of the school where this NPQ participant is teaching

NPQOutcome

An NPQ outcome

Name Type Required Description
id string true

The unique identifier of the NPQ outcome
type string true

The data type
attributes object true

The data attributes associated with an NPQ outcome

It conforms to NPQOutcomeAttributes schema.

NPQOutcomeAttributes

The data attributes associated with an NPQ outcome

Name Type Required Description
participant_id string true

The unique ID of the participant
course_identifier string true

The course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-leading-primary-mathematics
  • npq-senco
state string true

The state of the outcome (passed or failed)

Possible values:

  • passed
  • failed
completion_date string true

The date the participant received the assessment outcome for this course
created_at string true

The date you created the participant-outcome record

NPQOutcomeAttributesRequest

Name Type Required Description
course_identifier string true

The course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-leading-primary-mathematics
  • npq-senco
state string true

The state of the outcome (passed or failed)

Possible values:

  • passed
  • failed
completion_date string false

The date the participant received the assessment outcome for this course

NPQOutcomeDataRequest

The NPQ outcome submission request attributes

Name Type Required Description
type string true

The data type
data object false It conforms to NPQOutcomeAttributesRequest schema.

NPQOutcomeFilter

Filter NPQ outcomes to return more specific results

Name Type Required Description
created_since string false

Return only records that have been created since this date and time (ISO 8601 date format)

NPQOutcomeRequest

The NPQ outcome submission request

Name Type Required Description
data object true

The NPQ outcome submission request attributes

It conforms to NPQOutcomeDataRequest schema.

Example

{
  "data": {
    "type": "npq-outcome-confirmation",
    "attributes": {
      "course_identifier": "npq-leading-teaching",
      "state": "passed",
      "completion_date": "2021-05-31"
    }
  }
}

NPQOutcomeResponse

The details of an NPQ Outcome

Name Type Required Description
data object true

An NPQ outcome

It conforms to NPQOutcome schema.

NPQOutcomesResponse

A list of NPQ outcomes

Name Type Required Description
data array true It conforms to NPQOutcome schema.

NPQParticipant

The details of an NPQ Participant

Name Type Required Description
id string true

The unique identifier of the NPQ Participant record
type string true

The data type

Possible values:

  • npq-participant
attributes object true

The data attributes associated with an NPQ participants

It conforms to NPQParticipantAttributes schema.

NPQParticipantAttributes

The data attributes associated with an NPQ participants

Name Type Required Description
email string true

The email address registered for this NPQ participant
full_name string true

The full name of this NPQ participant
teacher_reference_number string false

The Teacher Reference Number (TRN) for this NPQ participant
updated_at string true

The date the NPQ participant was last updated
npq_enrolments array true

Information about the course(s) the participant is enroled in

It conforms to NPQEnrolment schema.

NPQParticipantChangeSchedule

An NPQ participant change schedule action

Name Type Required Description
type string true

The data type

Possible values:

  • participant-change-schedule
attributes object true

An NPQ participant change schedule action

It conforms to NPQParticipantChangeScheduleAttributes schema.

Example

{
  "type": "participant-change-schedule",
  "attributes": {
    "schedule_identifier": "npq-leadership-autumn",
    "course_identifier": "npq-leading-teaching",
    "cohort": "2021"
  }
}

NPQParticipantChangeScheduleAttributes

An NPQ participant change schedule action

Name Type Required Description
schedule_identifier string true

The new schedule of the participant

Possible values:

  • npq-aso-march
  • npq-aso-june
  • npq-aso-november
  • npq-aso-december
  • npq-ehco-march
  • npq-ehco-june
  • npq-ehco-november
  • npq-ehco-december
  • npq-leadership-autumn
  • npq-leadership-spring
  • npq-specialist-autumn
  • npq-specialist-spring
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco
cohort string false

Providers may change an NPQ participant’s cohort up until the point of submitting a started declaration. The value indicates which call-off contract funds this participant’s training. 2021 indicates a participant that has started, or will start, their training in the 2021/22 academic year.

Example

{
  "schedule_identifier": "npq-leadership-autumn",
  "course_identifier": "npq-leading-teaching",
  "cohort": "2021"
}

NPQParticipantChangeScheduleRequest

The change schedule request for a participant

Name Type Required Description
data object true

An NPQ participant change schedule action

It conforms to NPQParticipantChangeSchedule schema.

Example

{
  "data": {
    "type": "participant-change-schedule",
    "attributes": {
      "schedule_identifier": "npq-leadership-autumn",
      "course_identifier": "npq-leading-teaching",
      "cohort": "2021"
    }
  }
}

NPQParticipantDeclarationCompletedAttributesRequest

An NPQ completed participant declaration

Name Type Required Description
participant_id string true

The unique id of the participant
declaration_type string true

The event declaration type

Possible values:

  • completed
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco
has_passed boolean true

Whether the participant has failed or passed

Example

{
  "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
  "declaration_type": "completed",
  "declaration_date": "2021-05-31T02:21:32.000Z",
  "course_identifier": "npq-leading-teaching",
  "has_passed": true
}

NPQParticipantDeclarationRetainedAttributesRequest

An NPQ participant retained declaration

Name Type Required Description
participant_id string true

The unique id of the participant
declaration_type string true

The event declaration type

Possible values:

  • retained-1
  • retained-2
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco

Example

{
  "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
  "declaration_type": "retained-1",
  "declaration_date": "2021-05-31T02:21:32.000Z",
  "course_identifier": "npq-headship"
}

NPQParticipantDeclarationStartedAttributesRequest

An NPQ started participant declaration

Name Type Required Description
participant_id string true

The unique id of the participant
declaration_type string true

The event declaration type

Possible values:

  • started
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco

Example

{
  "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
  "declaration_type": "started",
  "declaration_date": "2021-05-31T02:21:32.000Z",
  "course_identifier": "npq-leading-teaching"
}

NPQParticipantDefer

The details of an NPQ participant deferral request

Name Type Required Description
type string true

The data type

Possible values:

  • participant-defer
attributes object true

An NPQ participant deferral action

It conforms to NPQParticipantDeferAttributes schema.

NPQParticipantDeferAttributes

An NPQ participant deferral action

Name Type Required Description
reason string true

The reason for the deferral

Possible values:

  • bereavement
  • long-term-sickness
  • parental-leave
  • career-break
  • other
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco

Example

{
  "reason": "parental-leave",
  "course_identifier": "npq-senior-leadership"
}

NPQParticipantDeferRequest

The deferral request for an NPQ participant

Name Type Required Description
data object true

The details of an NPQ participant deferral request

It conforms to NPQParticipantDefer schema.

Example

{
  "data": {
    "type": "participant-defer",
    "attributes": {
      "reason": "parental-leave",
      "course_identifier": "npq-senior-leadership"
    }
  }
}

NPQParticipantResponse

An NPQ participant

Name Type Required Description
data object true

The details of an NPQ Participant

It conforms to NPQParticipant schema.

NPQParticipantResume

An NPQ participant resume action

Name Type Required Description
type string true

The data type

Possible values:

  • participant-resume
attributes object true

An NPQ participant resume action

It conforms to NPQParticipantResumeAttributes schema.

NPQParticipantResumeAttributes

An NPQ participant resume action

Name Type Required Description
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco

Example

{
  "course_identifier": "npq-leading-teaching-development"
}

NPQParticipantResumeRequest

The resume request for an NPQ participant

Name Type Required Description
data object true

An NPQ participant resume action

It conforms to NPQParticipantResume schema.

Example

{
  "data": {
    "type": "participant-resume",
    "attributes": {
      "course_identifier": "npq-leading-teaching-development"
    }
  }
}

NPQParticipantRetainedDeclaration

An NPQ participant retained declaration request body

Name Type Required Description
type object false

The request data

Possible values:

  • participant-declaration
attributes object true

An NPQ participant retained declaration

It conforms to NPQParticipantRetainedDeclarationAttributes schema.

NPQParticipantRetainedDeclarationAttributes

An NPQ participant retained declaration

Name Type Required Description
participant_id string true

The unique id of the participant
declaration_type string true

The event declaration type

Possible values:

  • retained-1
  • retained-2
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco

Example

{
  "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
  "declaration_type": "retained-1",
  "declaration_date": "2021-05-31T02:21:32.000Z",
  "course_identifier": "npq-headship"
}

NPQParticipantStartedDeclaration

An NPQ participant started declaration request body

Name Type Required Description
type object false

The request data

Possible values:

  • participant-declaration
attributes object true

An NPQ started and completed participant declaration

It conforms to NPQParticipantStartedDeclarationAttributes schema.

NPQParticipantStartedDeclarationAttributes

An NPQ started and completed participant declaration

Name Type Required Description
participant_id string true

The unique id of the participant
declaration_type string true

The event declaration type

Possible values:

  • started
  • completed
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco

Example

{
  "participant_id": "db3a7848-7308-4879-942a-c4a70ced400a",
  "declaration_type": "started",
  "declaration_date": "2021-05-31T02:21:32.000Z",
  "course_identifier": "npq-leading-teaching"
}

NPQParticipantWithdraw

An NPQ participant withdrawal action

Name Type Required Description
type string false

The data type

Possible values:

  • participant-withdraw
attributes object true

An NPQ participant withdrawal action

It conforms to NPQParticipantWithdrawAttributes schema.

NPQParticipantWithdrawAttributes

An NPQ participant withdrawal action

Name Type Required Description
reason string true

The reason for the withdrawal

Possible values:

  • insufficient-capacity-to-undertake-programme
  • personal-reason-health-or-pregnancy-related
  • personal-reason-moving-school
  • personal-reason-other
  • insufficient-capacity
  • change-in-developmental-or-personal-priorities
  • change-in-school-circumstances
  • change-in-school-leadership
  • quality-of-programme-structure-not-suitable.
  • quality-of-programme-content-not-suitable
  • quality-of-programme-facilitation-not-effective
  • quality-of-programme-accessibility
  • quality-of-programme-other
  • programme-not-appropriate-for-role-and-cpd-needs
  • expected-commitment-unclear
  • other
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco

Example

{
  "reason": "left-teaching-profession",
  "course_identifier": "npq-headship"
}

NPQParticipantWithdrawRequest

The withdrawal request for an NPQ participant

Name Type Required Description
data object true

An NPQ participant withdrawal action

It conforms to NPQParticipantWithdraw schema.

Example

{
  "data": {
    "type": "participant-withdraw",
    "attributes": {
      "reason": "quality-of-programme-other",
      "course_identifier": "npq-leading-teaching-development"
    }
  }
}

NotFoundResponse

The requested resource was not found

Name Type Required Description
error string false

Pagination

This schema used to paginate through a collection.

Name Type Required Description
page integer false

The page number to paginate to in the collection. If no value is specified it defaults to the first page.
per_page integer false

The number items to display on a page. Defaults to 100. Maximum is 3000, if the value is greater that the maximum allowed it will fallback to 3000.

ParticipantDeclarationAttributes

The data attributes associated with a participant declaration response

Name Type Required Description
participant_id string true

The unique id of the participant
declaration_type string true

The event declaration type

Possible values:

  • started
  • retained-1
  • retained-2
  • retained-3
  • retained-4
  • completed
  • extended-1
  • extended-2
  • extended-3
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor
  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco
state string true

Indicates the state of this payment declaration

Possible values:

  • submitted
  • eligible
  • payable
  • paid
  • voided
  • ineligible
updated_at string true

The date the declaration was last updated
has_passed boolean false

Whether the participant has failed or passed

ParticipantDeclarationCsvRow

The details of a participant declaration

Name Type Required Description
id string true

The unique identifier of the participant declaration record
participant_id string true

The unique identifier of the participant record the declaration refers to
declaration_type string true

The event declaration type

Possible values:

  • started
  • retained-1
  • retained-2
  • retained-3
  • retained-4
  • completed
  • extended-1
  • extended-2
  • extended-3
declaration_date string true

The event declaration date
course_identifier string true

The type of course the participant is enrolled in

Possible values:

  • ecf-induction
  • ecf-mentor
  • npq-leading-teaching
  • npq-leading-behaviour-culture
  • npq-leading-teaching-development
  • npq-leading-literacy
  • npq-senior-leadership
  • npq-headship
  • npq-executive-leadership
  • npq-early-years-leadership
  • npq-additional-support-offer
  • npq-early-headship-coaching-offer
  • npq-leading-primary-mathematics
  • npq-senco
state string false

Indicates the state of this payment declaration
updated_at string true

The date the declaration was last updated

ParticipantDeclarationDataRequest

A participant declaration data request

Name Type Required Description
type string false

Possible values:

  • participant-declaration
attributes false

This conforms to any of the following schemas:

ParticipantDeclarationRequest

An participant declaration request

Name Type Required Description
data object true

A participant declaration data request

It conforms to ParticipantDeclarationDataRequest schema.

ParticipantDeclarationResponse

A participant declaration response

Name Type Required Description
id string true

The unique identifier of the participant declaration record
type string true

The data type
attributes object true

The data attributes associated with a participant declaration response

It conforms to ParticipantDeclarationAttributes schema.

ParticipantListFilter

Filter a list of records to return more specific results

Name Type Required Description
updated_since string false

Return only records that have been updated since this date and time (ISO 8601 date format)
cohort string false

Return only records for the given cohort

SingleParticipantDeclarationResponse

A confirmation that the participant declaration has been recorded successfully

Name Type Required Description
data object true

A participant declaration response

It conforms to ParticipantDeclarationResponse schema.

UnauthorisedResponse

Authorization information is missing or invalid

Name Type Required Description
error string false