03 March 2025

4.42 REST Services

The following changes have been made to REST Services for 4.42:

Rest Services Added

REST Service URL Verb
Create Unit Instance HESA Module Subject /UnitInstances/{uiID}/CreateUIModuleSubject POST
Update Unit Instance HESA Module Subject /UnitInstances/{uiID}/UpdateUIModuleSubject PUT

REST Services Changes

The following changes have been made to REST Services for HESA Student-Data Futures.

The field SOC2020 has been added to the PeopleHESADetails section of People (PUT) and People (POST).

Service Pack 2 Updates

  • To make it easier to trouble shoot the response to failed API calls has been updated. The response will now give the full details available regarding the issue.

  • The field FundCode has been removed from the PeopleUnitsSpecialHesaMessage section of Enrolments (PUT) and Enrolments (POST).

  • The following fields have been added to the PeopleUnitsSpecialHesaMessage section of Enrolments (PUT) and Enrolments (POST):

    • EMPLOYINGSCHOOL

    • ENTRYRTE

    • FEEELIG

    • FEESTATUS

    • LEADSCHOOL

    • NHSEMP

    • QTS

    • RCSTID

    • RCSTDNT

    • TRN

    • COLPROVTYPEID

    • PARTNERNUMHUS

    • PARTNERSID

    • PARTNERUKPRN

    • PRGLANGPCNT

    • PHDSUB

    • PLACEMENT

    • PREPFLAG

    • RSNSCSEND

    • THESISTITLE

    • YEAR_PROG

    • APEL

    • CONTINUING

    • INACTIVEMOD

    • PGRLANGPCNT

    • MODCOUNT

    • MODULEOUTCOME

    • MODULERESULT

    • NONREGFEE

  • The field LEARNER_FTE_COM has been added to the PeopleUnitsSpecialILRHEHESADetails section of Enrolment (PUT) and Enrolment (POST).

  • A new section, HESAoffVenueActivities has been added to Enrolment (PUT) and Enrolment (POST). It contains the following fields:

    • ACTDURATION

    • ACTDURATIONTYPE

    • ACTENDDATE

    • ACTSTARTDATE

    • COUNTRY

    • HOSTID

    • HOSTIDTYPE

    • MOBSCHEME

    • PEOPLE_UNITS_SPECIAL_ID

    • IS_ACTIVE

    • INCLUDE_IN_DATA_RETURN