CampusAPI Services API documentation

Overview

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:

Package	Description
Course Services	The Course package defines course management services for educational offerings or other learning units related to an event or curriculum.
Program Services	The Program package provides management services related to programs.
Registration Services	The Registration services provide functionality for managing student registrations for courses and course activities.
Chronicle Services	The Chronicle package provides services for examining the academic record.
Requisite Services	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:

Package	Description
Syllabus Services	The Syllabus package manages curriculum within a Course and relating the material to learning Objectives to create lesson plans.
Plan Services	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:

Package	Description
Learning Services	The Learning services manage learning objectives, competencies, skills, etc.
Assessment Services	The Assessment package provides the means to create, access, and take assessments.
Repository Services	The Repository package provides the services for finding, accessing and managing digital assets.
Grading Services	The Grading service package defines functions for applying and managing grades or ratings.

The following draft APIs support people, organization and HR related functionalities:

Package	Description
Personnel Services	The Personnel services define people and organizations.
Recognition Services	The Recognition services confer Awards onto Resources (typically people)
Acknowledgement Services	The Acknowledgement service package defines and relates credits such as authors or creators to other entities.
Resourcing Services	The Resourcing service package provides a means for resourcing work.

The following draft APIs support financial and billing related functionalities:

Package	Description
Financials Services	The Financials services provide management of financial data through G/L accounts, activity accounts, budgeting, and posting transactions.
Budgeting Services	The Budgeting service package manages budgets.
Posting Services	The Posting service package manages accounting transactions.
Billing Services	The Billing service package manages billing for customers.
Payment Services	The Payment service package manages billing payments.

The following draft APIs support communication and community functionalities:

Package	Description
Messaging Services	The Messaging service package manages sending and receiving of messages.
Blogging Services	The Blogging service package manages blogs and blog Entries.
Forum Services	The Forum service package defines threaded diiscussion groups managing a set of posts and replies.

The following draft APIs support auxilliary functionalities:

Package	Description
Authorization Services	The Authorization service package manages and queries authorizations.
Ontology Services	The Ontology package defines auxiliary services used to manage subject matter that can be related to other entities.
Logging Services	The Logging service package provides a means to read and write to logs.
Relationship Services	The Relationship package provides the ability to relate and manage data between any other objects.
Contact Services	The Contact package defines auxiliary services that relates contact information to other objects.
Commenting Services	The Commenting service package provides a means of relating user comments and ratings to other objects.
Hold Services	The Hold services provide a means for manging "blacklists" or user blocks. Hold adds the concept of "except for" across the CampusAPI service environment.
Configuration Services	The Configuration package defines a set of services for configuration retrieval and management.
Calendaring Services	The Calendaring service manage events, commitments and calendars. Calendaring offers a rich set of event management services.
Mapping Services	The Mapping service provides a means for managing inventories of places and performing a variety of mapping operations.

CampusAPI Services API documentation

Overview

License