Developers
The Service has been set up to enable educational organisations to securely share data about learners and providers.
The project has devised common data definitions, a set of unique identifiers, and a means of sharing data in a standard way across the education sector. The Learner Register Secure Portal provides three different development routes to suit different communities. The LRS supports development for:
- A web-based service interface
- A role-based data access model
- A batch load file for verification of ULNs (for awarding organisation use only)
If you want to develop an interface using one of these routes then see below for details.
If you are installing or going to use a web service which has already been developed, find out how to establish a web service connection to the production area.
Developing a web-based service interface
To support developers integrating Management Information Systems (MIS) with the Learner Registration Service (LRS), we have created a software toolkit - the Developers Pack.
Developers need to register to gain access to the latest version of web services.You will need to complete and return a copy of the Developer Registration Form before we can provide you with access to the Developers Pack.
Once an application is received developers should receive a link, username and password within 48 hours to access the Developers’ Teamsite which contains the pack. The pack includes the following information:
- Web Services Interface Specification
- Schemas and WDSL
- A developer’s guide on web services development
- A Test Period Calendar for developers
- Web Services Test Instructions and forms for each stage of development
There is also a set of questions regarding your business solution - Business Model Questionnaire - which we recommend is completed and returned soon after development begins to ensure your development meets our requirements. If not, appropriate guidance can be given to you early on in your development.
If you have already registered and have any other questions, please read the FAQs.
Developing a batch load file for obtaining ULNs
You can build a file of learner details which you can load in the LRS via the portal interface in order to obtain ULNs. You do not need to register as a developer in order to use this interface.
Supporting documents can be found in the Document Library, or by using the links below:
- The Batch File Interface Pack
This provides all the information required to create a xml or csv batch file for uploading learner details to the Secure Portal.
Step One
Consider building the extract routine to create in the load file. Decide how frequently and when etc...
Step Two
Test the process. Do not test against the live service.
Step Three
Transition your batch load process into business as usual establishing your procedures for this. Included in this you need to know what you are going to do with the exceptions (refer to the Interpreting Batch Return Codes Guide).
Developing a batch load file for verifying ULNs
You can build a file of learner details which you can load in the Learner Register via the portal interface in order to check that ULNs that you already have recorded match the details on our system. This interface is only available to awarding organisations and is not available for general use. You do not need to register as a developer in order to use this interface but access to the functionality to allow the submission of the batch load file is restricted to awarding organisations.
You will need to complete and return a copy of the Developer Registration Form before we can provide you with access to the appropriate documentation and the Developers Pack.
