🗃️Endpoints - Les cours

Lister les cours du Spot

get

Get Courses

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

status[eq]string · enumOptionnel

Search Course with a specific status

Available options:

status[in]string · enum[]Optionnel

Search Course which have the following statuses

privacy[eq]string · enumOptionnel

Search Course with a specific privacy

Available options:

privacy[in]string · enum[]Optionnel

Search Course which have the following privacy

Réponses

application/json

objectOptionnel

get

HTTPcURLJavaScriptPython

GET /v1/courses HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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

Associer des groupes à un cours

post

Link groups to a course

Paramètres de chemin

courseIdstringRequis

The id of the course

Corps

groupIdsstring[]Requis

The ids of the groups to link

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Réponses

post

HTTPcURLJavaScriptPython

POST /v1/courses/{courseId}/groups~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "groupIds": [
    "text"
  ],
  "withEmailNotification": true
}

Aucun contenu

Inviter plusieurs membres à un cours

post

Invite a members as Course participants

Paramètres de chemin

courseIdstringRequis

The id of the course

Corps

spotMemberIdsstring[]Requis

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

invitedBySpotMemberIdstringOptionnel

The Spot member ID on the initiative of the invitation

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Réponses

application/json

post

HTTPcURLJavaScriptPython

POST /v1/courses/{courseId}/participants~bulkInvite HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "spotMemberIds": [
    "text"
  ],
  "invitedBySpotMemberId": "text",
  "withEmailNotification": true
}

Aucun contenu

Désassocier des groupes d'un cours

post

Unlink groups from a course

Paramètres de chemin

courseIdstringRequis

The id of the course

Corps

groupIdsstring[]Requis

The ids of the groups to link

Réponses

post

HTTPcURLJavaScriptPython

POST /v1/courses/{courseId}/groups~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "groupIds": [
    "text"
  ]
}

Aucun contenu

Lister les participants d'un cours

get

Get Courses participants

Paramètres de chemin

courseIdstringRequis

The id of the course

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

firstname[in]string[]Optionnel

The firstnames of spot member to include in the result

lastname[in]string[]Optionnel

The lastnames of spot member to include in the result

email[in]string[]Optionnel

The emails of spot member to include in the result

status[eq]string · enumOptionnel

Search participants with a specific status

Available options:

status[in]string · enum[]Optionnel

Search participants with one of theses status

Réponses

application/json

objectOptionnel

get

HTTPcURLJavaScriptPython

GET /v1/courses/{courseId}/participants HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "items": [
    {
      "id": "text",
      "courseId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "status": "Invited",
      "invitedAt": "2025-04-24T08:14:28.683Z",
      "startedAt": "2025-04-24T08:14:28.683Z",
      "completedAt": "2025-04-24T08:14:28.683Z",
      "unenrolledAt": "2025-04-24T08:14:28.683Z",
      "lastActivityAt": "2025-04-24T08:14:28.683Z",
      "completionRate": 1
    }
  ],
  "total": 1
}

Inviter un membre à un cours

post

Invite a member as Course participant

Paramètres de chemin

courseIdstringRequis

The id of the course

Corps

spotMemberIdstringRequis

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

invitedBySpotMemberIdstringOptionnel

The Spot member ID on the initiative of the invitation

withEmailNotificationbooleanOptionnel

Set to true to send notification mail to each invited members

Réponses

application/json

post

HTTPcURLJavaScriptPython

POST /v1/courses/{courseId}/participants HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "spotMemberId": "text",
  "invitedBySpotMemberId": "text",
  "withEmailNotification": true
}

Aucun contenu