Table des matières
ENGAGEMENTS
Engagements : commitment/create
Engagements : commitment/get
Engagements : commitment/edit
Engagements : commitment/getlist
Engagements : commitment/delete
ENGAGEMENTS
Engagements : commitment/create
https://www.domaine.com/lmsapi/commitment/create
/commitment/create (request) – Requête de création d’un engagement
{ "userId": "ydsIWAnJo8WP4ZyJkQEkZA%3d%3d", "refId": "uprlbtvuqNuwmncYPu1ljg%3d%3d", "type": 0, "status": 0, "endDate": "2020-11-19T00:00:00.00", "billingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d", "adminCode": "0123456", "lastSubscriptionDate": "2020-11-19T00:00:00.00", "subscribableItemStartDate": "2020-11-19T00:00:00.00", "completionDate": "2020-11-19T00:00:00.00" }
/commitment/create (response) - Retourne l’identifiant de l’engagement créé
{ "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
userId | ![]() | Identifiant de l’utilisateur associé à l’engagement de formation. (Type string) |
refId | ![]() | Identifiant de la formation ou du programme de formation associé à l’engagement. (Type string) |
type | ![]() | Type d’engagement.
(Type Number) |
status |
| Statut de l’engagement.
(Type Number) |
endDate |
| Date de limite de complétion de l’engagement. Optionnelle, aucune limite de date si omise. Si l’heure spécifiée est égale à minuit, elle est automatiquement convertie à 23H59 :59 pour refléter la fin de la journée. (String YYYY-MM-DDTHH:MM:SSZ) |
billingId |
| Identifiant de facturation d’inscription à la formation ou au programme associé à l’engagement. Si existant. (Type string) |
adminCode |
| Code administratif pouvant être à cet élément. (Type string) |
lastSubscriptionDate |
| Date d’inscription à la formation ou au programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
subscribableItemStartDate |
| Date de début de la session de formation ou de la cohorte du programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
completionDate |
| Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
Engagements : commitment/get
https://www.domaine.com/lmsapi/commitment/get
/commitment/get (request) - Requête d'un engagement par identifiant
{ "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d" }
/commitment/get (response) - Retourne un objet représentant un engagement
{ "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d", "userId": "ydsIWAnJo8WP4ZyJkQEkZA%3d%3d", "refId": "uprlbtvuqNuwmncYPu1ljg%3d%3d", "type": 0, "adminCode": "0123456", "status": 0, "endDate": "2020-11-19T00:00:00.00", "billingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d", "creationDate": "2018-11-19T14:01:20.39", "lastSubscriptionDate": "2020-11-19T00:00:00.00", "subscribableItemStartDate": "2020-11-19T00:00:00.00", "completionDate": "2020-11-19T00:00:00.00", "lastModificationDate ": "2020-11-19T00:00:00.00" }
Description des champs
Nom | Obligatoire | Commentaires/description |
id | ![]() | Il s’agit de l’identifiant unique. Ce paramètre doit être vide en création, mais obligatoire en édition. (Type string) |
userId |
| Identifiant de l’utilisateur associé à l’engagement de formation. (Type string) |
refId |
| Identifiant de la formation ou du programme de formation associé à l’engagement. (Type string) |
type |
| Type d’engagement.
(Type Number) |
status |
| Statut de l’engagement.
(Type Number) |
endDate |
| Date de limite de complétion de l’engagement. Optionnelle, aucune limite de date si omise. Si l’heure spécifiée est égale à minuit, elle est automatiquement convertie à 23H59 :59 pour refléter la fin de la journée. (String YYYY-MM-DDTHH:MM:SSZ) |
billingId |
| Identifiant de facturation d’inscription à la formation ou au programme associé à l’engagement. (Type string) |
adminCode |
| Code administratif pouvant être à cet élément. (Type string) |
creationDate |
| Valeur seulement disponible en GET permettant d’obtenir la date de création de l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
lastSubscriptionDate |
| Date d’inscription à la formation ou au programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
subscribableItemStartDate |
| Date de début de la session de formation ou de la cohorte du programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
completionDate |
| Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
lastModificationDate |
| Date de la dernière modification de l’engagement. Ne peut être modifiée. Disponible sur get et getlist. |
Engagements : commitment/edit
https://www.domaine.com/lmsapi/commitment/edit
/commitment/edit (request) – Requête de modification d’un engagement
{ "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d" "userId": "ydsIWAnJo8WP4ZyJkQEkZA%3d%3d", "refId": "uprlbtvuqNuwmncYPu1ljg%3d%3d", "type": 0, "status": 0, "endDate": "2020-11-19T00:00:00.00", "billingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d", "adminCode": "0123456", "lastSubscriptionDate": "2020-11-19T00:00:00.00", "subscribableItemStartDate": "2020-11-19T00:00:00.00", "completionDate": "2020-11-19T00:00:00.00" }
/commitment/edit (response) - Retourne l’identifiant de l’engagement modifié
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | ![]() | Il s’agit de l’identifiant unique. (Type string) |
userId |
| Identifiant de l’utilisateur associé à l’engagement de formation. (Type string) |
refId |
| Identifiant de la formation ou du programme de formation associé à l’engagement. (Type string) |
type |
| Type d’engagement.
(Type Number) |
status |
| Statut de l’engagement.
(Type Number) |
endDate |
| Date de limite de complétion de l’engagement. Optionnelle, aucune limite de date si omise. Si l’heure spécifiée est égale à minuit, elle est automatiquement convertie à 23H59 :59 pour refléter la fin de la journée. (String YYYY-MM-DDTHH:MM:SSZ) |
billingId |
| Identifiant de facturation d’inscription à la formation ou au programme associé à l’engagement. (Type string) |
adminCode |
| Code administratif pouvant être à cet élément. (Type string) |
lastSubscriptionDate |
| Date d’inscription à la formation ou au programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
subscribableItemStartDate |
| Date de début de la session de formation ou de la cohorte du programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
completionDate |
| Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ) |
Engagements : commitment/getlist
https://www.domaine.com/lmsapi/commitment/getlist
/commitment/getlist (request) - Requête de liste des engagements
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"filterDate": “YYYY-MM-DDTHH:MM:SSZ”,
"filterEditDate": “YYYY-MM-DDTHH:MM:SSZ”
}
/commitment/getlist (response) - Retourne la liste des objets représentant les engagements
[
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
"userId": "WvBFs9k%2f2p4hmaknUWkVVw%3d%3d",
"refId": "cJWXAHaVdVaGt3eXQiEGEg%3d%3d",
"type": 0,
"adminCode": "imcgmwuovboh",
"status": 1,
"endDate": "2020-11-19T00:00:00.00",
"billingId": "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
"creationDate": "2020-03-17T16:52:31.12",
"lastSubscriptionDate": "2020-11-19T00:00:00.00",
"subscribableItemStartDate": "2020-11-19T00:00:00.00",
"completionDate": "2020-11-19T00:00:00.00",
"lastModificationDate": "2020-11-19T00:00:00.00"
},
{
"id": "jt9UU9fr%2fppeVdmulnSbPQ%3d%3d",
"userId": "F6%2bqPOvBhdlId44nKxIzmA%3d%3d",
"refId": "EBwrsZvF4YW4IW0FgftpzQ%3d%3d",
"type": 0,
"adminCode": "gtgmbojfzwoa",
"status": 1,
"endDate": "2020-11-19T00:00:00.00",
"billingId": "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
"creationDate": "2020-03-17T16:52:32.653",
"lastSubscriptionDate": "2020-11-19T00:00:00.00",
"subscribableItemStartDate": "2020-11-19T00:00:00.00",
"completionDate": "2020-11-19T00:00:00.00",
"lastModificationDate": "2020-11-19T00:00:00.00"
},
{
"id": "gnE3CSJVXko2bvXkiumEgw%3d%3d",
"userId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d",
"refId": "0Yr7aeSRuUdZN6H7YzHhdw%3d%3d",
"type": 0,
"adminCode": "gadzjedecdxt",
"status": 1,
"endDate": "2020-11-19T00:00:00.00",
"billingId": "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
"creationDate": "2020-03-17T16:55:19.843",
"lastSubscriptionDate": "2020-11-19T00:00:00.00",
"subscribableItemStartDate": "2020-11-19T00:00:00.00",
"completionDate": "2020-11-19T00:00:00.00",
"lastModificationDate": "2020-11-19T00:00:00.00"
}
]
Description des champs
Nom | Obligatoire | Commentaires/description |
id |
| Filtre par identifiant d’utilisateur. Permet d’obtenir seulement la liste des engagements associés à une personne. (Type string) |
filterDate |
| Filtre par date de création. Permet d’obtenir la liste des engagements créés depuis une date précise. (String YYYY-MM-DDTHH:MM:SSZ) |
filterEditDate |
| Filtre par date de dernière modification de l’élément. Permet d’obtenir la liste des objets qui ont été modifiés après la date passée comme filtre. (Date de dernière modification) -String (YYYY-MM-DDTHH:MM:SSZ) |
Engagements : commitment/delete
https://www.domaine.com/lmsapi/commitment/delete
/commitment/delete (request) - Requête de suppression d’un engagement par identifiant
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}
/commitment/delete (response) - Retourne l’identifiant de l’engagement supprimé
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}
Description des codes d’erreurs des méthodes liées aux engagements
Numéro | Message | Commentaires/description |
1600 | RequiredId | Vous devez fournir un identifiant pour l’engagement. |
1601 | InvalidId | L’identifiant fourni pour l’engagement est invalide. |
1602 | RequiredUserId | Au moins un des deux paramètres de recherche doit être envoyé. |
1603 | InvalidUserId | L’identifiant fourni pour l’utilisateur est invalide. |
1604 | RequiredRefId | Vous devez fournir un identifiant pour la formation ou le programme de formation. |
1605 | InvalidRefId | L’identifiant fourni pour la formation ou le programme de formation est invalide. |
1606 | RequiredType | Vous devez fournir un type d’engagement. |
1607 | InvalidType | Le type d’engagement fourni est invalide. |
1608 | InvalidStatus | Le statut fourni est invalide. |
1609 | InvalidBillingId | L’identifiant de facturation de l’inscription est invalide. |