Cycles - règlement de formation (Lära)

Table des matières

CYCLES
    Cycles : cycle/getlist
    Cycles : cycle/getperiodlist
    Cycles : cycle/getuserprogress
    Cycles : cycle/getmemberstatuses
    Cycles : cycle/updatememberstatuses
    Cycles : cycle/updatememberstatus
    Cycles : cycle/changecurrentmemberstatus
    Description des codes d’erreurs de cycle

CYCLES

Cycles : cycle/getlist

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

Retourne l’ensemble des règlements de votre portail

/cycle/getlist (request) - Requête de la liste des règlements de votre compte portail

{

}

/cycle/getlist (response) - Retourne une liste d'objets règlements

{
"cycleId": "vBW5xMw1VQ2A8DFaNy22zA",
"adminName": "Nom administratif du cycle",
"name": {
"texts": [{
"text": "Mon règlement",
"languageId": 1
}
]
},
"ruleId": "vBW5xMw1VQ2A8DFaNy22zA",
"isActive": true,
"isDeleted": false
}

Description des champs

ATTENTION : En modification, les méthodes 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

cycleId

 

Identifiant unique du règlement. (Type string) 

adminName

 

Nom administratif du règlement tel que vu par les administrateurs dans le système. 

name

      text

      languadeId

 

Text : Nom du règlement tel que vu par les utilisateurs dans le système. (Type string)

languageId : Le nom peut être multilingue : 

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

 (Type Number)

ruleId

 

Identifiant unique de la règle filtrant les utilisateurs qui ont accès au règlement (Type string)

isActive

 

Booléen indiquant si oui ou non le règlement est activé.

isDeleted

 

Booléen indiquant si oui ou non le règlement est supprimé.

Cycles : cycle/getperiodlist

https://www.domaine.com/lmsapi/cycle/getperiodlist

Retourne l’ensemble des périodes dans un règlement

/cycle/getperiodlist (request) - Requête de la liste des périodes dans un règlement

{
"id": "vBW5xMw1VQ2A8DFaNy22zA",
"filterDate": "2020-01-01T00:00:00Z"
}

ATTENTION : Le paramètre de filtre par date est optionnel et correspond à la date de début de l’élément. La méthode retourne la liste des périodes qui débutent après la date passée comme filtre.

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

/cycle/getperiodlist (response) - Retourne une liste d'objets périodes

{
"cyclePeriodId": "vBW5xMw1VQ2A8DFaNy22zA",
"cycleId": "vBW5xMw1VQ2A8DFaNy22zA",
"adminName": "Nom de la période",
"startDate": "2018-02-08T15:02:45.73",
"duration": 2,
"durationUnit": 4,
"isRequirementsShown": false,
"ruleId": "vBW5xMw1VQ2A8DFaNy22zA",
"isUserStatement": true,
"isActive": true,
"isDeleted": true,
"requirements": [
{
"id": " vBW5xMw1VQ2A8DFaNy22zA",
"cyclePeriodId": "vBW5xMw1VQ2A8DFaNy22zA",
"type": 1,
"targetValue": 80.0,
"parentId": "vBW5xMw1VQ2A8DFaNy22zA",
"ruleId": "vBW5xMw1VQ2A8DFaNy22zA",
"providerId": "vBW5xMw1VQ2A8DFaNy22zA"
}]
}

Description des champs

ATTENTION : En modification, les méthodes 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

cyclePeriodId

 

Identifiant unique de la période. (Type string)

cycleId

 

Identifiant unique du règlement. (Type string) 

adminName

 

Nom administratif de la période tel que vu par les administrateurs dans le système. 

startDate

 

Date de début du la période.

duration

 

Durée de la période en heures, jours, semaines, mois ou années selon le durationUnit choisi.

durationUnit

 

Unité de mesure de la durée.

  • 0 = heures
  • 1 = jours
  • 2 = semaines
  • 3 = mois
  • 4 = années

isRequirementsShown

 

Booléen indiquant si on affiche ou non les exigences aux utilisateurs.

ruleId

 

Règles d’affectation pour appliquer le règlement aux utilisateurs associés à cette règle. (Type String)

isUserStatement

 

Booléen indiquant si on exige ou non une déclaration solennelle.

isActive

 

Booléen indiquant si oui ou non la période est activée.

isDeleted

 

Booléen indiquant si oui ou non la période est supprimée.

requirements

 

La liste des requis afin de compléter la période :

  • id : identifiant unique du requis (String)
  • cyclePeriodId : l’identifiant unique de la période (String)
  • type : le type de requis (Integer)
    1. 1 : crédits, 2 : types de formations, 3 : nombre de catégories
  • targetValue : la valeur a atteindre
  • parentId : l’identifiant unique du requis parent (String)
  • ruleId : l’identifiant unique de la règle attachée (String)
  • providerId : l’identifiant unique du fournisseur attaché (String)

Cycles : cycle/getuserprogress

https://www.domaine.com/lmsapi/cycle/getuserprogress

/cycle/getuserprogress (request) – Requête d’information pour un utilisateur

{
"id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
"memberId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
"customFieldAPIName": "custom_field"
}

/cycle/getuserprogress (response) - Retourne les informations concernant la période d’un utilisateur

{
"id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
"memberId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d",
"requiredCredits": 40.0,
"completedCredits": 22.0,
"exemptedCredits": 8.0,
"providerCredits": 30.0,
"customFieldAPIName": "custom_field"
}

Cycles : cycle/getmemberstatuses

https://www.domaine.com/lmsapi/cycle/getmemberstatuses

/cycle/getmemberstatuses (request) – Récupère tous les statuts d’un membre

{
"userId": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
"customFieldAPIName": "member_status",
"customFieldValue": "12345"
}

/cycle/getmemberstatuses (response)

{
"statuses": [
{
"entryId": "uprlbtvuqNuwmncYPu1ljg%3d%3d",
"userId": "CVYG8nO%2b51YLthTCoxBcYA%3d%3d",
"status": "Membre",
"isActiveMember": true,
"startDate": "2020-01-01T00:00:00",
"endDate": "2020-12-31T23:59:59"
}
]
}

Description des champs

Nom

Obligatoire

Commentaires/description

userId

 

Identifiant unique de l’utilisateur. (Type string) 

Utilisé si connu, autrement utiliser customFieldValue et customFieldAPIName.

customFieldAPIName 

 

Nom API du champ personnalisé à cibler. 

Utilisé avec customFieldValue si l’identifiant de l’utilisateur n’est pas connu.

customFieldValue

 

Valeur du champ personnalisé à cibler.

Utilisé avec customFieldAPIName si l’identifiant de l’utilisateur n’est pas connu.

statuses

 

La liste des statuts de l’utilisateur.

       entryId

 

L’identifiant unique de l’entrée de statut.

 

       status

 

Le nom du statut de l’utilisateur.

    isActiveMember

 

Détermine si le membre est considéré actif ou non dans la plage de temps.

    startDate

 

La date de début de la plage du statut.

    endDate

 

La date de fin de la plage du statut (vide si la plage est en cours).

Cycles : cycle/updatememberstatuses

https://www.domaine.com/lmsapi/cycle/updatememberstatuses 

/cycle/updatememberstatuses (request) – Mets à jour tous les statuts d’un membre

{
"userId": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
"customFieldAPIName": "member_status",
"customFieldValue": "12345",
"statuses": [{
"status": "Membre",
"isActiveMember" : true,
"startDate": "2018-02-08T15:02:45.73",
"endDate": "2018-02-08T15:02:45.73"
}]
}

/cycle/updatememberstatuses (response)

{
"isSuccess": true
}

Description des champs

Nom

Obligatoire

Commentaires/description

userId

 

Identifiant unique de l’utilisateur. (Type string) 

Utilisé si connu, autrement utiliser customFieldValue et customFieldAPIName.

customFieldAPIName 

 

Nom API du champ personnalisé à cibler. 

Utilisé avec customFieldValue si l’identifiant de l’utilisateur n’est pas connu.

customFieldValue

 

Valeur du champ personnalisé à cibler.

Utilisé avec customFieldAPIName si l’identifiant de l’utilisateur n’est pas connu.

statuses

 

La liste des statuts à synchroniser.

    status 

 

Le nom du statut à sauvegarder. (Type String)

 

    isActiveMember

 

Champ booleen qui : 

 s’il est spécifié à true, sera considéré comme actif durant la plage de temps spécifiée. 

s’il est spécifié à False, sera considéré comme inactif durant la plage de temps spécifiée. 

s’il n’est pas spécifié (Null = par défaut), sera ignoré. Le champ « status » sera alors utilisé afin de déterminer cette valeur à true si la valeur correspond à une entrée de l’énum suivant : 

membre
member
1ère inscription
inscription
temporaire
limitation du droit d'exercice
suspension du droit d'exercice
 autorisation spéciale

    startDate

 

La date de début de la plage du statut.

    endDate

 

La date de fin de la plage du statut (vide si la plage est en cours).

Cycles : cycle/updatememberstatus

https://www.domaine.com/lmsapi/cycle/updatememberstatus

/cycle/updatememberstatus (request) – Mets à jour le statut d’un membre

{
"userId": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
"customFieldAPIName": "member_status",
"customFieldValue": "12345",
"entryId": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
"status": {
"status": "Membre",
"isActiveMember" : true,
"startDate": "2018-02-08T15:02:45.73",
"endDate": "2018-02-08T15:02:45.73"
}]
}

/cycle/updatememberstatus (response)

{
"isSuccess": true
}

Description des champs

Nom

Obligatoire

Commentaires/description

userId

 

Identifiant unique de l’utilisateur. (Type string) 

Utilisé si connu, autrement utiliser customFieldValue et customFieldAPIName.

customFieldAPIName 

 

Nom API du champ personnalisé à cibler. 

Utilisé avec customFieldValue si l’identifiant de l’utilisateur n’est pas connu.

customFieldValue

 

Valeur du champ personnalisé à cibler.

Utilisé avec customFieldAPIName si l’identifiant de l’utilisateur n’est pas connu.

status

 

Le statut à mettre à jour.

    status 

 

Le nom du statut à sauvegarder. (Type String)

 

    isActiveMember

 

Champ booleen qui : 

 s’il est spécifié à true, sera considéré comme actif durant la plage de temps spécifiée. 

s’il est spécifié à False, sera considéré comme inactif durant la plage de temps spécifiée. 

s’il n’est pas spécifié (Null = par défaut), sera ignoré. Le champ « status » sera alors utilisé afin de déterminer cette valeur à true si la valeur correspond à une entrée de l’énum suivant : 

membre
member
1ère inscription
inscription
temporaire
limitation du droit d'exercice
suspension du droit d'exercice
 autorisation spéciale

    startDate

 

La date de début de la plage du statut.

    endDate

 

La date de fin de la plage du statut (vide si la plage est en cours).

Cycles : cycle/changecurrentmemberstatus

https://www.domaine.com/lmsapi/cycle/changecurrentmemberstatus

/cycle/changecurrentmemberstatus (request) – Ferme la plage active du statut d’un membre et ajoute une nouvelle entrée

{
"userId": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
"customFieldAPIName": "member_status",
"customFieldValue": "12345",
"status": {
"status": "Membre",
"isActiveMember" : true,
"startDate": "2018-02-08T15:02:45.73",
"endDate": "2018-02-08T15:02:45.73"
}]
}

/cycle/changecurrentmemberstatus (response)

{
"isSuccess": true
}

Description des champs

Nom

Obligatoire

Commentaires/description

userId

 

Identifiant unique de l’utilisateur. (Type string) 

Utilisé si connu, autrement utiliser customFieldValue et customFieldAPIName.

customFieldAPIName 

 

Nom API du champ personnalisé à cibler. 

Utilisé avec customFieldValue si l’identifiant de l’utilisateur n’est pas connu.

customFieldValue

 

Valeur du champ personnalisé à cibler.

Utilisé avec customFieldAPIName si l’identifiant de l’utilisateur n’est pas connu.

status

 

Le statut à mettre à jour.

    status 

 

Le nom du statut à sauvegarder. (Type String)

    isActiveMember

 

Champ booleen qui : 

 s’il est spécifié à true, sera considéré comme actif durant la plage de temps spécifiée. 

s’il est spécifié à False, sera considéré comme inactif durant la plage de temps spécifiée. 

s’il n’est pas spécifié (Null = par défaut), sera ignoré. Le champ « status » sera alors utilisé afin de déterminer cette valeur à true si la valeur correspond à une entrée de l’énum suivant : 

membre
member
1ère inscription
inscription
temporaire
limitation du droit d'exercice
suspension du droit d'exercice
 autorisation spéciale

    startDate

 

La date de début de la plage du statut.

    endDate

 

La date de fin de la plage du statut (vide si la plage est en cours).

Description des codes d’erreurs de cycle

Numéro

Message

Commentaires/description

1000

Required id

Vous devez fournir un identifiant pour le cycle

1001

Invalid id

L’identifiant fourni pour le cycle est invalide.

1002

Required memberId

Vous devez fournir un identifiant pour le membre.

1003

Invalid memberId

L’identifiant fourni pour le membre est invalide.

1004

Required customFieldAPIName

Vous devez fournir le nom du champ personnalisé dans l’api.

1005

Invalid customFieldAPIName

Le nom du champ personnalisé dans l’api fourni est invalide.

1006

A list of statuses must be provided

La liste des statuts doit être fournie.

1007

A status must be provided

Un statut non-vide doit être défini.

1008

Invalid status id

L’identifiant de l’entrée d’un statut est invalide.

1009

Invalid user

L’identifiant de l’utilisateur fourni est invalide.

1010

Invalid date

La date de fin de la plage du statut doit être supérieure ou égale à la date de début.

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.