Connecting to the Register API

The REST Base URL is initially set to the sandbox test environment for Register at the Department of Education. Update it when promoting to production or when changing the API version.

1. Open the Service Operation Definitions page: PeopleTools > Integration Broker > Integration Setup > Service Operations Definitions.

2. Locate the service SSR_HE_REG_API then from the results, select one of the service operations. For example: SSR_HE_REG_TRN_GET.

3. In REST Base URL, enter https://sandbox.register-trainee-teachers.service.gov.uk.

4. In URI, update the version to the required value, for example: v2025.0.

5. Save your changes, then repeat for each remaining service operation.

If a routing has been automatically generated for the service operation, only the User Exception field needs to be updated.

Check if routings were set up for the service operations and update details as necessary.

1. Navigate to the Service Operation Definitions page: PeopleTools > Integration Broker > Integration Setup > Service Operation Definitions.

2. Search for SSR_HE_REG_API.

3. Select SSR_HE_REG_PLC_DELETE.

4. Select Routings.

5. In Routing Definitions, from the Name column, select the name.

6. From IB Routing Definitions, select User Exception.

7. In Log Detail, select Header and Detail to allow monitoring via PeopleTools > Integration Broker > Service Operations Monitor > Monitoring > View Synchronous Detail > .

8. Select the Service Operation Security link and assign the appropriate permission lists.

9. Save your changes.

10. Repeat steps 4-6 to select User Exception for the following service operations:

    • SSR_HE_REG_TRN_POST

    • SSR_HE_REG_TRN_PUT

    • SSR_HE_REG_TRN_GET

11. Save your changes.

Routings must be set up for each service operation to enable connection to the Register API.

Here's what you need to do if a routing hasn't been automatically generated for the service operation.

1. Navigate to Routing Definitions: PeopleTools > Integration Broker > Integration Setup > Routing Definitions.

2. Set up the routing for the Get Info service operation.

   1. Select Add a New Value.

   2. In Routing Name, enter SSR_HE_INFO_GET_REG.

   3. In Routing Definitions, enter this information.

      Field or Control	Description
      Service Operation	Enter SSR_HE_REG_INFO_GET
      Description	Enter HESA Register Info Get.
      Sender Node	Select the local node for the environment.
      Receiver Node	Enter WADL_NODE.
      Owner ID	Select Student Records – UK.
      Log Detail	Select No Logging.

   4. Save your changes.

      Note: If an active routing already exists for the service operation, an error message appears and the Active checkbox is deselected.

3. Select Parameters.

   1. From the Inbound Response parameter type, remove the value in Message.Ver out of Transforms.

   2. From the Outbound Request parameter type, remove the value in Message.Ver into Transform 1.

4. Select Connector Properties, then enter the following information:

   1. In Gateway ID, choose LOCAL.

   2. In Connector ID, enter HTTPTARGET.

   3. Make sure there are no values in Connector Properties.

   4. Save your changes.

5. To confirm the setup, return to the Service Operation Definitions page and select the service operation. Select Routings.

6. Set up the routing for the Delete Placement service operation.

   1. Select Add a New Value.

   2. In Routing Name, enter SSR_HE_PLAC_DEL_REG.

   3. In Routing Definitions, enter this information.

      Field or Control	Description
      Service Operation	Enter SSR_HE_REG_PLC_DELETE
      Description	Enter HESA Register Placement Delete.
      Sender Node	Select the local node for the environment.
      Receiver Node	Enter WADL_NODE.
      User Exception	Select the checkbox.
      Owner ID	Select Student Records – UK.
      Log Detail	Select Header and Detail if you want to monitor the results in PeopleTools > Integration Broker > Service Operations Monitor > Monitoring > View Synchronous Detail.

   4. Save your changes.

7. To set up security access, select Service Operation Security.

8. Repeat steps 3-5.

9. Set up the routing for the Get Trainees service operation.

   1. Select Add a New Value.

   2. In Routing Name, enter SSR_HE_TRN_GET_REG.

   3. In Routing Definitions, enter this information.

      Field or Control	Description
      Service Operation	Enter SSR_HE_REG_TRN_GET.
      Description	Enter HESA Register Trainee Get.
      Sender Node	Select the local node for the environment.
      Receiver Node	Enter WADL_NODE.
      User Exception	Select the checkbox.
      Owner ID	Select Student Records – UK.
      Log Detail	Select Header and Detail if you want to monitor the results in PeopleTools > Integration Broker > Service Operations Monitor > Monitoring > View Synchronous Detail.

   4. Save your changes.

10. Repeat steps 3-5.

11. Set up the routing for the Post Trainees service operation.

    1. Select Add a New Value.

    2. In Routing Name, enter SSR_HE_TRN_POST_REG.

    3. In Routing Definitions, enter this information.

       Field or Control	Description
       Service Operation	Enter SSR_HE_REG_TRN_POST.
       Description	Enter HESA Register Trainee Post.
       Sender Node	Select the local node for the environment.
       Receiver Node	Enter WADL_NODE.
       User Exception	Select the checkbox.
       Owner ID	Select Student Records – UK.
       Log Detail	Select Header and Detail if you want to monitor the results in PeopleTools > Integration Broker > Service Operations Monitor > Monitoring > View Synchronous Detail.

    4. Save your changes.

12. Repeat steps 3-5.

13. Set up the routing for the Put Trainees service operation.

    1. Select Add a New Value.

    2. In Routing Name, enter SSR_HE_TRN_PUT_REG.

    3. In Routing Definitions, enter this information.

       Field or Control	Description
       Service Operation	Enter SSR_HE_REG_TRN_PUT.
       Description	Enter HESA Register Trainee Put.
       Sender Node	Select the local node for the environment.
       Receiver Node	Enter WADL_NODE.
       User Exception	Select the checkbox.
       Owner ID	Select Student Records – UK.
       Log Detail	Select Header and Detail if you want to monitor the results in PeopleTools > Integration Broker > Service Operations Monitor > Monitoring > View Synchronous Detail.

    4. Save your changes.

14. Repeat steps 3-5.