ILD Learning Design API Documentation

The ILD Learning Design service provides endpoints for managing learning designs, their components, and related resources within the educational platform.

Private Endpoints

Learning Design Management

Read Learning Designs

• Endpoint: GET /read
• Description: Retrieves all learning designs for the authenticated user/team
• Response: Array of learning design objects

Find Learning Designs

• Endpoint: GET /find
• Description: Searches for learning designs based on criteria
• Response: Array of matching learning design objects

Get Learning Design Statistics

• Endpoint: GET /statistics
• Description: Retrieves statistics about learning designs
• Response: Learning design statistics object

Create Learning Design

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

Read Learning Design

• Endpoint: GET /read/:learningDesignId
• Description: Retrieves a specific learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• Response: Learning design object

Update Learning Design

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

Delete Learning Design

• Endpoint: DELETE /delete/:learningDesignId
• Description: Deletes a learning design
• Parameters:
• learningDesignId (path): Learning design identifier

Apply Template to Learning Design

• Endpoint: POST /template/:learningDesignId
• Description: Applies a template to a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• Request Body: Template configuration
• Response: Updated learning design object

Reset Learning Design Component Order

• Endpoint: PUT /:learningDesignId/order
• Description: Resets the order of components in a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• Response: Updated component order

Learning Design Components

Read Learning Design Component

• Endpoint: GET /:learningDesignId/read/:componentId
• Description: Retrieves a specific component from a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• componentId (path): Component identifier
• Response: Component object

Create Learning Design Component

• Endpoint: POST /:learningDesignId/component
• Description: Creates a new component in a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• Request Body: Component configuration
• Response: Created component object

Update Learning Design Component

• Endpoint: PUT /:learningDesignId/component/:componentId
• Description: Updates a component in a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• componentId (path): Component identifier
• Request Body: Updated component configuration
• Response: Updated component object

Component Groups

Create Component Group

• Endpoint: POST /:learningDesignId/component/group
• Description: Creates a new component group in a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• Request Body: Group configuration
• Response: Created group object

Update Component Group

• Endpoint: PUT /:learningDesignId/component/group/:groupId
• Description: Updates a component group in a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• groupId (path): Group identifier
• Request Body: Updated group configuration
• Response: Updated group object

Delete Component Group

• Endpoint: DELETE /:learningDesignId/component/group/:groupId
• Description: Deletes a component group from a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• groupId (path): Group identifier

ZIM Data Management

Create ZIM Data

• Endpoint: POST /:learningDesignId/zim
• Description: Creates ZIM data for a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• Request Body: ZIM data configuration
• Response: Created ZIM data object

Update ZIM Data

• Endpoint: PUT /:learningDesignId/zim/:zimId
• Description: Updates ZIM data for a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• zimId (path): ZIM data identifier
• Request Body: Updated ZIM data configuration
• Response: Updated ZIM data object

Update ZIM Data Order

• Endpoint: PUT /:learningDesignId/zim/order
• Description: Updates the order of ZIM data in a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• Request Body: Order configuration
• Response: Updated ZIM data order

Public Endpoints

Learning Design Access

Read Public Learning Designs

• Endpoint: GET /read
• Description: Retrieves all public learning designs
• Response: Array of learning design objects

Find Public Learning Designs

• Endpoint: GET /find
• Description: Searches for public learning designs based on criteria
• Response: Array of matching learning design objects

Read Learning Design

• Endpoint: GET /read/:learningDesignId
• Description: Retrieves a specific public learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• Response: Learning design object

Get Learning Design Statistics

• Endpoint: GET /statistics
• Description: Retrieves public statistics about learning designs
• Response: Learning design statistics object

Read Learning Design Component Children

• Endpoint: GET /children/:learningDesignId/:componentId
• Description: Retrieves child components of a specific component in a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• componentId (path): Component identifier
• Response: Array of child component objects

Read Learning Design ZIM Data

• Endpoint: GET /:learningDesignId/zim/:componentId
• Description: Retrieves ZIM data for a specific component in a learning design
• Parameters:
• learningDesignId (path): Learning design identifier
• componentId (path): Component identifier
• Response: ZIM data object

Get Learning Designs by IDs

• Endpoint: POST /read/byids
• Description: Retrieves multiple learning designs by their IDs
• Request Body: json { "ids": ["string"] }
• Response: Array of learning design objects

Network Endpoints

Curriculum Integration

Count Learning Designs by Curriculum Node

• Endpoint: GET /curriculum/count/:nodeId
• Description: Counts the number of learning designs associated with a curriculum node
• Parameters:
• nodeId (path): Curriculum node identifier
• Response: Count object

Find Learning Designs by Curriculum Node

• Endpoint: GET /curriculum/find/:nodeId
• Description: Retrieves learning designs associated with a curriculum node
• Parameters:
• nodeId (path): Curriculum node identifier
• Response: Array of learning design objects

Storage and Statistics

Calculate Learning Design Size

• Endpoint: GET /storage
• Description: Calculates the total storage size of learning designs
• Response: Storage size object

Get Learning Design Categories

• Endpoint: GET /category/learningdesign
• Description: Retrieves all learning design categories
• Response: Array of category objects

Get Learning Design Attributes Count

• Endpoint: GET /statistics/attributes
• Description: Retrieves statistics about learning design attributes
• Response: Attributes statistics object

Force Graph Data

Get Force Graph Data

• Endpoint: GET /forcedata
• Description: Retrieves force graph data for learning designs
• Response: Force graph data object

Get Force Increment

• Endpoint: GET /forceincrement
• Description: Retrieves force increment data for learning designs
• Response: Force increment data object