/programs

Collection of programs in a system, federation of systems, or in a default courseCatalog.

get

Get all programs in the system or default courseCatalog.

post

Create a new program in the default courseCatalog.

Entity representing a program form metadata.

get

Get form metadata for creating a new program.

Entity representing a program

get

Get a program given its id.

put

Update a given program.

delete

Delete a given program.

Entity representing a program form metadata for update

get

Get form metadata for updating an existing program.

get

Get expanded completion requirements requisite tree structures. All supporting requisiteOptions, programRequirements, Programs, Program completionRequirements, and requisiteRequirements will be recursively expanded for bulk consumption. All credentialRequirements, assessmentRequirement, learningObjectiveRequirements and awardRequirements will be expanded. All courseRequirements will be expanded but related Courses and preRequisites will only be expanded if expandCourses = true.

get

Get completed requirements map for the given student Id

Query the collection of completions in a system, federation of systems, or in a default courseCatalog by posting a Query object.

post

Submit a query using a CompletionQuery object.

/program-offerings

Collection of program-offerings in a system, federation of systems, or in a default courseCatalog.

get

Get all program-offerings in the system or default courseCatalog.

post

Create a new program-offering in the default courseCatalog.

Entity representing a programOffering form metadata.

get

Get form metadata for creating a new programOffering.

Entity representing a program-offering

get

Get a program-offering given its id.

put

Update a given program-offering.

delete

Delete a given program-offering.

Entity representing a programOffering form metadata for update

get

Get form metadata for updating an existing programOffering.

/credentials

Collection of credentials in a system, federation of systems, or in a default courseCatalog.

get

Get all credentials in the system or default courseCatalog.

post

Create a new credential in the default courseCatalog.

Entity representing a credential form metadata.

get

Get form metadata for creating a new credential.

Entity representing a credential

get

Get a credential given its id.

put

Update a given credential.

delete

Delete a given credential.

Entity representing a credential form metadata for update

get

Get form metadata for updating an existing credential.

/enrollments

Collection of enrollments in a system, federation of systems, or in a default courseCatalog.

get

Get all enrollments in the system or default courseCatalog.

post

Create a new enrollment in the default courseCatalog.

Entity representing a enrollment form metadata.

get

Get form metadata for creating a new enrollment.

Entity representing a enrollment

get

Get a enrollment given its id.

put

Update a given enrollment.

delete

Delete a given enrollment.

Entity representing a enrollment form metadata for update

get

Get form metadata for updating an existing enrollment.

/course-catalogs

Collection of course-catalogs in a system or federation of systems.

get

Get all course-catalogs.

post

Create a new course-catalog.

Entity representing a courseCatalog form metadata.

get

Get form metadata for creating a new courseCatalog.

The root courseCatalogs in the courseCatalog hierarchy. A node with no parents is an orphan. While all courseCatalog Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

get

Get all root root-course-catalog

Entity representing a course-catalog

get

Get a course-catalog given its id.

put

Update a given course-catalog.

delete

Delete a given course-catalog.

Entity representing a courseCatalog form metadata for update

get

Get form metadata for updating an existing courseCatalog.

get

Get child courseCatalogs for the given courseCatalog in the hierarchy.

put

Add courseCatalog as child of the given courseCatalog in the hierarchy.

delete

Remove the given courseCatalog as a child of the given courseCatalog in the hierarchy.

get

Get parent courseCatalogs for the given courseCatalog in the hierarchy.

get

Get all programs in this courseCatalog

put

Add the given program to this courseCatalog

delete

Remove the given program from the courseCatalog.

get

Get all program-offerings in this courseCatalog

put

Add the given program-offering to this courseCatalog

delete

Remove the given program-offering from the courseCatalog.

get

Get all credentials in this courseCatalog

put

Add the given credential to this courseCatalog

delete

Remove the given credential from the courseCatalog.

get

Get all enrollments in this courseCatalog

put

Add the given enrollment to this courseCatalog

delete

Remove the given enrollment from the courseCatalog.