Partnerships endpoints now in sandbox for testing
We’ve added the partnerships endpoints to the ‘Register early career teachers’ API sandbox:
GET /partnerships
to retrieve multiple partnershipsGET /partnerships/{id}
to retrieve an individual partnershipPOST /partnerships
to create a partnershipPUT /partnerships/{id}
to update a partnership
Read our partnerships guidance for more detailed information.
What’s changed from the existing ‘Manage training for early career teachers’ API?
Challenge fields removed
Because schools now make changes at an individual participant level (for example, moving an ECT to a different provider) rather than challenging a school-wide partnership, we’ve removed challenge fields (challenged_reason
, challenged_at
, status
) from partnership responses.
Providers can now see the number of ECTs or mentors currently training with them for a given partnership
We’ve added the numeric participants_currently_training
field in the GET /partnerships
endpoint. It shows lead providers whether any ECTs or mentors are currently training with them in a partnership.
New expression of interest field
We’ve introduced the expression_of_interest
field in the GET /schools
and GET /schools/{id}
endpoints to show lead providers whether a school has any participants registered with them for that cohort. This should help lead providers create partnerships with schools that have stated they’re training with them.
The attribute holds one of 2 possible response values, true
or false
.
If a school has expressed interest but no partnership exists, creating one lets the lead provider see the school’s registered participants in the API.
Multiple partnerships may appear
Previously, schools had a default partnership with a single lead provider for each cohort.
We’ve changed this to reflect that some schools need to set up partnerships with more than one lead provider.
In the API:
GET /partnerships
may return more than one partnership for the same school and cohort- the
in_partnership
field will statetrue
if any partnership exists andfalse
if none exist
Earlier partnership submissions allowed
Lead providers can create a partnership even if the school hasn’t registered participants. The only exceptions are when the cohort has not opened, or the school is doing school-led training.