Setup - What you need to know to get up and running
API Account
Once you have discussed your integration with your Digital Solutions Manager or Digital Support Representative you will then be provided with a USERNAME and PASSWORD. This will be used in the Authenticate Method which will generate your ACCESS TOKEN which needs to be used on all subsequent API calls.
Each API account is restricted via IP address. This helps to prevent any unauthorised access to your data. When you are requesting your API account you will be asked to provide external IP addresses for every server you may want to use to request data from the API - this can include any development and production environments you may use. Please ensure these are correct or you will be unable to Authenticate.
Frameworks
Where Frameworks are required in Learning Assistant (i.e. apprenticeships) the primary Course QAN identity must be set against the Framework identity.
- The QANs must be unique and if a Courses QAN is used for a Framework, it cannot also exist in Learning Assistant as a standalone course. Learners on this course will use the Framework course as well.
- Units from Courses across the Framework i.e. functional skills and tech certs must be included as optional units on the framework course inside Learning Assistant.
- The MIS must send over the main QAN as part of enrolment to identify the Framework but also all the UANs across the learner's courses. This will enable the student to be on the units appropriate to their Framework.
Enrolment Data
Mandatory fields for learner enrolments with Learning Assistant are:
- First Name
- Surname
- Gender
- Company
- Primary Assessor
- Primary Verifier
- Course
-
Additional fields can be set to mandatory, depending on system set up:
- Date of Birth LA Connect Enabled
- Email address Configurable
- Purchase Order number LA Connect Enabled
For integration to take place all Frameworks, Courses, Units, Companies and Trainers must exist in Learning Assistant. Integration can only take place with MIS data that has the correct QAN and UAN codes stored against them. This is what Learning Assistant uses to match its records to MIS data.