03 March 2025

REST Services changes 4.43

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

REST Services Added

REST Service URL Verb
Create HESA Module Cost Centre /UnitInstances/{uiID}/CreateUIHesaModuleCostCentre POST
Update HESA Module Cost Centre /UnitInstances/{uiID}/UpdateUIHesaModuleCostCentre PUT
Create UI HESA Course Initiative /UnitInstances/{uiID}/CreateUIHesaCourseInitiative POST
Update UI HESA Course Initiative /UnitInstances/{uiID}/UpdateUIHesaCourseInitiative PUT

A number of new services have been introduced for the Safeguarding module. For full details please refer to the ebs REST Documentation.

REST Services Changed

  • The Create Enrolments and Update Enrolments REST services have been updated to include the following fields:

    • LEARNER_SUPPORT_FUNDING

    • PARTICIPANT_ID

    • LONG_TERM_DESTINATION

    • LONG_TERM_Employment

  • The Create UIO and Update UIO REST services have been updated to include the following fields.

    • ES_FUND_FLAG.

    • NOTIONAL_HOURS

    • TENHOUR_IND

    • PROG_CODE

    • PROG_YEAR

    • MAIN_CAMPUS

    • TAKE_EXAM_YN

    • SOCIAL_INCLUSION

    • ID

    • UIO_ID

    • LOCSDY

    • MODE_OF_STUDY

    • MSTUFEE

    • PRIPROV

    • LEARNER_FTE

    • YEAR_OF_UNIT

    • INCLUDE_IN_HESA

    • UNITLGTH

    • SPLENGTH

    • CLSDCRS

    • FULLYFLEX

    • FUNDLENGTH

  • The Create UIHesa and Update UIHesa REST services have been updated to add the following fields.

    • UI_HESA.BITTM

    • UI_HESA.SANDWICH

    • UI_HESA.TTCID

    • UI_HESA.CRDTPTS

    • UI_HESA.CRDTSCM

    • UI_HESA.FTE

    • UI_HESA.LEVLPTS

    • UI_HESA.MODLANGID

    • UI_HESA.COURSEAIM

    • UI_HESA.AWARDBODY1 to AWARDBODY8

    • UI_HESA.SBJCA1 to SBJCA5

    • UI_HESA. SBJPCNT1 to SBJPCNT 5

    • UI_HESA.QUALITT

  • The Create Person and Update Person REST services have been updated to add the CLIENT_ID field in the PeopleCDRDetailsMessage .

  • Updates have been made to the following fields in the PeopleCDRDetailsMessage for Create Person (/People) and Update Person (/People/{personCode}) REST services:

    • HasDisability (HAS_DISABILITY)

      • Validation: Updated validation from 1 character to 2 characters (added min/max validation as field must be exactly 2 characters).

      • Validation: Added verifier validation for HasDisability (RV_DOMAIN = 'HAS_DISABILITY').

    • EssentialSkillsNumeracyGrade

      • Validation: Added verifier validation for EssentialSkillsNumeracyGrade (RV_DOMAIN = 'ES_GRADE').

      EssentialSkillsLiteracyGrade

      • Validation: Added verifier validation for EssentialSkillsLiteracyGrade (RV_DOMAIN = 'ES_GRADE').

    • GCSEMathGrade

      • Validation: Added verifier validation for GCSEMathGrade (RV_DOMAIN = 'GCSE_GRADE').

    • GCSEEnglishGrade

      • Validation: Added verifier validation for GCSEMathGrade (RV_DOMAIN = 'GCSE_GRADE').

    • GCSE_A_C

      • Validation: Updated MinValue validation from 0 to 1 and MaxValue validation from 99 to 12.

    • GCSE_D_G

      • Validation: Updated MinValue validation from 0 to 1 and MaxValue validation from 99 to 12.

Service Pack 1 Updates

REST Services Added

REST Service URL Verb
Create HESA Module Cost Centre /UnitInstances/{uiID}/CreateUIHesaModuleCostCentre POST
Update HESA Module Cost Centre /UnitInstances/{uiID}/UpdateUIHesaModuleCostCentre PUT
Create HESA Curriculum Accreditation /UnitInstances/{uiID}/CreateUICurriculumAccreditation POST
Update HESA Curriculum Accreditation /UnitInstances/{uiID}/CreateUICurriculumAccreditation PUT

REST Services Changed

  • The Create and Update Unit Instance Hesa Deliv Orginisations REST services have been updated to include the following field:

    • UI_HESA_DELIVERYORGANISATIONS.ROLETYPE