Inscriptions (Lära)

Miro Lagueux

Modifié le : Mar, 19 Déc., 2023 à 7:58 H

Table des matières

INSCRIPTIONS
Billing : billing/get
Billing : billing/edit
Billing : billing/getlist
Billing : billing/editsubscriptiondate
Description des codes d’erreurs de facture

INSCRIPTIONS

L’API regroupe les notions de facture, d’inscription et de complétion de formation.

Billing : billing/get

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

/billing/get (request) - Requête une facture

{
  "id": "u4DNThbf4WoRkZ%2b8rwU2AQ%3d%3d" (Obligatoire)
}

/billing/get (response) – Retourne le détail d'une facture

{
  "id": "u4DNThbf4WoRkZ%2b8rwU2AQ%3d%3d",
  "userID": "wHkVFD5qzpDQ6hyqvlmpjA%3d%3d",
  "subscriptionType": 0,
  "providerID": "djcZh8rfjtVuMzLdYFzHvA%3d%3d",
  "workspaceID": "Rv9LBvgPCxT0Imv4jBl%2fYA%3d%3d",
  "workspaceInstanceID": "8Cqi%2blqLC5WnzjrVaZLTPw%3d%3d",
  "creationDate": "2020-04-01T08:36:40.637",
  "subscriptionDate": "2020-04-01T08:36:40.637",
  "status": 1,
  "credits": 6.00,
  "creditsObtained": 6.00,
  "isCompleted": false,
  "isSuccess": false,
  "completionDate": "2020-04-01T08:39:08.62",
  "progressPercent": 100,
  "workspaceName": "Formation 123",
  "workspaceInstanceName": "Formation 123",
  "lastUpdateDate": "2020-04-01T08:39:08.62",
  "customFields": {
    "no_titulaire": "# Titulaire",
    "fact_empl": 0
  }
}

Description des champs

Nom	Commentaires/description
id	Il s’agit de l’identifiant unique de la facture. (Type String)
userId	Identifiant unique de l’utilisateur lié à cette inscription. (Type String)
subscriptionType	Type/contexte d’inscription (présent lorsque l’inscription associée est encore valide) : 0 = WorkspaceInstance (Session de formation) 1 = Cohort (Cohorte de programme de formation) (Type Number)
providerId	Identifiant unique du fournisseur de formation (présent lorsque l’inscription associée est encore valide) (Type String)
workspaceId	Identifiant unique de la formation (présent lorsque subscriptionType = 0) (Type String)
workspaceInstanceId	Identifiant unique de la session de formation (présent lorsque subscriptionType = 0) (Type String)
programId	Identifiant unique du programme de formation (présent lorsque subscriptionType = 1) (Type String)
cohortId	Identifiant unique de la cohorte du programme de formation (présent lorsque subscriptionType = 1) (Type String)
creationDate	Date originale d’inscription String (YYYY-MM-DDTHH:MM:SSZ)
subscriptionDate	Date d’acceptation d’inscription à la formation ou au programme String (YYYY-MM-DDTHH:MM:SSZ)
status	Statut de l’inscription · 0 = Inactive · 1 = Inscrit · 2 = En attente · 3 = Désinscrit · 4 = Désactivé · 5 = Transféré · 6 = Expiré · 7 = Non confirmé · 8 = Expiré avec accès (Type Number)
credits	Nombre de crédits accordés à la réussite de la formation ou du programme (Type Number)
creditsObtained	Nombre de crédits obtenus par l’utilisateur (Type Number)
isCompleted	Indique si l’utilisateur a complété sa formation (Type Boolean)
isSuccess	Indique si l’utilisateur a réussi sa formation (Type Boolean)
completionDate	Date de complétion de la formation String (YYYY-MM-DDTHH:MM:SSZ)
progressPercent	Pourcentage de progression de la formation (Type Number – entre 0 et 100)
workspaceName	Nom de la formation (présent lorsque subscriptionType = 0) (Type String)
workspaceInstanceName	Nom de la session de formation (présent lorsque subscriptionType = 0) (Type String)
programName	Nom du programme de formation (présent lorsque subscriptionType = 1) (Type String)
cohortName	Nom de la cohorte du programme de formation (présent lorsque subscriptionType = 1) (Type String)
lastUpdateDate	Dernière date de mise à jour de l’inscription ou de la complétion de la formation String (YYYY-MM-DDTHH:MM:SSZ)
customFields	Champs personnalisés reliés à une facture.

Billing : billing/edit

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

/billing/edit (request) - Requête de modification d'une facture

ATTENTION : La méthode nécessite uniquement la valeur « id » comme obligatoire. Les champs passés sont mis à jour, les champs qui ne sont pas renseignés ne sont simplement pas mis à jour.

{
  "id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/billing /edit (response) - Retourne l'identifiant de la facture modifiée

{
  "id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Description des champs

ATTENTION : La méthode nécessitent uniquement la valeur « id » comme obligatoire. Les champs passés sont mis à jour, les champs qui ne sont pas renseignés ne sont simplement pas mis à jour.

Nom

Obligatoire

Commentaires/description

Il s’agit de l’identifiant unique de la facture.

customFields

Champs sur mesure reliés à l’utilisateur.

Billing : billing/getlist

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

/billing/getlist (request) - Requête une facture

{
  "filterId": "wHkVFD5qzpDQ6hyqvlmpjA%3d%3d",
  "filterIndex": 1,
  "filterDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterEndDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterIncludeDisabled": true
}

ATTENTION :

Le paramètre de filtre par id "filterId" est optionnel et correspond à l’identifiant d’un utilisateur dont on veut obtenir les données de facturations, d’inscriptions ou de complétions.

Le paramètre de filtre par date "filterDate" est optionnel et correspond à la dernière date de modification sur l’inscription ou la complétion. La méthode retourne la liste des objets dont cette date est après la date passée comme filtre.

Comme le paramètre "filterDate", le paramètre "filterEndDate" est optionnel et n'est pris en compte que si "filterDate" a été défini. La méthode retourne la liste des objets dont la dernière date de modification cette date est avant la date passée comme filtre.

Le paramètre de filtre par index "filterIndex" est optionnel et correspond à une pagination de 200 inscriptions. La méthode retourne la liste de 200 objets selon l’index passé comme filtre.

Un filtre par index de 1 retourne les inscriptions 1 à 200 et un filtre par index de 2 retourne les inscriptions de 201 à 400.

Si le paramètre de filtre par index "filterIndex" n’est pas utilisé, le retour de cet appel ne contiendra qu’au maximum 100 éléments.

Le paramètre de filtre "filterIncludeDisabled" est optionnel. Par défaut les inscriptions annulées ("Désinscrit" et "Désactivé") ne sont jamais retournées. Les valeurs possibles sont :

true permet d’inclure les inscriptions au statut "Désinscrit" et "Désactivé".
false permet d’exclure les inscriptions au statut "Désinscrit" et "Désactivé".

/billing/getlist (response) – Retourne le détail d'une facture

[
    {
        "id": "u4DNThbf4WoRkZ%2b8rwU2AQ%3d%3d",
        "userID": "wHkVFD5qzpDQ6hyqvlmpjA%3d%3d",
        "subscriptionType": 0,
        "providerID": "djcZh8rfjtVuMzLdYFzHvA%3d%3d",
        "workspaceID": "Rv9LBvgPCxT0Imv4jBl%2fYA%3d%3d",
        "workspaceInstanceID": "8Cqi%2blqLC5WnzjrVaZLTPw%3d%3d",
        "creationDate": "2020-04-01T08:36:40.637",
        "subscriptionDate": "2020-04-01T08:36:40.637",
        "status": 1,
        "credits": 6.00,
        "creditsObtained": 6.00,
        "isCompleted": false,
        "isSuccess": false,
        "completionDate": "2020-04-01T08:39:08.62",
        "progressPercent": 100,
        "workspaceName": "Formation 123",
        "workspaceInstanceName": "Formation 123",
        "lastUpdateDate": "2020-04-01T08:39:08.62",
        "customFields": {
            "no_titulaire": "# Titulaire",
            "fact_empl": 0
        }
    },
    {
        "id": "5DXt2mQIPrF%2bOtKJXDJkHQ%3d%3d",
        "userID": "wHkVFD5qzpDQ6hyqvlmpjA%3d%3d",
        "subscriptionType": 1,
        "providerID": "djcZh8rfjtVuMzLdYFzHvA%3d%3d",
        "programID": "TdQNdAVv233NKXZO%2fhSiww%3d%3d",
        "cohortID": "wf4T36TwvfNSF8HOgwZ1jw%3d%3d",
        "subscriptionDate": "2020-03-26T12:03:49.753",
        "status": 1,
        "credits": 0.00,
        "creditsObtained": 0.0,
        "isCompleted": false,
        "isSuccess": false,
        "completionDate": "2020-05-04T10:57:26.52",
        "progressPercent": 16,
        "programName": "Programme 123",
        "cohortName": "Programme 123",
        "lastUpdateDate": "2020-05-04T10:57:26.52",
        "customFields": {
            "no_titulaire": "# Titulaire",
            "fact_empl": 0
        }
  }
]

Billing : billing/editsubscriptiondate

https://www.domaine.com/lmsapi/billing/editsubscriptiondate

/billing/editsubscriptiondate (request) – Met à jour la date d’inscription d’un utilisateur

{
  "id": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
  "subscriptionDate": "2020-10-09T08:00:00.000Z",
  "adminNote": "note optionnelle"
}

/billing/editsubscriptiondate (response) – Retourne l’identifiant de l’inscription

{
  "id": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d"
}

Description des codes d’erreurs de facture

Numéro	Message	Commentaires/description
1200	Required id	Vous devez fournir un identifiant.
1201	Invalid id	L’identifiant fourni est invalide.
1202	Required subscriptionDate	Vous devez fournir une date.
1203	Invalid FilterId	Le filtre d’identifiant d’utilisateur fourni est invalide.

French