ILD Group API Documentation

The ILD Group service provides endpoints for managing groups and students within the educational platform.

Network Endpoints

Group Access

Get Group

  • Endpoint: GET /group/:groupId
  • Description: Retrieves a specific group through network access
  • Parameters:
  • groupId (path): Group identifier
  • Response: Group object

Private Endpoints

Group Management

Get Groups

  • Endpoint: GET /group
  • Description: Retrieves all groups for the authenticated user/team
  • Response: Array of group objects

Get Group

  • Endpoint: GET /group/:groupId
  • Description: Retrieves a specific group
  • Parameters:
  • groupId (path): Group identifier
  • Response: Group object

Create Group

  • Endpoint: POST /group
  • Description: Creates a new group
  • Request Body: Group configuration
  • Response: Created group object

Update Group

  • Endpoint: PUT /group/:groupId
  • Description: Updates an existing group
  • Parameters:
  • groupId (path): Group identifier
  • Request Body: Updated group configuration
  • Response: Updated group object

Delete Group

  • Endpoint: DELETE /group/:groupId
  • Description: Deletes a group
  • Parameters:
  • groupId (path): Group identifier

Student Management

Create Student

  • Endpoint: POST /group/:groupId/student
  • Description: Creates a new student in a group
  • Parameters:
  • groupId (path): Group identifier
  • Request Body: Student information
  • Response: Created student object

Update Student

  • Endpoint: PUT /group/:groupId/student/:studentId
  • Description: Updates a student's information
  • Parameters:
  • groupId (path): Group identifier
  • studentId (path): Student identifier
  • Request Body: Updated student information
  • Response: Updated student object

Delete Student

  • Endpoint: DELETE /group/:groupId/student/:studentId
  • Description: Removes a student from a group
  • Parameters:
  • groupId (path): Group identifier
  • studentId (path): Student identifier