CampusAPI Services API documentation
This document serves as an index of draft CampusAPI RESTful service documentation for service protocols that can be exposed from DXtera's Enterprise Service Hub. Integration with the Service Hub is achieve through implementation of Open Service Interface Definitions (OSIDs) with required campus enterprise systems.
The pages linked below describe foundational protocol endpoints designed to align as closely as practicable with the highly normalized, holistic interface models and specifications of the OSIDs. This strict alignment with the underlying OSID specifications may come at the expense of application performance and developer convenience.
In addition DXtera works with its members as required to design optimized application service APIs. While remaining aligned with the underlying models of the OSIDs, these can be tailored to orchestrate functionality across multiple services to help streamline serialized service calls for a particular application or class of applications.
The following draft APIs support typical Student Information System functionalities:
|The Course package defines course management services for educational offerings or other learning units related to an event or curriculum.
|The Program package provides management services related to programs.
|The Registration services provide functionality for managing student registrations for courses and course activities.
|The Chronicle package provides services for examining the academic record.
|The Requisite service package defines the rules to be managed and evaluated to determine whether educational requirements have been satisfied.
The following draft APIs support curricular design and lesson planning functionalities:
|The Syllabus package manages curriculum within a Course and relating the material to learning Objectives to create lesson plans.
|The Plan package maps syllabi defined in the Course Syllabus package to scheduled Activities to manage the logistics of following a lesson plan during an offering of a course.
The following draft APIs support learning and knowledge related functionalities:
|The Learning services manage learning objectives, competencies, skills, etc.
|The Assessment package provides the means to create, access, and take assessments.
|The Repository package provides the services for finding, accessing and managing digital assets.
|The Grading service package defines functions for applying and managing grades or ratings.
The following draft APIs support people, organization and HR related functionalities:
|The Personnel services define people and organizations.
|The Recognition services confer Awards onto Resources (typically people)
|The Acknowledgement service package defines and relates credits such as authors or creators to other entities.
|The Resourcing service package provides a means for resourcing work.
The following draft APIs support financial and billing related functionalities:
|The Financials services provide management of financial data through G/L accounts, activity accounts, budgeting, and posting transactions.
|The Budgeting service package manages budgets.
|The Posting service package manages accounting transactions.
|The Billing service package manages billing for customers.
|The Payment service package manages billing payments.
The following draft APIs support communication and community functionalities:
|The Messaging service package manages sending and receiving of messages.
|The Blogging service package manages blogs and blog Entries.
|The Forum service package defines threaded diiscussion groups managing a set of posts and replies.
The following draft APIs support auxilliary functionalities:
|The Authorization service package manages and queries authorizations.
|The Ontology package defines auxiliary services used to manage subject matter that can be related to other entities.
|The Logging service package provides a means to read and write to logs.
|The Relationship package provides the ability to relate and manage data between any other objects.
|The Contact package defines auxiliary services that relates contact information to other objects.
|The Commenting service package provides a means of relating user comments and ratings to other objects.
|The Hold services provide a means for manging "blacklists" or user blocks. Hold adds the concept of "except for" across the CampusAPI service environment.
|The Configuration package defines a set of services for configuration retrieval and management.
|The Calendaring service manage events, commitments and calendars. Calendaring offers a rich set of event management services.
|The Mapping service provides a means for managing inventories of places and performing a variety of mapping operations.
CampusAPI REST Documentation Copyright 2023 DXtera Institute. Based on the Open Service Interface Definitions: http://osid.org