v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Trainings > Session

Create a new training session

Create a new training session, do not forget to make it child from a training class if you want it to be displayed in the frontend application.

post/api/2026-07-01/resources/trainings/sessions

Request body

namestring required

Session name

training_idstring required

Training this session belongs to

descriptionstring

Session specific description

training_class_idstring

Training class it belongs to

starts_atstring

Start date for the session, if scheduled, starts at and ends at needs to happen within the same day.

ends_atstring

End date for the session, if scheduled, starts at and ends at needs to happen within the same day.

due_datestring

Only necessary for self paced sessions.

durationstring

Duration in hours of the session

modality'online' | 'inperson' | 'mixed'

Online, In person or mixed

schedule'selfpaced' | 'scheduled'

Scheduled or Self paced. Scheduled needs to have a start time and end time within the same day, self paced can start and end in different days and specific time won't be shown in the frontend app.

linkstring

Link to join the session if it's online, or to access or download related material for the session.

locationstring

Place where the session will happen if modality is mixed or in person.

subsidizedboolean

Mark the session as subsidized

recurrentboolean
send_calendar_invitesboolean

Send calendar invites to attendees assigned to the session

Example request

{
  "name": "Session one",
  "description": "This is the first session of this training class",
  "duration": "1.5 => 1h 30m"
}

Response

CREATED

idstring required

id of the session

namestring required
training_idstring required

Identifier of the course

descriptionstring

Session description

training_class_idstring

Identifier of the group

starts_atstring

Date when the session should start

ends_atstring

Date when the session should end

due_datestring

Date when the session should end

durationstring

The duration in hours and minutes of the session

modality'online' | 'inperson' | 'mixed'

The mode the session will be handled, online, in person or hybrid.

schedule'scheduled' | 'selfpaced'

Session schedule information (scheduled, self-paced)

linkstring

The link to see material from the session

locationstring

The place where the session takes place

session_attendance_idsstring[]
session_feedback_idstring
subsidizedboolean required

if the session is subsidized

statusstring

Status of the session

parent_idstring

Id of the recurrent session that is parent of the current one

Example response

{
  "id": "1",
  "name": "Session 1",
  "training_id": "1",
  "description": "First session of group January 2025",
  "starts_at": "2025-02-04T10:31:48.000Z",
  "ends_at": "2025-02-04T10:31:48.000Z",
  "due_date": "2025-02-04",
  "duration": "2.5",
  "modality": "inperson",
  "schedule": "schedule",
  "link": "https://www.google.com",
  "location": "Address Street 1223",
  "session_attendance_ids": [
    "1"
  ],
  "session_feedback_id": "1",
  "status": "pending",
  "parent_id": "1"
}