 | TABLE DES MATIÈRES Inscriptions : billing/getInscriptions : billing/edit Inscriptions : billing/getlist Inscriptions : 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. Une inscription dans l'API est nommée « billing ». |  |
Billing : billing/get
https://www.domaine.com/lmsapi/billing/get
 | Retourne le détail d'une inscription (facture) de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations pour une inscription :
{
"id": "u4DNThbf4WoRkZ%2b8rwU2AQ%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de la facture. (Type String) |
Réponse
Exemple de contenu d'appel de réponse des informations pour une inscription :
{
"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",
"approverUserId": "y9DDvS6G4UzxlxV%2fPuEWqA%3d%3d",
"originalBillingId": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
"provenance": 3,
"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) :
(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
(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) |
| approverUserId | Identifiant d'un utilisateur ayant le droit d'approbateur (Type String) |
| originalBillingId | Dans le cas d'un transfert d'inscription à un autre utilisateur : Identifiant de la facture de l'inscription originale |
| provenance | Provenance de l'inscription de l'utilisateur
(Type Number) |
customFields | Champs personnalisés reliés à une facture. |
Billing : billing/edit
https://www.domaine.com/lmsapi/billing/edit
| Permet de modifier une inscription (facture) existante. |
Requête
Exemple de contenu d'appel de requête de modification d'une inscription :
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",
"approverUserId": "y9DDvS6G4UzxlxV%2fPuEWqA%3d%3d"
}Description des champs
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.
| Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de la facture. (Type String) |
| customFields | Champs sur mesure reliés à la facture. | |
| approverUserId | Identifiant d'un utilisateur ayant le droit d'approbateur. (Type String) |
Réponse
Exemple de contenu d'appel de réponse de modification d'une inscription :
{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de la facture modifiée. (Type String) |
Billing : billing/getlist
https://www.domaine.com/lmsapi/billing/getlist
| Retourne la liste des inscriptions (factures) de votre environnement. |
Requête
Exemple de contenu d'appel de requête de la liste des inscriptions :
{
"filterId": "wHkVFD5qzpDQ6hyqvlmpjA%3d%3d",
"filterIndex": 1,
"filterDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterEndDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterIncludeDisabled": true
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| filterId | Paramètre optionnel correspondant à l’identifiant d’un utilisateur dont on veut obtenir les données de facturations, d’inscriptions ou de complétions. (Type String) | |
| filterIndex | Paramètre optionnel correspondant à 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 ce paramètre n’est pas utilisé, le retour de cet appel ne contiendra qu’au maximum 100 éléments. (Type Number) | |
| filterDate | Paramètre optionnel correspondant à 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. String (YYYY-MM-DDTHH:MM:SSZ) | |
| filterEndDate | Paramètre optionnel qui 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 est avant la date passée comme filtre. String (YYYY-MM-DDTHH:MM:SSZ) | |
| filterIncludeDisabled | Paramètre optionnel. Par défaut les inscriptions annulées ("Désinscrit" et "Désactivé") ne sont jamais retournées. Les valeurs possibles sont :
|
Réponse
Exemple de contenu d'appel de réponse de la liste des inscriptions :
[
{
"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",
"approverUserId": null,
"provenance": 3,
"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",
"approverUserId": "y9DDvS6G4UzxlxV%2fPuEWqA%3d%3d",
"provenance": 3,
"customFields": {
"no_titulaire": "# Titulaire",
"fact_empl": 0
}
}
]Description des champs
Chaque élément de la liste contient les mêmes champs que ceux retournés par billing/get :
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) :
(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
(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) |
| approverUserId | Identifiant d'un utilisateur ayant le droit d'approbateur (Type String) |
| originalBillingId | Dans le cas d'un transfert d'inscription à un autre utilisateur : Identifiant de la facture de l'inscription originale |
| provenance | Provenance de l'inscription de l'utilisateur
(Type Number) |
customFields | Champs personnalisés reliés à une facture. |
Billing : billing/editsubscriptiondate
https://www.domaine.com/lmsapi/billing/editsubscriptiondate
| Met à jour la date d’inscription d’un utilisateur. |
Requête
Exemple de contenu d'appel de requête de mise à jour de la date d'inscription :
{
"id": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
"subscriptionDate": "2020-10-09T08:00:00.000Z",
"adminNote": "note optionnelle"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de la facture. (Type String) |
| subscriptionDate | X | Nouvelle date d’acceptation d’inscription à la formation ou au programme. String (YYYY-MM-DDTHH:MM:SSZ) |
| adminNote | Note administrative optionnelle associée à la modification. (Type String) |
Réponse
Exemple de contenu d'appel de réponse de mise à jour de la date d'inscription :
{
"id": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de l’inscription modifiée. (Type String) |
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. |
| 1204 | Invalid approverUserId | L’identifiant fourni pour l'utilisateur approbateur est invalide |
| 1205 | approverUserId does not have right | L'identifiant de l'utilisateur approbateur n'a pas le droit de voir les approbations |