API - Sessions
Récupération de la liste des sessions
Renvoie la liste de toutes les sessions de l'instance.
URL: https://my.vtsperform.com/api/client/session/all
Permission requise: SESSION_READ
Méthode: GET
Réponses:
| Code | Exemple |
| 200 (OK) |
[ |
|
400 (Bad request) |
{
|
| 401 (Unauthorized) |
{
|
| 403 (Forbidden) |
{
|
Récupération des détails d'une session
Renvoie les détails d'une session ainsi que la liste des activités et des participants.
URL: https://my.vtsperform.com/api/client/session/{session_id}
Permission requise: SESSION_READ
Méthode: GET
Réponses:
| Code | Exemple |
| 200 (OK) |
{
|
|
400 (Bad request) |
{
|
| 401 (Unauthorized) |
{
|
| 403 (Forbidden) |
{
|
Création d'une session
Créé une nouvelle session dans votre instance.
URL: https://my.vtsperform.com/api/client/session/
Permission requise: SESSION_EDIT
Méthode: POST
Paramètres:
| Paramètre | Type | Description |
| activity_ids* | array | Tableau contenant la liste des activités à ajouter dans la session |
| name* | string | Le nom de la session |
| description | string | La description de la session |
| start_date | datetime | Date de début de la session (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-01 09:00) |
| end_date | datetime | (optionnel) La date de fin de la session. Si elle n'est pas fournie, la session est toujours disponible. (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-31 23:59) |
| duration | integer | (optionnel) Le nombre de jours pendant lesquels la session sera disponible pour les participants une fois qu'ils auront été invités. Si défini, le champ end_date sera ignoré. |
| external_id | integer | Identifiant de la session dans une plateforme tierce |
Réponses:
| Code | Exemple |
| 200 (OK) |
{
|
|
400 (Bad request) |
{
|
| 401 (Unauthorized) |
{
|
| 403 (Forbidden) |
{
|
| 404 (Not Found) |
{
|
Modification d'une session
Modifie une session existante.
URL: https://my.vtsperform.com/api/client/session/{session_id}
Permission requise: SESSION_EDIT
Méthode: PATCH
Paramètres:
| Paramètre | Type | Description |
| activity_ids | array | Tableau contenant la liste des activités à ajouter dans la session |
| name | string | Le nom de la session |
| description | string | La description de la session |
| start_date | datetime | Date de début de la session (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-01 09:00) |
| end_date | datetime | (optionnel) La date de fin de la session. Si elle n'est pas fournie, la session est toujours disponible. (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-31 23:59) |
| duration | integer | (optionnel) Le nombre de jours pendant lesquels la session sera disponible pour les participants une fois qu'ils auront été invités. Si défini, le champ end_date sera ignoré. |
Réponses:
| Code | Exemple |
| 200 (OK) |
{
|
|
400 (Bad request) |
{
|
| 401 (Unauthorized) |
{
|
| 403 (Forbidden) |
{
|
| 404 (Not Found) |
{
|
Suppression d'une session
Supprime une session de votre instance.
URL: https://my.vtsperform.com/api/client/session/{session_id}
Permission requise: SESSION_DELETE
Méthode: DELETE
Réponses:
| Code | Exemple |
| 200 (OK) |
{
|
|
400 (Bad request) |
{
|
| 401 (Unauthorized) |
{
|
| 403 (Forbidden) |
{
|
| 404 (Not Found) |
{
|
- ${ child.title }