🗃️Endpoints - Courses

Get courses

Get Courses

GEThttps://openapi.meltingspot.io/v1/courses

Query parameters

Response

200400

Courses returned successfully

Body

application/json

items*array of CourseApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/courses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "privacy": "Secret",
      "status": "Draft"
    }
  ]
}

Link groups to a course

Link groups to a course

POSThttps://openapi.meltingspot.io/v1/courses/{courseId}/groups~bulkAdd

Path parameters

courseId*string

The id of the course

Body

application/json

groupIds*array of string

The ids of the groups to link

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

204400

Groups linked successfully

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/courses/{courseId}/groups~bulkAdd', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Unlink groups from a course

Unlink groups from a course

POSThttps://openapi.meltingspot.io/v1/courses/{courseId}/groups~bulkRemove

Path parameters

courseId*string

The id of the course

Body

application/json

groupIds*array of string

The ids of the groups to link

Response

204400

Groups unlinked successfully

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/courses/{courseId}/groups~bulkRemove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Gest courses participants

Get Courses participants

GEThttps://openapi.meltingspot.io/v1/courses/{courseId}/participants

Path parameters

courseId*string

The id of the course

Query parameters

Response

200400404

Courses participants returned successfully

Body

application/json

items*array of CourseParticipantApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/courses/{courseId}/participants', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "courseId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "status": "Invited",
      "invitedAt": "2024-11-21T10:06:45.342Z",
      "startedAt": "2024-11-21T10:06:45.342Z",
      "completedAt": "2024-11-21T10:06:45.342Z",
      "unenrolledAt": "2024-11-21T10:06:45.342Z",
      "lastActivityAt": "2024-11-21T10:06:45.342Z"
    }
  ]
}

Invite a member as course participant

Invite a member as Course participant

POSThttps://openapi.meltingspot.io/v1/courses/{courseId}/participants

Path parameters

courseId*string

The id of the course

Body

application/json

spotMemberId*string

An uuid representing the unique identifier of the spot member to add to course

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

200201400

Member already invited

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/courses/{courseId}/participants', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spotMemberId": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "courseId": "text",
  "spotMemberId": "text",
  "spotMemberEmail": "text",
  "status": "Invited",
  "invitedAt": "2024-11-21T10:06:45.342Z",
  "startedAt": "2024-11-21T10:06:45.342Z",
  "completedAt": "2024-11-21T10:06:45.342Z",
  "unenrolledAt": "2024-11-21T10:06:45.342Z",
  "lastActivityAt": "2024-11-21T10:06:45.342Z"
}

Invite multiple members as course participants

Invite a members as Course participants

POSThttps://openapi.meltingspot.io/v1/courses/{courseId}/participants~bulkInvite

Path parameters

courseId*string

The id of the course

Body

application/json

spotMemberIds*array of string

An array of uuid representing the unique identifier of the spot members to add to course

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

200201400

Members already invited

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/courses/{courseId}/participants~bulkInvite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spotMemberIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

201

[
  {
    "id": "text",
    "courseId": "text",
    "spotMemberId": "text",
    "spotMemberEmail": "text",
    "status": "Invited",
    "invitedAt": "2024-11-21T10:06:45.342Z",
    "startedAt": "2024-11-21T10:06:45.342Z",
    "completedAt": "2024-11-21T10:06:45.342Z",
    "unenrolledAt": "2024-11-21T10:06:45.342Z",
    "lastActivityAt": "2024-11-21T10:06:45.342Z"
  }
]