Certification (Lära)

Anne AGBACHI

Modifié le : Mer, 13 Oct., 2021 at 11:34 H

CERTIFICATIONS

Certifications : certification/get

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

/certification/get (request) - Requête d'une certification par identifiant

{
   "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

/certification/get (response) - Retourne un objet représentant une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "title": {
        "texts": [
            {
                "text": "Certification title",
                "languageId": 1
            }
        ],
        "ErrorID": 0
    },
    "expirationMode": 0,
    "expiresAfterIntervalType": 0,
    "expiresAfterInterval": 0,
    "expirationReminderMode": 0,
    "expirationReminderIntervalType": 0,
    "expirationReminderInterval": 0,
    "completionMode": 0
}

Certifications : certification/getlist

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

/certification/getlist (request) - Requête de la liste de l'ensemble des certifications

Ne requiert pas de paramètres.

/certification/getlist (response) - Retourne une liste d'objets représentant chacun une certification

Certifications : certification/create

https://www.domaine.com/lmsapi/certification/create

/certification/create (request) - Requête de création d'une certification

{
    "title" : {
        "texts": [
            {
                "text": "Certification",
                "languageId": 1
            }
        ]
    },
    "expirationMode" : "expiresAfter",
    "expiresAfterIntervalType": "days",
    "expiresAfterInterval" : 2,
    "expirationReminderMode" : "RemindsBefore",
    "expirationReminderIntervalType" : "Days",
    "expirationReminderInterval" : 1,
    "completionMode" : "CompleteMinimum",
    "completionPartialNumber": 2,
    "coverId" : "bpQHy%2b2OIU3D7pv6JWcj%2fA%3d%3d",
     "certificateId" : "UzKXbtgIvj%2fxYB79yHENSg%3d%3d"
}

/certification/create (response) - Retourne l'identifiant de la certification créée

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de la certification (Type string) Ce paramètre doit être vide lorsque la méthode en mode création est utilisée, mais obligatoire pour appeler en mode édition
title text languadeId		Text : le titre de la certification 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 = Espagnol (Type Number)
expirationMode		Le mode d'expiration de la certification. 0 = Jamais (valeur par défaut) 1 = Valide pour une période de temps déterminée (Type Number)
expiresAfterIntervalType		Le type de période de temps (années, mois, semaines, jours) spécifique de l'expiration de la certification. Ce champ est obligatoire si le mode d'expiration est 1 0 = Aucun (valeur par défaut) 1 = Jours 2 = Semaines 3 = Mois 4 = Années (Type Number)
expiresAfterInterval		Le nombre d'intervalle de temps (années, mois/semaines/jours) après l'expiration de la certification. Ce champ est obligatoire si le mode d'expiration est 1 La valeur maximale permise est 1000. (Type Number)
expirationReminderMode		Le mode de rappel de l'expiration de la certification. 0 = Changement manuel du statut (valeur par défaut) 1 = Changement automatique du statut (Type Number)
expirationReminderIntervalType		Le type d'intervalle de temps (mois, semaines, jours) du rappel de l'expiration de la certification. Ce champ est obligatoire si le mode de rappel d'expiration est 1 (automatique) 0 = Aucun (valeur par défaut) 1 = Jours 2 = Semaines 3 = Mois (Type Number)
expirationReminderInterval		L'intervalle de temps (mois/semaines/jours) pour rappeler l'expiration de la certification La valeur maximale permise est 1000. (Type Number)
completionMode		Le mode de complétion de la certification (Type Number) 0 = Attribution manuelle de la certification (valeur par défaut) 1 = À la complétion de l'ensemble des programmes/formations 2 = À la complétion d'un nombre minimum de programmes/formations (Type Number)
completionPartialNumber		Le nombre minimum de complétions si le mode de complétion est du type 2. Le nombre maximum est la somme des programmes est formations associés.
coverId		Identifiant unique d'une image pour d'arrière-plan de la certification (Type string)
certificateId		Identifiant unique du certificat (Type string)

Certifications : certification/edit

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

/certification/edit (request) - Requête de modification d’une certification

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d",
    "title": {
        "texts": [
            {
                "text": "Certification newww",
                "languageId": 1
            }
        ]
    }
}

/certification/edit (response) - Retourne l'identifiant de la certification

{ "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d" }

Certifications : certification/delete

https://www.domaine.com/lmsapi/certification/delete

/certification/delete (request) - Requête de suppression d’une certification

{ "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d" }

/certification/delete (response) - Retourne l'identifiant de la certification

{ "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d" }

Certifications : certification/addusers

https://www.domaine.com/lmsapi/certification/addusers

/certification/addusers (request) - Requête d’ajout d'utilisateurs à une certification

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d",
     "users" : [
        {"id":"WLU4WWTo%2fMToYExq1eRlFw%3d%3e" },
        {"id":"TdQNdAVv233NKXZO%2fhSiww%3d%3d" }
     ]
}

/certification/addusers (response) - Retourne l'identifiant de la certification

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

Certifications : certification/getusers

https://www.domaine.com/lmsapi/certification/getusers

/certification/getusers (request) - Requête de la liste des utilisateurs d'une certification

{
    "id": "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

/certification/getusers (response) - Retourne une liste d'objets contenant l'identifiant des utilisateurs d'une certification

[  {
        "id": "WLU4WWTo%2fMToYExq1eRlFw%3d%3d"
    },
    {
        "id": "TdQNdAVv233NKXZO%2fhSiww%3d%3d"
    }
]

Certifications : certification/removeusers

https://www.domaine.com/lmsapi/certification/removeusers

/certification/removeusers (request) - Requête de suppression des utilisateurs d'une certification

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d",
     "users" : [
        {"id":"TdQNdAVv233NKXZO%2fhSiww%3d%3d" }
     ]
}

/certification/removeusers (response) - Retourne l'identifiant de la certification

{
    "id": "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

Certifications : certification/addbranches

https://www.domaine.com/lmsapi/certification/addbranches

/certification/addbranches (request) - Requête d'ajout des branches à une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "branches": [ "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d"]
}

/certification/addbranches (response) - Retourne l'identifiant de la certification

{
    "id": "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

Certifications : certification/getbranches

https://www.domaine.com/lmsapi/certification/getbranches

/certification/getbranches (request) - Requête de listage des branches d'une certification

{
    "id": "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

/certification/getbranches (response) - Retourne une liste d'identifiants des branches d'une certification

[
    "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d"
]

Certifications : certification/removebranches

https://www.domaine.com/lmsapi/certification/removebranches

/certification/removebranches (request) - Requête de la suppression des branches d'une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "branches": ["vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d"]
}

/certification/removebranches (response ) - Retourne l'identifiant de la certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

Certifications : certification/addworkspaces

https://www.domaine.com/lmsapi/certification/addworkspaces

/certification/addworkspaces (request) - Requête d'ajout de formations à une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "workspaces": ["BUdPM6Oa5BmEIGOQUikGRA%3d%3d"]
}

/certification/addworkspaces (response) - Retourne l'identifiant de la certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

Certifications : certification/getworkspaces

https://www.domaine.com/lmsapi/certification/getworkspaces

/certification/getworkspaces(request) - Requête de la liste des formations d'une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

/certification/getworkspaces (response ) - Retourne une liste d'identifiants des formations d'une certification

[
    "BUdPM6Oa5BmEIGOQUikGRA%3d%3d"
]

Certifications : certification/removeworkspaces

https://www.domaine.com/lmsapi/certification/removeworkspaces

/certification/removeworkspaces (request) - Requête de la suppression des formations d'une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "workspaces": ["BUdPM6Oa5BmEIGOQUikGRA%3d%3d"]
}

/certification/removeworkspaces (response ) - Retourne l'identifiant de la certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

Certifications : certification/addprograms

https://www.domaine.com/lmsapi/certification/addprograms

/certification/addprograms (request) - Requête d'ajout de programmes à une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "programs": ["jt9UU9fr%2fppeVdmulnSbPQ%3d%3d"]
}

/certification/addprograms (response) - Retourne l'identifiant de la certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

Certifications : certification/getprograms

https://www.domaine.com/lmsapi/certification/getprograms

/certification/getprograms(request) - Requête de la liste des programmes d'une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

/certification/getprograms (response ) - Retourne la liste d'identifiants des programmes d'une certification

[
    "jt9UU9fr%2fppeVdmulnSbPQ%3d%3d"
]

Certifications : certification/removeprograms

https://www.domaine.com/lmsapi/certification/removeprograms

/certification/removeprograms (request) - Requête de la suppression des programmes d'une certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "programs": ["jt9UU9fr%2fppeVdmulnSbPQ%3d%3d"]
}

/certification/removeprograms (response ) - Retourne l'identifiant de la certification

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d"
}

Description des codes d’erreurs de certification

Numéro	Message	Commentaire/description
2000	Required id	Vous devez fournir un identifiant pour la certification
2001	Invalid id	L’identifiant fourni pour la certification est invalide.
2002	Required title	Vous devez fournir un titre pour la certification.
2003	Invalid languageID	L'identifiant de la langue est invalide.
2004	LanguageID is undefined	L'identifiant de la langue n'est pas défini
2005	Invalid title	Le titre de la certification fourni doit contenir entre 3 et 50 caractères inclusivement.
2006	Invalid expirationMode	Le mode expiration fourni est invalide
2007	Invalid expiresAfterIntervalType	Le type d'expiration avec intervalle fourni est invalide
2008	Required expiresAfterIntervalType	Vous devez fournir le type d'expiration avec intervalle
2009	Required expiresAfterInterval	Vous devez fournir le nombre d'expiration avec intervalle
2010	Invalid expiresAfterInterval	Le nombre d'intervalle d'expiration est invalide
2011	Invalid expirationReminderMode	Le mode de rappel fourni est invalide
2012	Invalid expirationReminderIntervalType	Le type d'intervalle de rappel d'expiration fourni est invalide
2013	Required expirationReminderIntervalType	Vous devez fournir le nombre d'intervalle de rappel d'expiration de la certification
2014	Required expirationReminderInterval	Vous devez fournir le nombre d'intervalle de rappel d'expiration de la certification
2015	Invalid expirationReminderInterval	L'intervalle du rappel d'expiration de la certification est invalide
2016	Invalid completionMode value	Le mode de complétion fourni invalide
2017	Invalid coverId	L'identifiant de l'image de l'arrière plan est invalide
2018	Invalid certificateId	L'identifiant du certificat est invalide
2019	Delete certification failed	La suppression de la certification a échouée.
2020	Required users	Vous devez fournir la liste des utilisateurs
2021	Invalid userId	L'identifiant d'un utilisateur est invalide
2022	User already added	L'ajout des utilisateurs a échoué. Un ou des utilisateur(s) fourni(s) ont été déjà ajoutés à la certification
2023	User is not in certification	La suppression des utilisateurs a échoué. Un ou des utilisateur(s) fourni(s) n'est pas ou ne sont pas dans la certification
2024	Required branches	Vous devez fournir une liste d'identifiants de branche
2025	Branch has been already added	L'ajout des branches a échoué. Une ou des branche(s) fournie(s) ont été déjà ajoutées à la certification
2026	Branch is not in certification	La suppression des branches a échoué. Une ou des branche(s) fournie(s) ne sont pas dans la certification
2027	Required workspaces	Vous devez fournir une liste d'identifiants de formation
2028	Workspace already added	L'ajout des formations a échoué. Une ou des formation(s) fournie(s) ont été déjà ajoutées à la certification
2029	Workspace is not in certification	La suppression des formations a échoué. Une ou des formation(s) fournie(s) ne sont pas dans la certification
2030	Required programs	Vous devez fournir une liste d'identifiants de programme
2031	Program has been already added	L'ajout des programmes a échoué. Un ou des programme(s) fourni(s) ont été déjà ajoutés à la certification
2032	Program is not in certification	La suppression des programmes a échoué. Un ou des programme(s) fourni(s) ne sont pas dans la certification
2033	Cannot add programs/workspaces in "X" completion mode	L'ajout de programmes et formations est possible lorsque le mode de complétion de la certification est 1. X = le nom du completionMode de la certification

French