Setting Up UCAS Service Operations

To import applicants using XML, you need to secure the web service operations as well as set up their routing definitions.

To use the service operations, make sure you add them to the permission list that can use the web service.

  1. Access the Permission Lists - Web Services page: go to PeopleTools > Security > Permissions and Roles > Permission Lists.

  2. Search for the permission list HCCPCSSA1000.

  3. Click Web Services.

  4. Click the plus button to add SAD_UC_UCXML, then click Edit.

  5. Click Full Access (All) to allow the permission list full access to all service operations, then click OK.

  6. Save your changes.

  7. Repeating steps 4 to 6 to add:

    • SAD_UC_TRANAPI

    • SAD_UC_REFAPI

You need to set up the routing definition for each routing name and its matching service operation to import applicants and reference data as well as send transactions to UCAS through XML-link.

These are the routing names for each of the service operations.

Routing Name

Service Operation

Description
GETUCASAPPADRHIST

GETUCASAPPLICANTADDRESSHISTORY

Applicant Address History
GETUCASAPPADRHISTU

GETUCASAPPLICANTADDRESSHISTO70

Applicant Address Hist Unicode

GETUCASAPANSWER

GETUCASAPPLICANTANSWERS

Applicant Answers

GETUCASAPPLBKG

GETUCASAPPLICANTSBACKGROUND

Applicant Background

GETUCASAPPLCANCEL

GETUCASAPPLICANTSCANCELLED

Applicant Canceled

GETUCASAPPLCHOICES

GETUCASAPPLICANTCHOICES

Applicant Choices

GETUCASAPPLCNTXT

GETUCASAPPLICANTCONTEXTUALDATA

Applicant Contextual Data

GETUCASAPPLCRESP

GETUCASAPPLICANTCARINGRESPONSI

Applicant Caring Resp.

GETUCASAPPLDETAILS

GETUCASAPPLICANTSDETAILS

Applicant Details

GETUCASAPPLDETAILSU

GETUCASAPPLICANTSDETAILS_U

Applicant Details Unicode

GETUCASAPPLEDUC

GETUCASAPPLICANTEDUCATION

Applicant Education

GETUCASAPPLEFP

GETUCASAPPLICANTESTRANGEDFROMP

Applicant Estranged

GETUCASAPPLEMPLU

GETUCASAPPLICANTSEMPLOYMENT_U

Applicant Employment Unicode

GETUCASAPPLFSM

GETUCASAPPLICANTFREESCHOOLMEAL

Applicant Free School Meals

GETUCASAPPLHED

GETUCASAPPLICANTHIGHEREDUCATIO

Applicant HE Activities

GETUCASAPPLICANTSEMPLOYMENT

GETUCASAPPLICANTSEMPLOYMENT

Applicant Employment

GETUCASAPPLLWC

GETUCASAPPLICANTLIVINGWITHCOND

Applicant Living w/Condition

GETUCASAPPLPCIAF

GETUCASAPPLICANTPARENTCARERINA

Applicant Parent/Carer AF

GETUCASAPPLPRESP

GETUCASAPPLICANTPARENTINGRESPO

Applicant Parenting Resp.

GETUCASAPPLQUAL

GETUCASAPPLICANTQUALIFICATIONS

Applicant Qualifications
GETUCASAPREINSTA

GETUCASAPPLICANTSREINSTATED

Applicant Reinstated

GETUCASAPPLRASS

GETUCASAPPLICANTREFUGEEASYLUMS

Applicant Refugee/Asylum

GETUCASAPPLREF

GETUCASAPPLICANTREFEREES

Applicant References

GETUCASAPPLREFU

GETUCASAPPLICANTREFEREES_U

Applicant References Unicode

GETUCASAPPLRSLTS

GETUCASAPPLICANTSRESULTS

Applicant Results

GETUCASAPPLSIAF

GETUCASAPPLICANTSERVEDINARMEDF

Applicant Served Armed Forces

GETUCASAPPLSTAT

GETUCASAPPLICANTSTATEMENTS

Applicant Statements

GETUCASAPPLSTATU

GETUCASAPPLICANTSTATEMENTS_U

Applicant Statements Unicode

GETUCASAPPLUNITS

GETUCASAPPLICANTSUNITS

Applicant Units

GETUCASASRR

GETUCASAPPLICANTSELFRELEASEDRE

Applicant Self Release

GETUCASREFCONTROL

GETREFERENCERESULTSREFRESHCONT

Reference Refresh Control

GETUCASRSLTMTCH

GETUCASRESULTSMATCHSTATUS

Applicant Result Match

GETUCASHESAPPDATA

GETUCASHESADATA

Applicant HESA Data

GETUCASHESAPPDATAU

GETUCASHESADATA_U

Applicant HESA Data Unicode

GETREFDELCONF

GETUCASREFERENCEDELAYEDCONFIRM

Delayed Confirmation Reasons

SETAMENDECSNTRAN

SETAMENDEDDECISIONTRANSUCAS

Set Amended Decision

SETCLEARDECSNTRAN

SETCLEARINGDECISIONTRANSUCAS

Set Clearing Decision

SETCLEARFORMREQ

SETCLEARINGFORMREQUESTUCAS

Set Clearing Form Request

SETCONFDECSNTRAN

SETCONFIRMATIONDECISIONTRANSUC

Set Confirmation Decision

SETCRSECORECTTRAN

SETCOURSECORRECTIONTRANSUCAS

Set Course Correction

SETCONFDELTRAN

SETCONFIRMATIONDELAYEDTRANSUCA

Set Delayed Confirmation

SETFIRSTDECSNTRAN

SETFIRSTDECISIONTRANSACTIONUCA

Set First Decision

SETRELTOCLEARTRAN

SETRELEASEINTOCLEARINGTRANSACT

Set Release To Clearing

SETUFAMENDTRAN

SETUFAMENDMENTTRANSACTIONUCAS

Set UF Amendment

SETUFWDRAWTRAN

SETUFWITHDRAWALTRANSACTIONUCAS

Set UF Withdrawal

GETREFABLSUBJ

GETREFERENCEABLSUBJECTS

Reference ABL Subject
GETREFADRHIST

GETREFERENCEADDRESSHISTORYREAS

Reference Address History

GETREFAPR

GETREFPERMANENTRESIDENCEAREAS

Reference Perm. Residence Area

GETREFAWDBDY

GETREFERENCEAWARDINGBODIES

Reference Awarding Body

GETREFCARDUR

GETREFERENCEINCAREDURATION

Reference In Care Duration

GETREFCARE

GETREFERENCECARE

Reference Care

GETREFCOUNTRY

GETREFERENCECOUNTRIESOFBIRTH

Reference Country

GETREFCOURSES

GETUCASREFERENCECOURSES

Reference Course

GETREFDIS

GETREFERENCEDISABILITIES

Reference Disability

GETREFERROR

GETREFERENCEERRORS

Reference Error

GETREFESTAB

GETREFERENCEESTABLISHGROUPS

Reference Establishment Group

GETREFETHNIC

GETREFERENCEETHNICS

Reference Ethnicity

GETREFEXAMLVL

GETREFERENCEEXAMLEVELS

Reference Exam Level

GETREFFEE

GETREFERENCEFEEPAYERS

Reference Fee Payer

GETREFFSM

GETREFERENCEFREESCHOOLMEALS

Reference Free School Meals

GETREFGENIDE

GETREFERENCEGENIDENDIFF

Reference Gender Identity Diff

GETREFHEAT

GETREFERENCEHIGHEREDUCATIONACT

Reference HE Activity Type

GETREFINST

GETUCASREFERENCEINSTITUTIONS

Reference Institution

GETREFLEA

GETREFLOCALEDUCATIONAUTHORITIE

Reference Local Educ Authority

GETREFNATION

GETREFERENCENATIONALITYS

Reference Nationality

GETREFOEQ

GETREFOTHEREXAMQUALIFICATIONS

Reference Other Exam Quals

GETREFCOFABB

GETREFSTANDARDOFFERABBREVIATIO

Reference Offer Abbreviation

GETREFOFFSUB

GETREFERENCEOFFERSUBJECTS

Reference Offer Subject

GETREFPARHE

GETREFPARENTALHE

Reference Parental HE

GETREFPOCC20

GETREFERENCEPARENTALOCCUPATI84

Reference Parental Occ 2020

GETREFPRESPN

GETREFERENCEHIGHEREDUCATIONA3

Reference HE Activity Provider
GETREFNOVISRSN

GETREFERENCENOVISAREASON

Reference No Visa Reasons
GETREFPRVSTUDLVL

GETREFERENCEPREVIOUSSTUDYLEVEL

Reference Previous Study Level

GETREFRASS

GETREFERENCEREFUGEEASYLUMSEEKE

Reference Refugee Asylum

GETREFRELBLF

GETREFERENCERELIGIONBELIEF

Reference Religion/Belief

GETREFRESCAT

GETREFERENCERESIDENTIALCATEGOR

Reference Residential Category

GETREFSCHOOL

GETREFERENCESCHOOLS

Reference School

GETREFSCHCNT

GETREFERENCESCHOOLCONTACTS

Reference School Contact

GETREFSCHCTX

GETCONTEXTUALDATA

Reference School Contextual

GETREFSCHTYP

GETREFERENCESCHOOLTYPES

Reference School Type

GETREFSEXORT

GETREFERENCESEXORIENTATION

Reference Sexual Orientation

GETREFSOCECO

GETREFERENCESOCIALECONOMIC

Reference Socio-Economic
GETREFSTUDELMOD

GETREFERENCESTUDYDELIVERYMODE

Reference Study Delivery Mode

GETREFSTATUS

GETREFERENCEAPPLICANTSSTATUS

Reference Applicant Status

GETREFTARIFF

GETREFERENCETARIFFS

Reference Tariff

GETREFUNITS

GETREFERENCEUNITS

Reference Units

GETREFUOFABB

GETREFERENCEOWNOFFERABBREVIATI

Reference Own Offer Abbrev
GETREFVISIMIG

GETREFERENCEVISAORIMMIGRATIONS

Reference Visa/Immigration

Example of Setting Up a Service Operation

In this example, we'll set up GETREFERENCERESULTSREFRESHCONT. Once you've completed this, repeat steps 2 to 7 for the rest of the service operations, making sure you use the correct routing name and service operation each time.

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

  2. Click Add a New Value, then enter GETUCASREFCONTROL.

  3. On the Routing Definitions page, populate these fields:

    Field

    Value

    Service Operation

    Enter GETREFERENCERESULTSREFRESHCONT.

    Description

    Enter Reference Refresh Control.

    Sender Node

    Enter the local node of the environment you're using.

    Receiver Node

    Enter WSDL_NODE.

    Owner ID

    Enter Admissions - UK.

  4. On the Parameters page, do the following in these fields for Outbound Request and Inbound Request:

    • In External Alias for Outbound Response and Inbound Response, remove ".V1".

    • In Message.Ver into Transform 1, remove the value.

    • In Message.Ver out of Transforms, remove the value.

  5. On the Connector Properties page, fill out these fields:

    Field

    Description

    Gateway ID

    Enter LOCAL.

    Connector ID

    Enter HTTPTARGET.

  6. In the Connector Properties grid, do the following:

    1. Add a row for Property ID = HEADER.

      Field or Control

      Values

      Property Name

      Enter sendUncompressed.

      Value

      Enter Y.

    2. Add a row for Property ID = HTTPPROPERTY.

      Field or Control

      Values

      Property Name

      EnterMethod.

      Value

      Enter POST.

    3. Add a row for Property ID = PRIMARYURL.

      Field or Control

      Values

      Property Name

      EnterURL.

      Value

      Enter the URL for the UCAS XML link test or production environment. For example, for HEP1, the URL is https://hep1xmllink.ucasenvironments.com/xml-link/XmlLinkWS..

    4. Add another row a second Property ID = HEADER.

      Field or Control

      Values

      Property Name

      Enter Content-Type.

      Value

      Enter text/xml.

    5. Add another row for a second Property ID = HTTPPROPERTY.

      Field or Control

      Values

      Property Name

      EnterSOAPUpContent.

      Value

      Enter Y.

  7. Save your changes.