Enregistrements (Via HTML)

Table des matières

ENREGISTREMENTS (VIA HTML)
    Enregistrements : playback/edit
    Enregistrements : playback/get
    Enregistrements : playback/delete
    Enregistrements : playback/getlist
    Description des codes d’erreurs des méthodes liées aux enregistrements

ENREGISTREMENTS (VIA HTML)

Enregistrements : playback/edit

https://www.domaine.com/lmsapi/playback/edit

/playback/edit (request) - Requête de modification d’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"
}

/playback/edit (response) - Retourne l’identifiant de l’enregistrement modifié

{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

Enregistrements : playback/get

https://www.domaine.com/lmsapi/playback/get

/playback/get (request) - Requête pour l’information d’un enregistrement

{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

/playback/get (response) – Retourne l’information sur l’enregistrement

{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"title": {
"texts": [
{
"text": "enregistrement préparatoire",
"languageId": 1
}
]
},
"sessionId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d",
"startDate": "2020-10-06T09:00:00",
"endDate": "2020-10-06T11:00:00",
"expirationDate": "2020-12-06T11:00:00",
"duration": 120,
"hyperlink": "2dhfwwoh6jqh",
"state": 1,
"parentId": “”,
"accessType": 1,
}

Enregistrements : playback/delete

https://www.domaine.com/lmsapi/playback/delete

/playback/delete (request) - Requête pour supprimer un enregistrement

{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

/playback/delete (response) – Retourne l’identifiant de l’enregistrement

{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

Description des champs

Nom 

Obligatoire

Commentaires/description

id

Identifiant unique de l’enregistrement.

(Type string)

sessionID

Lecture seule

Identifiant unique de la session de l’enregistrement.

(Type string)

title

      text

         languageId

      

Text : Titre de l’enregistrement. (Type string)

languageId : Le titre peut être multilingue : 

  • 1 = Français (Canada) 
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol

 (Type Number)

startDate

Lecture seule

Date et heure de début de l’enregistrement.(String YYYY-MM-DDTHH:MM:SSZ)

endDate

Lecture seule

Date et heure de fin de l’enregistrement.(String YYYY-MM-DDTHH:MM:SSZ)

duration

Lecture seule

Durée de l’enregistrement, en minutes.(Type number)

hyperlink

 

Hyperlien public de l’enregistrement. Modifie seulement la fin du lien. Par exemple : si on spécifie ‘2dhfwwoh6jqh’, le lien résultant ressemblerait à ‘https://www.domaine.com/lienactivité/2dhfwwoh6jqh’

(Type String)

state

Lecture seule

État de cet enregistrement.

  • 1 = Active
  • 2 = Deleted
  • 3 = Disabled

 

parentId

Lecture seule

Identifiant de l’enregistrement parent s’il y a lieu.

(Type String)

accessType

 

Type d’accès de cet enregistrement.

  • 0 = Administrators
  • 1 = Participants
  • 2 = PublicAll
  • 3 = PublicOnly

 

(Type Number)

Enregistrements : playback/getlist

https://www.domaine.com/lmsapi/playback/getlist

/playback/getlist (request) - Requête de liste des enregistrements

{
"filterDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterStartDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterEndDate": "YYYY-MM-DDTHH:MM:SSZ" ,
"filterIndex": 2
}

/playback/getlist (response) - Retourne la liste des objets représentant les enregistrements

[
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"title": {
"texts": [
{
"text": "enregistrement préparatoire",
"languageId": 1
}
]
},
"sessionId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d",
"startDate": "2020-10-06T09:00:00",
"endDate": "2020-10-06T11:00:00",
"expirationDate": "2020-12-06T11:00:00",
"duration": 120,
"hyperlink": "2dhfwwoh6jqh",
"state": 1,
"parentId": “”,
"accessType": 1,
},
{
"id": "7Zi3zYvuHTZ7YLK7TQjdsdfsdfsdflQ%3d%3d",
"title": {
"texts": [
{
"text": "enregistrement préparatoire2",
"languageId": 1
}
]
},
"sessionId": "6d7yavtJaassddwLemtOAO2HF5BQ%3d%3d",
"startDate": "2020-10-06T09:00:00",
"endDate": "2020-10-06T11:00:00",
"expirationDate": "2020-12-06T11:00:00",
"duration": 20,
"hyperlink": "2dhfwwffffoh6jqh",
"state": 1,
"parentId": “”,
"accessType": 1,
}
]

Description des champs

ATTENTION : FilterId ou filterStartDate doivent être passé à cet appel.

Nom 

Obligatoire

Commentaires/description

filterId

 

Filtre par identifiant de session. Permet d’obtenir la liste des enregistrements pour une session.

(String)

filterStartDate

 

Filtre par date de début des enregistrements. Permet d’obtenir tous les enregistrements qui commencent après une date précise

(Date de début) -String (YYYY-MM-DDTHH:MM:SSZ)

filterEndDate

 

Filtre par date maximum de début d’enregistrement.

Associé à une date de début, permet d’obtenir toutes les rencontres ayant lieu entre ces dates.

(Date de fin) -String (YYYY-MM-DDTHH:MM:SSZ)

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.

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.

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Nous sommes désolés de ne pas avoir pu répondre à votre question. Aidez-nous à améliorer cet article grâce à vos commentaires.