Ressources de classe virtuelle (Via HTML)
Les « ressources » sont les documents, sondages et questionnaires déposés dans une classe virtuelle ou dans l'un de ses ateliers. Une ressource dans l'API est nommée « activityresource ». |  |
Ressources : activityresource/editresource
https://www.domaine.com/lmsapi/activityresource/editresource
 | Permet de modifier les paramètres d'une ressource d'une classe virtuelle. |
Requête
Exemple de contenu d'appel de requête de modification des paramètres d'une ressource :
{
"activityId": "0Kasd%2fbXHZ2qDTSa235sdjSmjJ23425ezashd%2fpAfsd%3gddfg%3d",
"resourceId": "sy4U2cv4egeBb2353347s3uX3sEv0%2vf3b345v4Q%3d%3d",
"subRoomId": "p3Kk5v3423v45bp6v5346guYcU345vmKt7gQQ%534343d%3d",
"visibilityType": 1,
"isDownloadable": true
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| activityId | X | Identifiant unique de la classe virtuelle. (Type string) |
| resourceId | X | Identifiant unique de la ressource. (Type string) |
| subRoomId | X | Identifiant unique de l'atelier. (Type string) |
| visibilityType | Type de visibilité de la ressource.
| |
| isDownloadable | Indique si la ressource est téléchargeable. (Type bool) |
Réponse
Exemple de contenu d'appel de réponse de modification des paramètres d'une ressource :
{
"id": "sy4U2cv4egeBb2353347s3uX3sEv0%2vf3b345v4Q%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de la ressource modifiée. (Type string) |
Ressources : activityresource/delete
https://www.domaine.com/lmsapi/activityresource/delete
| Permet de supprimer une ressource d'une classe virtuelle. |
Requête
Exemple de contenu d'appel de requête de suppression d'une ressource :
{
"activityId": "0Kasd%2fbXHZ2qDTSa235sdjSmjJ23425ezashd%2fpAfsd%3gddfg%3d",
"resourceId": "sy4U2cv4egeBb2353347s3uX3sEv0%2vf3b345v4Q%3d%3d",
"subRoomId": "p3Kk5v3423v45bp6v5346guYcU345vmKt7gQQ%534343d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| activityId | X | Identifiant unique de la classe virtuelle. (Type string) |
| resourceId | X | Identifiant unique de la ressource. (Type string) |
| subRoomId | X | Identifiant unique de l'atelier. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de suppression d'une ressource :
{
"id": "sy4U2cv4egeBb2353347s3uX3sEv0%2vf3b345v4Q%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de la ressource supprimée. (Type string) |
Ressources : activityresource/getsubroomresourcelist
https://www.domaine.com/lmsapi/activityresource/getsubroomresourcelist
| Retourne la liste des ressources d'un atelier de classe virtuelle. |
Requête
Exemple de contenu d'appel de requête de la liste des ressources d'un atelier :
{
"activityId": "R%2fxjC2SjJIA2ERnHRz5MhA%3d%3d",
"subRoomId": "R%2fxjC2SjJIA2ERnHRz5MhA%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| activityId | X | Identifiant unique de la classe virtuelle. (Type string) |
| subRoomId | X | Identifiant unique de l'atelier. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de la liste des ressources d'un atelier :
[
{
"resourceId": "R%2fxjC2SjJIA2ERnHRz5MhA%3d%3d",
"title": "Questionnaire avec multi tentatives",
"resourceType": 10,
"fileType": "",
"fileSize": 0,
"nbPages": 0,
"isDownloadable": false,
"visibilityType": 0
},
{
"resourceId": "R%2fxjC2SjJIA2ERnHRz5MhA%3d%3d",
"title": "nomdufichier",
"resourceType": 1,
"fileType": "Jpg",
"fileSize": 1234,
"nbPages": 1,
"isDownloadable": false,
"visibilityType": 0
}
]Description des champs
| Nom | Commentaires/description |
| resourceId | Identifiant unique de la ressource. (Type string) |
| title | Titre de la ressource. (Type string) |
| resourceType | Type de la ressource.
|
| fileType | Indique le type de fichier selon l'extension. (Type string) |
| category | Indique la catégorie du fichier. (Type string) |
| fileSize | Indique la taille du fichier en octets. (Type number) |
| nbPages | Nombre de pages du document. Vide s'il ne s'agit pas d'un document. (Type number) |
| isDownloadable | Indique si la ressource est téléchargeable. (Type bool) |
| visibilityType | Type de visibilité de la ressource.
|
Ressources : activityresource/getactivitysurveytoken
https://www.domaine.com/lmsapi/activityresource/getactivitysurveytoken
| Génère un lien d'accès unique vers les résultats d'un sondage ou d'un questionnaire. |
Requête
Exemple de contenu d'appel de requête de génération d'un lien d'accès aux résultats d'un sondage ou questionnaire :
{
"activityId": "0Kasd%2fbXHZ2qDTSa235sdjSmjJ23425ezashd%2fpAfsd%3gddfg%3d",
"resourceId": "sy4U2cv4egeBb2353347s3uX3sEv0%2vf3b345v4Q%3d%3d",
"userId": "zsdtax4xA22Q43b2o34i2Cnf2b424dlxYs23g%dsfc3234d52b32d",
"forceAccess": 0
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| activityId | X | Identifiant unique de la classe virtuelle. (Type string) |
| resourceId | X | Identifiant unique du sondage ou du questionnaire. (Type string) |
| userId | X | Identifiant unique de l'utilisateur. (Type string) |
| forceAccess | Force l'accès à la liste de tous les résultats, même si l'utilisateur n'est pas associé à l'activité. (Type bool) Vaut 0 si non renseigné. |
Réponse
Exemple de contenu d'appel de réponse de génération d'un lien d'accès aux résultats d'un sondage ou questionnaire :
{
"urlToken": "https://lara.sviesolutions.com/Web/SignInSSO?token=ff9321c24234b27886234c746f99e8342v7b0a231dcc07aa73"
}Description des champs
| Nom | Commentaires/description |
| urlToken | Lien d'accès unique généré. (Type string) |
Ressources : activityresource/getmyresourcetoken
https://www.domaine.com/lmsapi/activityresource/getmyresourcetoken
| Génère un lien d'accès unique vers la section « Mes ressources » du portail. |
Requête
Exemple de contenu d'appel de requête de génération d'un lien d'accès à la section Mes ressources :
{
"activityId": "0Kasd%2fbXHZ2qDTSa235sdjSmjJ23425ezashd%2fpAfsd%3gddfg%3d",
"userId": "zsdtax4xA22Q43b2o34i2Cnf2b424dlxYs23g%dsfc3234d52b32d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| activityId | X | Identifiant unique de la classe virtuelle. (Type string) |
| userId | X | Identifiant unique de l'utilisateur. (Type string) |
| resourceId | Identifiant unique de la ressource. Permet de rediriger vers la page de paramètres de la ressource spécifiée. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de génération d'un lien d'accès à la section Mes ressources :
{
"urlToken": "https://lara.sviesolutions.com/Web/SignInSSO?token=ff9321c24234b27886234c746f99e8342v7b0a231dcc07aa73"
}Description des champs
| Nom | Commentaires/description |
| urlToken | Lien d'accès unique généré. (Type string) |
Ressources : activityresource/getresourcedownloadtoken
https://www.domaine.com/lmsapi/activityresource/getresourcedownloadtoken
| Génère un lien d'accès unique de téléchargement pour une ressource de type document. |
Requête
Exemple de contenu d'appel de requête de génération d'un lien de téléchargement d'une ressource :
{
"resourceId": "sy4U2cv4egeBb2353347s3uX3sEv0%2vf3b345v4Q%3d%3d",
"userId": "zsdtax4xA22Q43b2o34i2Cnf2b424dlxYs23g%dsfc3234d52b32d",
"subRoomId": "p3Kk5v3423v45bp6v5346guYcU345vmKt7gQQ%534343d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| subRoomId | X | Identifiant unique de l'atelier. (Type string) |
| resourceId | X | Identifiant unique de la ressource. (Type string) |
| userId | X | Identifiant unique de l'utilisateur. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de génération d'un lien de téléchargement d'une ressource :
{
"urlToken": "https://lara.sviesolutions.com/Web/SignInSSO?token=ff9321c24234b27886234c746f99e8342v7b0a231dcc07aa73"
}Description des champs
| Nom | Commentaires/description |
| urlToken | Lien d'accès unique généré. (Type string) |
Description des codes d’erreurs des méthodes liées aux ressources de classe virtuelle
Numéro | Message | Commentaires/description |
2300 | Required resourceId | Vous devez fournir un identifiant de ressource. |
2301 | Invalid resourceId | L’identifiant fourni pour la ressource est invalide. |
2302 | Required userId | Vous devez fournir un identifiant d'utilisateur. |
2303 | Invalid userId | L’identifiant fourni pour l'utilisateur est invalide. |
2304 | Required subRoomId | Vous devez fournir un identifiant d'atelier. |
2305 | Invalid subRoomId | L’identifiant fourni pour l'atelier est invalide. |
2306 | Required activityId | Vous devez fournir un identifiant de classe virtuelle. |
2307 | Invalid activityId | L’identifiant fourni pour la classe virtuelle est invalide. |
| 2308 | Invalid visibilityType | Le type de visibilité fourni pour la ressource est invalide. |
| 2309 | Invalid resource type | Le type de ressource fourni est invalide. |
| 2310 | ResourceService error | Une erreur est survenue au niveau du service de ressources. |