 | TABLE DES MATIÈRES |
Enregistrements (VIA HTML)
Un « enregistrement VIA HTLM » est une reconstitution de la tenue d'une activité Via HTML. Ils sont nommés « playback » dans l'API. |  |
Playback/edit
 | Permet de modifier des informations sur un enregistrement existant. |
Requête
Exemple de contenu d'appel de requête de modification des informations sur un enregistrement :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"title": {
"texts": [
{
"text": "enregistrement1",
"languageId": 1
},
{
"text": "recording1",
"languageId": 2
}
]
},
"expirationDate": "2020-10-10T09:00:00",
"accessType": 1,
"hyperlink": "2dhfwwoh6jqh"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de l’enregistrement. |
title text languageId |
| Text : Titre de l’enregistrement. (Type string) languageId : Le titre peut être multilingue :
(Type Number) |
| expirationDate | Date de fin de la capacité à accéder à l'enregistrement. La date fournie est incluse. (String YYYY-MM-DDTHH:MM:SSZ) | |
hyperlink |
| Hyperlien public de l’enregistrement. Modifie seulement la fin du lien. Par exemple : si on spécifie « 2dhfwwoh6jqh », le lien généré ressemblerait à https://www.domaine.com/lienactivité/2dhfwwoh6jqh |
accessType |
| Permet de définir le niveau d'accès à cet enregistrement.
(Type Number) |
Réponse
Exemple du contenu d'appel de réponse de requête de modification des informations sur un enregistrement :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique de l’enregistrement. |
Playback/get
 | Permet d'obtenir des informations sur un enregistrement existant. |
Requête
Exemple de contenu d'appel de requête des informations sur un enregistrement :
{
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de l’enregistrement. |
Réponse
Exemple du contenu d'appel de réponse de requête des informations sur un enregistrement :
{
"PlaybackIDNoEnc": 28710,
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d",
"sessionId": "9vFuA0yNiBQdbXSg42X%2f6w%3d%3d",
"title": {
"texts": [
{
"text": "Enregistrement #93",
"languageId": 1
},
{
"text": "Recording #93",
"languageId": 2
},
{
"text": "Grabación nro.93",
"languageId": 3
},
{
"text": "Enregistrement #93",
"languageId": 4
}
],
"ErrorID": 0
},
"startDate": "2024-05-06T14:00:11.057",
"endDate": "2024-05-06T14:14:17.057",
"duration": 846,
"hyperlink": "https://domaine.com/salle/nbblzfygdxkp",
"state": 1,
"accessType": 1
}Description des champs
Nom | Obligatoire | Commentaires/description |
| PlaybackIDNoEnc | ||
id | Identifiant unique de l’enregistrement. (Type string) | |
sessionID | Identifiant unique de la session où se trouve l’enregistrement, s'il y a lieu. (Type string) | |
title text languageId | Text : Titre de l’enregistrement. (Type string) languageId : Le titre peut être multilingue :
(Type Number) | |
startDate | Date et heure de début de l’enregistrement. | |
endDate | Date et heure de fin de l’enregistrement. | |
duration | Durée de l’enregistrement, en minutes. | |
hyperlink | Hyperlien public de l’enregistrement. Modifie seulement la fin du lien. Par exemple : si on spécifie « 2dhfwwoh6jqh », le lien généré ressemblerait à https://www.domaine.com/lienactivité/2dhfwwoh6jqh | |
state | État de cet enregistrement.
(Type Number) | |
parentId | Identifiant unique de l’enregistrement parent, s’il y a lieu. (Type String) | |
accessType | Permet de définir le niveau d'accès à cet enregistrement.
(Type Number) |
Playback/delete
 | Permet de supprimer un enregistrement existant. |
Requête
Exemple de contenu d'appel de requête de suppression d'un enregistrement :
{
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de l’enregistrement. |
Réponse
Exemple du contenu d'appel de réponse de requête de suppression d'un enregistrement :
{
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique de l’enregistrement. (Type string) |
Playback/getlist
 | Permet d'obtenir des informations sur une liste d'enregistrements. |
Requête
Exemple de contenu d'appel de requête d'informations sur une liste d'enregistrements :
{
"filterId":"9vFuA0yNiBQdbXSg42X%2f6w%3d%3d",
"filterStartDate":"2023-01-01",
"filterEndDate":"2028-01-01",
"filterindex":1
}Description des champs
Nom | Obligatoire | Commentaires/description |
filterId | X OU X | Identifiant unique de la séance Via HTML. Permet d’obtenir la liste des enregistrements d'une activité Via HTML spécifiquement. |
filterStartDate | Permet d’obtenir tous les enregistrements qui commencent après une date précise. (String YYYY-MM-DDTHH:MM:SSZ) | |
filterEndDate |
| Permet d’obtenir tous les enregistrements qui ont commencé avant une date précise. |
filterIndex |
| Le paramètre de filtre par index est optionnel et correspond à une pagination de 100 enregistrements. La méthode retourne la liste de 100 objets selon l’index passé comme filtre. Un filtre par index de 1 retourne les rencontres 1 à 100 et un filtre par index de 2 retourne les utilisateurs de 101 à 200. |
Réponse
Exemple du contenu d'appel de réponse de requête de suppression d'un enregistrement :
[
{
"id": "UdT7%2fS42rdRl9MxaCZDTDQ%3d%3d",
"sessionId": "9vFuA0yNiBQdbXSg42X%2f6w%3d%3d",
"title": {
"texts": [
{
"text": "Enregistrement #94",
"languageId": 1
},
{
"text": "Recording #94",
"languageId": 2
},
{
"text": "Grabación nro.94",
"languageId": 3
},
{
"text": "Enregistrement #94",
"languageId": 4
}
],
"ErrorID": 0
},
"startDate": "2024-05-06T15:29:10.387",
"endDate": "2024-05-06T15:54:46.387",
"duration": 1536,
"hyperlink": "https://viahtml.sviesolutions.com/vlkyuikuymdjqiazn",
"state": 1,
"accessType": 1
},
{
"id": "cxZm8VyzZUL5t0j1RR%2bydQ%3d%3d",
"sessionId": "9vFuA0yNiBQdbXSg42X%2f6w%3d%3d",
"title": {
"texts": [
{
"text": "Enregistrement #93",
"languageId": 1
},
{
"text": "Recording #93",
"languageId": 2
},
{
"text": "Grabación nro.93",
"languageId": 3
},
{
"text": "Enregistrement #93",
"languageId": 4
}
],
"ErrorID": 0
},
"startDate": "2024-05-06T14:00:11.057",
"endDate": "2024-05-06T14:14:17.057",
"duration": 846,
"hyperlink": "https://viahtml.sviesolutions.com/nbblzfbdfbdgdxkp",
"state": 1,
"accessType": 1
}
]Description des champs
| Nom | Obligatoire | Commentaire/description |
| id | Identifiant unique de l'enregistrement. (Type String) | |
| sessionId | Identifiant unique de la séance Via HTML. (Type String) | |
title text languageId | Text : Titre de l’enregistrement. (Type string) languageId : Le titre peut être multilingue :
(Type Number) | |
| startDate | Date de début de l'enregistrement. | |
| endDate | Date de fin de l'enregistrement. | |
| duration | Durée de l'enregistrement. (Type Number) | |
| hyperlink | Lien unique vers l'enregistrement. (Type String) | |
| state | État de cet enregistrement.
(Type Number) | |
| accessType | Permet de définir le niveau d'accès à cet enregistrement.
(Type Number) |
Description des codes d’erreurs des méthodes liées aux enregistrements
Numéro | Message | Commentaires/description |
1800 | Required id | Vous devez fournir un identifiant de l’enregistrement. |
1801 | Invalid id | L’identifiant fourni pour l’enregistrement est invalide. |
1802 | Required parameters | Des paramètres sont requis pour effectuer l’appel. |
1803 | Hyperlink is not available | L’hyperlien spécifié est déjà utilisé. |
1804 | Invalid hyperlink | L’hyperlien spécifié est invalide. |
1805 | Invalid title length | Le titre est invalide, il doit être entre 3 et 100 caractères. |
1806 | Invalid accessType | Le type d’accès spécifié est invalide. |
1807 | Invalid filterId | L’Identifiant de filtre est invalide. |
1808 | Invalid expirationDate | La date d’expiration fourni est invalide. |