Documentation Kenii Catalog Reference
REST API
All REST routes in this module with their methods and required permissions.
REST API
Generated from code at version 2.13.0. Do not edit by hand; run the reference generator to refresh.
All routes are under the kenii/v1 namespace. Admin routes require a signed-in staff session (kenii_manage_catalog or manage_options). Public API routes read with an API key.
Example
Read the public catalog with an API key:
curl -H "X-Kenii-API-Key: YOUR_KEY"
https://your-college.edu/wp-json/kenii/v1/api/programsTotal routes: 97.
Admin routes (authenticated staff, gated by kenii_manage_catalog or manage_options)
| Route | Methods | Permission |
|---|---|---|
/kenii/v1/admin/academic-year/create |
POST | (default) |
/kenii/v1/admin/addenda/(?P<id>d+) |
PUT DEL | (default) |
/kenii/v1/admin/api-keys |
GET POST | (default) |
/kenii/v1/admin/api-keys/(?P<prefix>[a-zA-Z0-9_]+) |
DEL | (default) |
/kenii/v1/admin/archive-settings |
GET POST | (default) |
/kenii/v1/admin/archive-settings/(?P<post_type>[a-z0-9_]+)/taxonomies |
GET | (default) |
/kenii/v1/admin/articulations |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/articulations/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/articulations/import |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/articulations/import-csv |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/audit-log |
GET | (default) |
/kenii/v1/admin/audit-log/recent |
GET | (default) |
/kenii/v1/admin/campuses |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/campuses/(?P<id>d+) |
GET POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/catalog-years |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+) |
POST DEL | (default) |
/kenii/v1/admin/catalog-years/(?P<id>d+)/calendar-pdf |
POST | (default) |
/kenii/v1/admin/catalog-years/(?P<id>d+)/clone |
POST | (default) |
/kenii/v1/admin/catalog-years/(?P<id>d+)/lock |
POST | (default) |
/kenii/v1/admin/catalog-years/(?P<id>d+)/regenerate-pdf |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/catalog-years/(?P<id>d+)/visibility |
POST | (default) |
/kenii/v1/admin/catalog-years/(?P<year_id>d+)/addenda |
GET POST | (default) |
/kenii/v1/admin/catalog-years/diff |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/catalog-years/set-active |
POST | (default) |
/kenii/v1/admin/clear-cache |
POST | (default) |
/kenii/v1/admin/convert-credential-to-course |
POST | kenii_admin_session_permission_check |
/kenii/v1/admin/course-prefixes |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/course-prefixes/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/course-usage/(?P<id>d+) |
GET | (default) |
/kenii/v1/admin/courses |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/courses/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/create-pages |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/credential-types |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/credential-types/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/credentials |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/credentials/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/delivery-modes |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/delivery-modes/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/handbook |
GET POST | (default) |
/kenii/v1/admin/handbook/(?P<id>d+) |
POST DEL | (default) |
/kenii/v1/admin/handbook/clone |
POST | (default) |
/kenii/v1/admin/handbook/reorder |
POST | (default) |
/kenii/v1/admin/handbook/restructure |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/handbook/rollback |
POST | kenii_api_admin_permission_check |
/kenii/v1/admin/license |
GET | kenii_license_rest_permission |
/kenii/v1/admin/license/account |
GET | kenii_license_rest_permission |
/kenii/v1/admin/license/portal |
POST | kenii_license_rest_permission |
/kenii/v1/admin/license/verify |
POST | kenii_license_rest_permission |
/kenii/v1/admin/my-work |
GET | kenii_admin_session_permission_check |
/kenii/v1/admin/notify-prefs |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/policies |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/policies/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/program-areas |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/program-areas/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/program-types |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/program-types/(?P<id>d+) |
POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/rebuild-junction |
POST | (default) |
/kenii/v1/admin/support |
POST | kenii_support_permission_check |
/kenii/v1/admin/team |
GET POST | (default) |
/kenii/v1/admin/team/(?P<id>d+) |
DEL | (default) |
/kenii/v1/admin/terms |
GET POST | kenii_admin_session_permission_check |
/kenii/v1/admin/terms/(?P<id>d+) |
GET POST DEL | kenii_admin_session_permission_check |
/kenii/v1/admin/terms/(?P<id>d+)/clone-dates |
POST | (default) |
/kenii/v1/admin/terms/(?P<id>d+)/cloneable-sources |
GET | (default) |
/kenii/v1/admin/year/(?P<id>d+)/archive |
POST | kenii_api_admin_permission_check |
Public API routes (read via API key; writes require manage_options)
| Route | Methods | Permission |
|---|---|---|
/kenii/v1/api/academic-year/create |
POST | (default) |
/kenii/v1/api/addenda |
GET | kenii_api_permission_check |
/kenii/v1/api/articulations |
GET | kenii_api_permission_check |
/kenii/v1/api/audit-log |
GET | kenii_api_admin_permission_check |
/kenii/v1/api/audit-log/recent |
GET | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years/(?P<id>d+)/calendar-pdf |
POST | (default) |
/kenii/v1/api/catalog-years/(?P<id>d+)/clone |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years/(?P<id>d+)/lock |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years/(?P<id>d+)/visibility |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/catalog-years/set-active |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/courses |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/courses/(?P<id>d+) |
POST DEL | kenii_api_admin_permission_check |
/kenii/v1/api/credentials |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/credentials/(?P<id>d+) |
POST DEL | kenii_api_admin_permission_check |
/kenii/v1/api/dashboard |
GET | kenii_api_permission_check |
/kenii/v1/api/export |
GET | kenii_api_permission_check |
/kenii/v1/api/programs |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/programs/(?P<id>d+) |
POST DEL | kenii_api_admin_permission_check |
/kenii/v1/api/settings |
GET | kenii_api_permission_check |
/kenii/v1/api/terms |
GET POST | kenii_api_admin_permission_check |
/kenii/v1/api/terms/(?P<id>d+) |
GET POST DEL | kenii_api_admin_permission_check |
/kenii/v1/api/terms/(?P<id>d+)/clone-dates |
POST | kenii_api_admin_permission_check |
/kenii/v1/api/terms/(?P<id>d+)/cloneable-sources |
GET | kenii_api_permission_check |
Other routes
| Route | Methods | Permission |
|---|---|---|
/kenii/v1 |
GET | public |
/kenii/v1/admin |
GET | public |
/kenii/v1/breadcrumb/(?P<id>d+) |
GET | __return_true |
/kenii/v1/catalog-pdf/(?P<id>d+) |
GET | __return_true |
/kenii/v1/catalog-pdf/active |
GET | __return_true |
/kenii/v1/credential/(?P<id>d+)/data |
GET | __return_true |
/kenii/v1/credential/(?P<id>d+)/requirements |
GET | __return_true |
/kenii/v1/program/(?P<id>d+)/data |
GET | __return_true |