Learner Record Gateway Packages API documentation

Overview

The Learner Record Gateway (LRG) service profiles are sets of CampusAPI services to help provision applications that access individual learner records, like issuance of verifiable credentials into credential wallets or other credential persistence software. DXtera is developing an open-source middleware framework that can be deployed at institutions of higher education to provide standardized API access to relevent and curated learner record information managed in SIS, LMS and other campus systems.

This is an initial draft of these profiles. While they already represent production tested CampusAPI services, they are likely to change some as the LRG framework undergoes further deployment. Certain operations may be added or re-organized through developer feedback. This documentation will likely be extended.

Three draft service packages are currently being defined:

Transactional Record Provisioning Services

This service profile is designed for credential issuing applications that require transactional provisioning. In transactional provisioning, a system event and/or the learner themselves triggers the assembly of the LER data and issuance of credentials in real time from operational data in source systems or related operational data stores (ODSs) or data marts. Transactional issuing services require that the agent triggering credential issuance be authenticated via an institutional single sign on (SSO) service, or related authentication process. Link here.

ETL Record Provisioning Services

This service profile is designed for credential issuing applications that require Extract, Transform and Load (ETL) provisioning. Such credential issuing systems typically store representations of all required student records internally for processing. The ETL record provisioning service package provides API endpoints that loading processes can use to tranform operational data into the native format of an ETL based issuing service. Link here.

PII Provisioning Services

This service profile is designed to expose personally identifiable information (PII). While not typically required for assembling learner records for issuing digital credentials, it may be required for matching processes aimed at uniquely identifying individuals and for de-duplicating learners across disparete systems of record.

Administrative Services

The administrative service profile will include APIs required by administrative tools for managing the Learner Record Gateway middleware itself. This is still under construction. Link here.

License

CampusAPI REST Definitions © 2025 by DXtera Institute - licensed under CC BY-ND 4.0 Based on the Open Service Interface Definitions: http://osid.org

Usage

This usage section is still under development