Codes promotionnels (Lära)

Miro Lagueux

Modifié le : Mar, 28 Févr., 2023 à 9:10 H

Table des matières

CODES PROMOTIONNELS

Codes promotionnels : promocode/get

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

/promocode/get (request) - Requête d’un code promotionnel par identifiant

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d" (Obligatoire)
}

/promocode/get (response) – Retourne le détail d’un code promotionnel

{
    "id": "f7%2bnQbafdTS0aa67Ay9NOA%3d%3d",
    "clientId": 1,
    "name": "Code promo test UI",
    "code": "TT123UI",
    "price": 10.0,
    "type": 0,
    "uses": -1,
    "startDate": "0001-01-01T00:00:00",
    "endDate": "0001-01-01T00:00:00",
    "minPrice": 0.0,
    "status": 0,
    "canBeCombined": false,
    "isShownInCatalog": false,
    "isVisibleForUsers": false,
    "creationDate": "2023-01-31T13:51:34.113",
    "daysApplicableBeforeStart": 0,
    "precision": {
        "texts": [],
        "ErrorID": 0
    },
    "description": {
        "texts": [
            {
                "text": "Rabais applicable",
                "languageId": 1
            }
        ],
        "ErrorID": 0
    }
}

Codes promotionnels : promocode/getlist

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

/promocode/getlist (request) - Requête de la liste des codes promotionnels

{
}

/promocode/getlist (response) - Retourne une liste d'objets code promotionnel

{
}

Description des champs

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
id		Identifiant unique du code promotionnel. (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.
name		Nom du code promotionnel tel que vu par l’administration. (Type string) Ce paramètre est obligatoire en mode création.
code		Chaine de caractères du code promotionnel qui sera utilisé par les utilisateurs. (Type string) Passer vide pour générer un code aléatoire.
price		Montant du rabais du code promotionnel. (Type number) Ce paramètre est obligatoire en création.
type		Type de rabais du code promotionnel. 0 = Pourcent 1 = Currency (Type number)
uses		Nombre d’utilisation total. (Type Number) Passer vide pour un nombre illimité d’utilisation.
startDate		Date de disponibilité du code promotionnel. (Type date YYYY-MM-DDTHH:MM:SSZ) Passer vide pour ne pas avoir de date de disponibilité.
endDate		Date d’échéance du code promotionnel. (Type date YYYY-MM-DDTHH:MM:SSZ) Passer vide pour ne pas avoir de date d’échéance.
minPrice		Montant minimum de la facture pour l’utilisation du code promotionnel. (Type number) Passer vide pour ne pas avoir de minimum.
status		Statut d’activation du code promotionnel. 0 = Actif 1 = Inactif (Type number) Ce paramètre est obligatoire en création.
canBeCombined		Indique si le code promotionnel peut être jumelé à d’autres codes promotionnels. (Type boolean) Ce paramètre est obligatoire en création.
isShownInCatalog		Indique si le code promotionnel sera visible dans le catalogue par les utilisateurs y ayant droit et sera appliqué automatiquement à leur panier.
isVisibleForUsers		Indique si le code promotionnel sera visible dans la liste des codes disponibles à l'utilisateur
daysApplicableBeforeStart		Le code promotionnel est valide jusqu’à ce nombre de jours avant le début de la session/cohorte. (Type number) Passer vide pour ne pas appliquer cette validation.
creationDate		Date de création du code promotionnel Ne peut être modifié. Disponible sur get et getlist.
precision text languageId		Text : Précision du code promotionnel 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)
description text languageId		Text : Description du code promotionnel tel que vu par les utilisateurs dans le système. (Type string) languageId : Le texte peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type number)

Codes promotionnels : promocode/create

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

/promocode/create (request) - Requête de création d'un code promotionnel

{
"name": "Code promo test",
"code": "TT12cvdsI1",
"price": 120,
"type": 0,
"status": 0,
"canBeCombined": false,
"startDate": "2020-01-01T00:00:00",
"endDate": "2022-01-01T00:00:00",
"minPrice": 0.0,
"isShownInCatalog": false,
"isVisibleForUsers": false,
"daysApplicableBeforeStart": 0,
"precision": {
       "texts": [],
        "ErrorID": 0
    },
"description": {
        "texts": [
            {
                "text": "Rabais applicable",
                "languageId": 1
            }
        ],
        "ErrorID": 0
    }
}

/promocode/create (response) - Retourne l'identifiant du code promotionnel créé

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

Codes promotionnels : promocode/edit

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

/promocode/edit (request) - Requête d’édition d'un code promotionnel

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d", 
  "name": "nom de code promotionnel",
  "code": "moncode",
  "price": 10,
  "type": 0,
  "uses": 50,
  "startDate": "2018-01-02",
  "endDate": "2018-01-02",
  "minPrice": 20,
  "status": 0,
  "canBeCombined": false, 
  "isShownInCatalog": false, 
  "precision": {
    "texts": [{
        "text": "MonCodePromotionnel",
        "languageId": 1
      }
    ]
  },
  "description": {
    "texts": [{
        "text": "<b>Rabais promotionnel</b>",
        "languageId": 1
      }
    ]
  }
}

/promocode/edit (response) - Retourne l’identifiant du code promotionnel modifié

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

Codes promotionnels : promocode/delete

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

/promocode/delete (request) - Requête de suppression d’un code promotionnel

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

/promocode/delete (response) - Retourne l'identifiant du code promotionnel supprimé

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

Codes promotionnels : promocode/adduser

https://www.domaine.com/lmsapi/promocode/adduser

/promocode/adduser (request) - Requête d’association d’un utilisateur au code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/promocode/adduser (response) - Retourne l'identifiant du code promotionnel et de l’utilisateur associé

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Codes promotionnels : promocode/removeuser

https://www.domaine.com/lmsapi/promocode/removeuser

/promocode/removeuser (resquest) – Désassocie un utilisateur du code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/promocode/removeuser (response) - Retourne l'identifiant du code promotionnel et de l’utilisateur retiré

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Codes promotionnels : promocode/getuserlist

https://www.domaine.com/lmsapi/promocode/getuserlist

/promocode/getuserlist (request) - Requête de la liste des utilisateurs associé à un code promotionnel

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

/promocode/getuserlist (response) - Retourne une liste d'objets d’identifiant de code promotionnel et utilisateur

[  
{
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "userId": "4QQXEdQX%2b7gBIY5XZnf8wA%3d%3d"
  }, {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "userId": "pzyzfI5r15GwFhURAZB8pQ%3d%3d"
  }
]

Codes promotionnels : promocode/addbranch

https://www.domaine.com/lmsapi/promocode/addbranch

/promocode/addbranch (resquest) - Requête d’association d’une branche au code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

/promocode/addbranch (response) - Retourne l'identifiant du code promotionnel et de la branche ajoutée

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Codes promotionnels : promocode/removebranch

https://www.domaine.com/lmsapi/promocode/removebranch

/promocode/removebranch (request) - Désassocie une branche d’un code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

/promocode/removebranch (response) - Retourne l'identifiant du code promotionnel et de la branche retirée

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Codes promotionnels : promocode/getbranchlist

https://www.domaine.com/lmsapi/promocode/getbranchlist

/promocode/getbranchlist (request) - Requête de la liste des branches associée à un code promotionnel

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

/promocode/getbranchlist (response) - Retourne une liste d'objets d’identifiant de code promotionnel et de branche

[{
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "branchId": "edFrrvGGeT9KI0783Dznkw%3d%3d"
  }, {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
  }
]

Codes promotionnels : promocode/addgroup

https://www.domaine.com/lmsapi/promocode/addgroup

/promocode/addgroup (request) - Requête d’association d’un groupe au code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}

/promocode/addgroup (response) - Retourne l'identifiant du code promotionnel et du groupe ajouté

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}

Codes promotionnels : promocode/removegroup

https://www.domaine.com/lmsapi/promocode/removegroup

/promocode/removegroup (request) – Désassocie un groupe d’un code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}

/promocode/removegroup (response) - Retourne l'identifiant du code promotionnel et du groupe retiré

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}

Codes promotionnels : promocode/getgrouplist

https://www.domaine.com/lmsapi/promocode/getgrouplist

/promocode/getgrouplist (request) - Requête de la liste des groupes associé à un code promotionnel

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

/promocode/getgrouplist (response) - Retourne une liste d'objets d’identifiant de code promotionnel et de groupe

[{
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
  }, {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "groupId": "TdQNdAVv233NKXZO%2fhSiww%3d%3d"
  }
]

Codes promotionnels : promocode/addworkspace

https://www.domaine.com/lmsapi/promocode/addworkspace

/promocode/addworkspace (request) - Requête d’association d’une formation ou événement au code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

/promocode/addworkspace (response) - Retourne l'identifiant du code promotionnel et de la formation/événement ajouté

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

Codes promotionnels : promocode/addworkspaces

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

/promocode/addworkspaces (request) - Requête d’association de formations au code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaces": [
        "BzEm1iKId2qsP86aUKd38RlgVg%3df%3d",
        "sBzEm1iKI2dqP8f6aUK3g8RldVg%3dd%3d"
    ] 
}

/promocode/addworkspaces (response) - Retourne l'identifiant du code promotionnel et les formations ajoutées

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaces": [
        "BzEm1iKId2qsP86aUKd38RlgVg%3df%3d",
        "sBzEm1iKI2dqP8f6aUK3g8RldVg%3dd%3d"
    ] 
}

Codes promotionnels : promocode/removeworkspace

https://www.domaine.com/lmsapi/promocode/removeworkspace

/promocode/removeworkspace (request) – Désassocie une formation ou événement du code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

/promocode/removeworkspace (response) - Retourne l'identifiant du code promotionnel et de la formation ou événement retiré

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

Codes promotionnels : promocode/getworkspacelist

https://www.domaine.com/lmsapi/promocode/getworkspacelist

/promocode/getworkspacelist (request) - Requête de la liste des formations ou événements d’un code promotionnel

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

/promocode/getworkspacelist (response) - Retourne une liste d'objets d’identifiant de code promotionnel et de formation ou événement

[{
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
  }, {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "workspaceId": "eSLZD6T4RLI7xzud7a%2bhOA%3d%3d"
  }
]

Codes promotionnels : promocode/addworkspaceinstance

https://www.domaine.com/lmsapi/promocode/addworkspaceinstance

/promocode/addworkspaceinstance (request) - Requête d’association d’une session au code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceInstanceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

/promocode/addworkspaceinstance (response) - Retourne l'identifiant du code promotionnel et de la session ajouté

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceInstanceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

Codes promotionnels : promocode/addworkspaceinstances

https://www.domaine.com/lmsapi/promocode/addworkspaceinstances

/promocode/addworkspaceinstances (request) - Requête d’association de sessions au code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceInstances": [
        "BzEm1iKId2qsP86aUKd38RlgVg%3df%3d",
        "sBzEm1iKI2dqP8f6aUK3g8RldVg%3dd%3d"
    ] 
}

/promocode/addworkspaceinstances (response) - Retourne l'identifiant du code promotionnel et les sessions ajoutées

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceInstances": [
        "BzEm1iKId2qsP86aUKd38RlgVg%3df%3d",
        "sBzEm1iKI2dqP8f6aUK3g8RldVg%3dd%3d"
    ] 
}

Codes promotionnels : promocode/removeworkspaceinstance

https://www.domaine.com/lmsapi/promocode/removeworkspaceinstance

/promocode/removeworkspaceinstance (request) – Désassocie une session du code promotionnel

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceInstanceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

/promocode/removeworkspaceinstance (response) - Retourne l'identifiant du code promotionnel et de la session retiré

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceInstanceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

Codes promotionnels : promocode/getworkspaceinstancelist

https://www.domaine.com/lmsapi/promocode/getworkspaceinstancelist

/promocode/getworkspaceinstancelist (request) - Requête de la liste des sessions d’un code promotionnel

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

/promocode/getworkspaceinstancelist (response) - Retourne une liste d'objets d’identifiant de code promotionnel et de session

[{
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "workspaceInstanceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
  }, {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "workspaceInstanceId": "eSLZD6T4RLI7xzud7a%2bhOA%3d%3d"
  }
]

Description des codes d’erreurs de code promotionnel

Numéro	Message	Commentaires/description
1300	Required id	Vous devez fournir un identifiant pour le code promotionnel.
1301	Invalid id	L’identifiant fourni pour le code promotionnel est invalide.
1302	Required name	Vous devez fournir un nom pour le code promotionnel.
1303	Invalid name length	La taille du nom fourni pour le code promotionnel est invalide. Il doit contenir un minimum de 3 et un maximum de 50 caractères.
1304	Invalid code length	La taille du code fourni pour le code promotionnel est invalide. Il doit contenir un minimum de 3 et un maximum de 50 caractères.
1305	Required price	Vous devez fournir un montant pour le code promotionnel.
1306	Required type	Vous devez fournir le type de rabais du code promotionnel.
1307	Invalid type	Le type fourni pour le code promotionnel est invalide.
1308	Required status	Vous devez fournir le statut d’activation du code promotionnel.
1309	Invalid status	Le statut fourni pour le code promotionnel est invalide.
1310	Required canBeCombined	Vous devez fournir "True" ou "False".
1311	Invalid precision length	La taille du texte de précision fourni pour le code promotionnel est invalide. Il doit contenir un minimum de 5 et un maximum de 250 caractères.
1312	Branch already in promo code	La branche est déjà associée au code promotionnel.
1313	Code already exists	Le code fourni existe déjà. Vous devez en choisir un autre.
1314	Required workspaceInstances	Vous devez fournir une liste d'identifiants de sessions.
1315	Required workspaces	Vous devez fournir une liste d'identifiants de formations.

French