Engagements (Lära)

Miro Lagueux

Modifié le : Ven, 19 Avr., 2024 à 1:22 H

TABLE DES MATIÈRES
Commitment/create
Commitment/get
Commitment/edit
Commitment/getlist
Commitment/delete
Description des codes d’erreurs des méthodes liées aux engagements

Engagements

Un « engagement » est une formation ou un programme de formation imposé à un utilisateur soumis aux exigences d'une période règlementaire. Ils sont nommés « commitment » dans l'API.

Commitment/create

Permet de créer un engagement
Adresse de l'appel API : https://.../lmsapi/commitment/create

Requête

Exemple de contenu d'appel de 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"
}

Description des champs

Nom	Obligatoire	Commentaires/description
userId	X	Identifiant de l’utilisateur associé à l’engagement de formation. (Type string)
refId	X	Identifiant de la formation ou du programme de formation associé à l’engagement. (Type string)
type	X	Type d’engagement. 0 = Formation 1 = Programme de formation (Type Number)
status		Statut de l’engagement. 0 = À faire 1 = Inscrit 2 = Complété 3 = Échoué 4 = Expiré 5 = Annulé 6 = Complété hors délai (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. (String YYYY-MM-DDTHH:MM:SSZ)
billingId		Identifiant de facturation d’inscription à la formation ou au programme associé à l’engagement, si existant. Si l'inscription n'a pas encore eu lieu, la liaison avec l'engagement se fera automatiquement lors de l'inscription. (Type string)
adminCode		Code administratif facultatif pouvant être ajouté à l'engagement, au besoin. (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)

Réponse

Exemple du contenu d'appel de réponse de requête de création d'un engagement :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'engagement. (Type String)

Commitment/get

Permet d'obtenir des informations sur un engagement.
Adresse de l'appel API : https://.../lmsapi/commitment/get

Requête

Exemple de contenu d'appel de requête d'informations au sujet d'un engagement :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'engagement. (Type String)

Réponse

Exemple du contenu d'appel de réponse de requête d'informations au sujet d'un engagement :

{
    "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
    "userId": "qVu6jdhV0YxmT%2fqd3Wxx7w%3d%3d",
    "refId": "9prKhciDYOdZLT4JQTZfXg%3d%3d",
    "type": 0,
    "status": 0,
    "creationDate": "2022-09-29T08:48:43.927",
    "adminCode": "2024-01",
    "endDate": "2023-12-31T23:59:59",
    "billingId": "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
    "lastSubscriptionDate": "0001-01-01T00:00:00",
    "subscribableItemStartDate": "0001-01-01T00:00:00",
    "lastModificationDate": "2024-04-08T16:02:36.14",
    "completionDate": "0001-01-01T00:00:00"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'engagement. (Type string)
userId		Identifiant unique de l’utilisateur associé à l’engagement. (Type string)
refId		Identifiant de la formation ou du programme de formation associé à l’engagement. (Type string)
type		Type d’engagement : 0 = Formation 1 = Programme de formation (Type Number)
status		Statut de l’engagement. 0 = À faire 1 = Inscrit 2 = Complété 3 = Échoué 4 = Expiré 5 = Annulé 6 = Complété hors délai (Type Number)
creationDate		Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ)
adminCode		Code administratif facultatif pouvant être ajouté à l'engagement, au besoin. (Type string)
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. (String YYYY-MM-DDTHH:MM:SSZ)
billingId		Identifiant unique de l’inscription à la formation ou au programme associé à l’engagement. Si l'engagement a été créé sans "billingId" initialement, le ID JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d sera retourné dans ce champ (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)
lastModificationDate		Date de la dernière modification de l’engagement. Ne peut être modifiée. Disponible en /get et en /getlist.
completionDate		Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ)

Commitment/edit

Permet de modifier un engagement
Adresse de l'appel API : https://.../lmsapi/commitment/edit

Requête

Exemple de contenu d'appel de requête de modification d'un engagement :

{
    "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
    "userId": "qVu6jdhV0YxmT%2fqd3Wxx7w%3d%3d",
    "refId": "9prKhciDYOdZLT4JQTZfXg%3d%3d",
    "type": 0,
    "status": 0,
    "creationDate": "2022-09-29T08:48:43.927",
    "adminCode": "",
    "endDate": "2023-12-31T23:59:59",
    "lastSubscriptionDate": "0001-01-01T00:00:00",
    "subscribableItemStartDate": "0001-01-01T00:00:00",
    "lastModificationDate": "2024-04-08T16:02:36.14",
    "completionDate": "0001-01-01T00:00:00"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'engagement. (Type string)
userId		Identifiant unique de l’utilisateur associé à l’engagement. (Type string)
refId		Identifiant de la formation ou du programme de formation associé à l’engagement. (Type string)
type		Type d’engagement : 0 = Formation 1 = Programme de formation (Type Number)
status		Statut de l’engagement. 0 = À faire 1 = Inscrit 2 = Complété 3 = Échoué 4 = Expiré 5 = Annulé 6 = Complété hors délai (Type Number)
creationDate		Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ)
adminCode		Code administratif facultatif pouvant être ajouté à l'engagement, au besoin. (Type string)
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. (String YYYY-MM-DDTHH:MM:SSZ)
billingId		Identifiant unique de l’inscription à la formation ou au programme associé à l’engagement. Si l'engagement a été créé sans "billingId" initialement, le ID JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d sera retourné dans ce champ (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)
lastModificationDate		Date de la dernière modification de l’engagement. Ne peut être modifiée. Disponible en /get et en /getlist.
completionDate		Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ)

Réponse

Exemple du contenu d'appel de réponse de requête de création d'un engagement :

{
   "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'engagement. (Type String)

Commitment/getlist

Permet d'obtenir des informations sur une liste d'engagements.
Adresse de l'appel API : https://.../lmsapi/commitment/getlist

Requête

Exemple de contenu d'appel de requête d'informations au sujet d'une liste d'engagements :

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "filterDate": “YYYY-MM-DDTHH:MM:SSZ”,
  "filterEditDate": “YYYY-MM-DDTHH:MM:SSZ” 
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique d'un utilisateur. Permet d’obtenir seulement la liste des engagements associés à cet utilisateur. (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 modification. Permet d’obtenir la liste des engagements modifiés depuis une date précise. (String YYYY-MM-DDTHH:MM:SSZ)

Réponse

Exemple du contenu d'appel de réponse de requête d'informations au sujet d'une liste d'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		Identifiant unique de l'engagement. (Type string)
userId		Identifiant unique de l’utilisateur associé à l’engagement. (Type string)
refId		Identifiant de la formation ou du programme de formation associé à l’engagement. (Type string)
type		Type d’engagement : 0 = Formation 1 = Programme de formation (Type Number)
adminCode		Code administratif facultatif pouvant être ajouté à l'engagement, au besoin. (Type string)
status		Statut de l’engagement. 0 = À faire 1 = Inscrit 2 = Complété 3 = Échoué 4 = Expiré 5 = Annulé 6 = Complété hors délai (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. (String YYYY-MM-DDTHH:MM:SSZ)
billingId		Identifiant unique de l’inscription à la formation ou au programme associé à l’engagement. Si l'engagement a été créé sans "billingId" initialement, le ID JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d sera retourné dans ce champ. (Type string)
creationDate		Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à 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)
lastModificationDate		Date de la dernière modification de l’engagement. Ne peut être modifiée. Disponible en /get et en /getlist.
completionDate		Date à laquelle l’utilisateur a complété la formation ou le programme de formation lié à l’engagement. (String YYYY-MM-DDTHH:MM:SSZ)

Commitment/delete

Permet de supprimer un engagement.
Adresse de l'appel API : https://.../lmsapi/commitment/delete

Requête

Exemple de contenu d'appel de requête de suppression d'un engagement :

{
   "id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'engagement. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête de suppression d'un engagement :

{
   "id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaire/description
id		Identifiant unique de l'engagement. (Type string)

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.

French

Engagements

Commitment/create

Requête

Description des champs

Réponse

Description des champs

Commitment/get

Requête

Description des champs

Réponse

Description des champs

Commitment/edit

Requête

Description des champs

Réponse

Description des champs

Commitment/getlist

Requête

Description des champs

Réponse

Description des champs

Commitment/delete

Requête

Description des champs

Réponse

Description des champs

Description des codes d’erreurs des méthodes liées aux engagements

Related Articles