Connecting to the UCAS-Link API

Set up the integration broker to establish a connection with the UCAS-Link API.

You will have to update the REST Base URL if you want to switch from test to production, or if you need to update the URI to use a new version of the API.

  1. Go to PeopleTools > Integration Broker > Integration Setup > Service Operations.

  2. In Service, search for SAD_UC_UCLINK.

  3. From the results, click the service operation name. For example, SAD_UC_DLOADQUERY_POST.

  4. Update the values in REST Base URL or URI if necessary.

  5. Save your changes, then repeat these steps for the rest of the service operations.

Routing must be set up to enable connection to UCAS-Link API. Follow these steps to check if routings have been generated for the service operations.

  1. Go to PeopleTools > Integration Broker > Integration Setup > Service Operation Definitions.

  2. Search for SAD_UC_UCLINK.

  3. Select a service operation, and then click Routings.

    If routings have been automatically generated, you should see values in the Routing Definitions grid.

Create routings for each service operation of the SAD_UC_UCLINK service.

  1. Go to PeopleTools > Integration Broker > Integration Setup > Routing Definitions.

  2. Click Add a New Value.

  3. In Routing Name, add the value SAD_UC_UCLTOKEN_POST.

  4. On the Routing Definitions page, provide these values:

    • Service Operation: SAD_UC_GET_TOKENLINK_POST

    • Version: This field is automatically populated.

    • Description: UCAS Link Get Token

    • Sender Node: Select the local node for the environment, for example, S92UKP35

    • Receiver Node: WADL_NODE

    • Owner ID: Admissions – UK

    • Select the User Exception checkbox.

    • Log Details: Select Header and Detail.

  5. Save your changes.

  6. Go to Parameters.

    • From the Outbound Request section, clear the fields Message.Ver into Transform 1.

    • From the Inbound Response section, clear Message.Ver out of Transforms.

  7. Go to Connector Properties.

    • In Gateway ID, enter LOCAL.

    • In Connector ID, enter HTTPTARGET.

    • In Connector Properties, delete any rows with values.

  8. Save your changes.

  9. Repeat steps 1 to 8 providing these values on the Routing Definitions page:

    • Routing Name: SAD_UC_UCLREQDATA_POST

    • Service Operation: SAD_UC_DLOADQUERY_POST

    • Description: UCAS Link Request Data

    • Sender Node: Select the local node for the environment, for example, S92UKP35

    • Receiver Node: WADL_NODE

    • Owner ID: Admissions – UK

    • Don't select the User Exception checkbox.

    • Log Detail: No Logging

  10. Repeat steps 1 to 8 providing these values on the Routing Definitions page:

    • Routing Name: SAD_UC_UCLMONDATA_GET

    • Service Operation: SAD_UC_MONITORQUERY_GET

    • Description: UCAS Link Monitor Data

    • Sender Node: Select the local node for the environment, for example, S92UKP35

    • Receiver Node: WADL_NODE

    • Owner ID: Admissions – UK

    • Don't select the User Exception checkbox.

    • Log Detail: No Logging

    Use the same values for the other fields in step 4, but

  11. Repeat steps 1 to 8 providing these values on the Routing Definitions page:

    • Routing Name: SAD_UC_UCLDATA_GET

    • Service Operation: SAD_UC_DLOADITEMS_GET

    • Description: UCAS Link Load Data

    • Sender Node: Select the local node for the environment, for example, S92UKP35

    • Receiver Node: WADL_NODE

    • Owner ID: Admissions – UK

    • Select the User Exception checkbox.

    • Log Details: Select Header and Detail.

  1. Go to PeopleTools > Integration Broker > Service Utilities > Test Service Operations.

  2. Search for the service SAD_UC_UCLINK.

  3. Select the SAD_UC_DLOADQUERY_POST link, then click Invoke Operation.

    You will see an unauthorized error. That's expected.