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
      • 2.1.1. Understanding the Authentication Endpoint Response
  • 3. EdX Enterprise API Reference
    • 3.1. Endpoints
    • 3.2. Returning Data in XML or JSON Format
    • 3.3. enterprise-catalogs Endpoint
      • 3.3.1. Method and Endpoint
      • 3.3.2. Example Request
      • 3.3.3. Response Values
    • 3.4. enterprise-catalogs/{catalog_id} Endpoint
      • 3.4.1. Method and Endpoint
      • 3.4.2. Example Request
      • 3.4.3. Parameters
      • 3.4.4. Response Values
    • 3.5. enterprise-catalogs/{catalog_id}/courses/{course_key} Endpoint
      • 3.5.1. Method and Endpoint
      • 3.5.2. Example Request
      • 3.5.3. Response Values
    • 3.6. enterprise-catalogs/{catalog_id}/course-runs/{course_run_ID} Endpoint
      • 3.6.1. Method and Endpoint
      • 3.6.2. Example Request
      • 3.6.3. Response Values
    • 3.7. enterprise-catalogs/{catalog_id}/programs/{program_ID} Endpoint
      • 3.7.1. Method and Endpoint
      • 3.7.2. Example Request
      • 3.7.3. Response Values
    • 3.8. Course, Course Run, and Program Fields
      • 3.8.1. Fields in a course Content Item
      • 3.8.2. Fields in a course_run Content Item
      • 3.8.3. Fields in a program Content Item
      • 3.8.4. Example Response Showing Information about a Course Run
    • 3.9. learner-summary Endpoint
      • 3.9.1. Method and Endpoint
      • 3.9.2. Example Request
      • 3.9.3. Response Values
  • 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
      • 4.3.1. Learner registered (enrolled) in a course.
      • 4.3.2. Learner completed a course.
 
EdX Enterprise API Guide
  • Table of Contents »
  • EdX Enterprise API Guide
  • Give Doc Feedback Edit on GitHub

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. enterprise-catalogs Endpoint
    • 3.4. enterprise-catalogs/{catalog_id} Endpoint
    • 3.5. enterprise-catalogs/{catalog_id}/courses/{course_key} Endpoint
    • 3.6. enterprise-catalogs/{catalog_id}/course-runs/{course_run_ID} Endpoint
    • 3.7. enterprise-catalogs/{catalog_id}/programs/{program_ID} Endpoint
    • 3.8. Course, Course Run, and Program Fields
    • 3.9. 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
Next

Copyright © 2023, edX Inc.
Creative Commons License
These works by edX Inc. are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.