EdX Enterprise API Guide

• 1. Introduction
  • 1.1. About the edX Enterprise API
  • 1.2. Using the edX Enterprise API with Your Course Catalog
• 2. Authenticating as an edX REST Web Service User
  • 2.1. Obtaining an Access Token
• 3. EdX Enterprise API Reference
  • 3.1. Endpoints
  • 3.2. Returning Data in XML or JSON Format
  • 3.3. policy-allocation Endpoint
  • 3.4. subsidy_access_policies_list Endpoint
  • 3.5. assignment-configurations-list Endpoint
  • 3.6. assignment-configurations-remind Endpoint
  • 3.7. assignment-configurations-cancel Endpoint
  • 3.8. subscriptions Endpoint
  • 3.9. licenses/assign Endpoint
  • 3.10. licenses/bulk-revoke Endpoint
  • 3.11. /bulk-license-enrollment Endpoint
  • 3.12. enterprise-catalogs Endpoint
  • 3.13. enterprise-catalogs/{catalog_id} Endpoint
  • 3.14. enterprise-catalogs/{catalog_id}/courses/{course_key} Endpoint
  • 3.15. enterprise-catalogs/{catalog_id}/course-runs/{course_run_ID} Endpoint
  • 3.16. enterprise-catalogs/{catalog_id}/programs/{program_ID} Endpoint
  • 3.17. Course, Course Run, and Program Fields
  • 3.18. learner-summary Endpoint
• 4. EdX Reporting Services Reference
  • 4.1. xAPI Reporting Channel
  • 4.2. xAPI Event Delivery Mechanism:
  • 4.3. Sample Payload Data for edX xAPI Events