ILD Curriculum API Documentation

The ILD Curriculum service provides endpoints for managing curricula, curriculum nodes, and their components within the educational platform.

Private Endpoints

Curriculum Management

Read Curricula

  • Endpoint: GET /read
  • Description: Retrieves all curricula for the authenticated user/team
  • Response: Array of curriculum objects

Find Curricula

  • Endpoint: GET /find
  • Description: Searches for curricula based on criteria
  • Response: Array of matching curriculum objects

Get Curriculum Statistics

  • Endpoint: GET /statistics
  • Description: Retrieves statistics about curricula
  • Response: Curriculum statistics object

Create Curriculum

  • Endpoint: POST /create
  • Description: Creates a new curriculum
  • Request Body: Multipart form data
  • placeholder (file): Curriculum placeholder image
  • Other curriculum configuration fields
  • Response: Created curriculum object

Update Curriculum

  • Endpoint: PUT /update/:curriculumId
  • Description: Updates an existing curriculum
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • Request Body: Multipart form data
  • placeholder (file): Updated curriculum placeholder image
  • Other curriculum configuration fields
  • Response: Updated curriculum object

Delete Curriculum

  • Endpoint: DELETE /delete/:curriculumId
  • Description: Deletes a curriculum
  • Parameters:
  • curriculumId (path): Curriculum identifier

Resync Curriculum

  • Endpoint: PUT /resync/:curriculumId
  • Description: Resynchronizes a curriculum's data
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • Response: Resync status

Index Curriculum

  • Endpoint: PUT /index/:curriculumId
  • Description: Reindexes a curriculum's content
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • Response: Indexing status

Read Single Curriculum

  • Endpoint: GET /read/:curriculumId
  • Description: Retrieves a specific curriculum
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • Response: Curriculum object

Curriculum Nodes

Read Curriculum Nodes

  • Endpoint: GET /read/:curriculumId/nodes
  • Description: Retrieves all nodes for a curriculum
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • Response: Array of curriculum node objects

Create Curriculum Node

  • Endpoint: POST /read/:curriculumId/create
  • Description: Creates a new node in a curriculum
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • Request Body: Node configuration
  • Response: Created node object

Curriculum Flow

Create Curriculum Flow Node

  • Endpoint: POST /flow/:curriculumId/node
  • Description: Creates a new flow node in a curriculum
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • Request Body: Flow node configuration
  • Response: Created flow node object

Update Curriculum Flow

  • Endpoint: PUT /flow/:curriculumId
  • Description: Updates the flow structure of a curriculum
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • Request Body: Flow configuration
  • Response: Updated flow object

Delete Curriculum Flow Node

  • Endpoint: DELETE /flow/:curriculumId/node/:nodeId
  • Description: Deletes a flow node from a curriculum
  • Parameters:
  • curriculumId (path): Curriculum identifier
  • nodeId (path): Node identifier

Curriculum Node Components

Create Curriculum Node Component

  • Endpoint: POST /node/:nodeId/component
  • Description: Creates a new component in a curriculum node
  • Parameters:
  • nodeId (path): Node identifier
  • Request Body: Component configuration
  • Response: Created component object

Update Curriculum Node Component

  • Endpoint: PUT /node/:nodeId/component/:componentId
  • Description: Updates a component in a curriculum node
  • Parameters:
  • nodeId (path): Node identifier
  • componentId (path): Component identifier
  • Request Body: Updated component configuration
  • Response: Updated component object

Reset Curriculum Node Component Order

  • Endpoint: PUT /node/:nodeId/component/order/reset
  • Description: Resets the order of components in a curriculum node
  • Parameters:
  • nodeId (path): Node identifier
  • Response: Updated component order