Codes promotionnels
Les « codes promotionnels » sont une composante permettant d'octroyer un rabais applicable dans le panier d'achat pour certains utilisateurs, certaines formations ou programme, ou pour tous. Ils sont nommées « promocode » dans l'API. | ![]() |
Promocode/get
![]() | Permet d'obtenir des informations sur un code promotionnel de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. |
Réponse
Exemple du contenu d'appel de réponse de requête des informations d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
clientId | Identifiant unique de votre organisation sur le serveur de SVIeSolutions. | |
name | Nom du code promotionnel. (Type String) | |
code | Chaîne de caractères du code promotionnel qui sera utilisé par les utilisateurs. (Type String) | |
price | Montant du rabais octroyé par le code promotionnel (selon le champ "type"). (Type number) | |
type | Unité de mesure du code promotionnel.
(Type number) | |
uses | Nombre d'utilisation maximales du code promotionnel. (Type Number) | |
startDate | Date début pour l'utilisation du code promotionnel. Le code ne sera pas utilisable avant cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date fin pour l'utilisation du code promotionnel. Le code ne sera pas utilisable après cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
minPrice | Prix minimum sur la transaction pour l'utilisation du code promotionnel. Sur un prix inférieur, le code ne sera pas utilisable. (Type number) | |
status | Indique si le code promotionnel est activé ou non. Si inactif, le code promotionnel ne sera pas utilisable.
(Type number) | |
canBeCombined | Indique si le code promotionnel peut être utilisé simultanément avec un ou plusieurs autres codes promotionnels partageant cette caractéristique. (Type Booléen) | |
isShownInCatalog | Indique si le code promotionnel sera visible dans le catalogue pour les utilisateurs y ayant droit et s'il sera appliqué automatiquement à leur panier. Cette fonctionnalité ne peut être activée que si "canBeCombined" est à "true". (Type Booléen) | |
isVisibleForUsers | Indique si le code promotionnel sera affiché dans la liste des code promotionnels disponibles à l'utilisateur, dans son dossier et dans le panier d'achats. (Type Booléen) | |
creationDate | Indique la date de création du code promotionnel. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
daysApplicableBeforeStart | Indique le nombre de jours avant le début de la session après quand le code ne sera plus utilisable. Indiquez "0" pour ne pas activer ce paramètre. (Type Number) | |
precision - texts - text - languageId | Text : commentaire affiché lors de l'utilisation du code promotionnel par les utilisateurs dans le système. languageId : Le nom peut être multilingue :
(Type number) | |
description - texts - 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 :
(Type number) |
Promocode/getlist
![]() | Permet d'obtenir des informations sur une liste de codes promotionnels de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
Aucun champ requis. Veuillez entrer des accolades vides. |
Réponse
Exemple du contenu d'appel de réponse de requête des informations d'une liste de codes promotionnels :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
clientId | Identifiant unique de votre organisation sur le serveur de SVIeSolutions. | |
name | Nom du code promotionnel. (Type String) | |
code | Chaîne de caractères du code promotionnel qui sera utilisé par les utilisateurs. (Type String) | |
price | Montant du rabais octroyé par le code promotionnel (selon le champ "type"). (Type number) | |
type | Unité de mesure du code promotionnel.
(Type number) | |
uses | Nombre d'utilisation maximales du code promotionnel. (Type Number) | |
startDate | Date début pour l'utilisation du code promotionnel. Le code ne sera pas utilisable avant cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date fin pour l'utilisation du code promotionnel. Le code ne sera pas utilisable après cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
minPrice | Prix minimum sur la transaction pour l'utilisation du code promotionnel. Sur un prix inférieur, le code ne sera pas utilisable. (Type number) | |
status | Indique si le code promotionnel est activé ou non. Si inactif, le code promotionnel ne sera pas utilisable.
(Type number) | |
canBeCombined | Indique si le code promotionnel peut être utilisé simultanément avec un ou plusieurs autres codes promotionnels partageant cette caractéristique. (Type Booléen) | |
isShownInCatalog | Indique si le code promotionnel sera visible dans le catalogue pour les utilisateurs y ayant droit et s'il sera appliqué automatiquement à leur panier. Cette fonctionnalité ne peut être activée que si "canBeCombined" est à "true". (Type Booléen) | |
isVisibleForUsers | Indique si le code promotionnel sera affiché dans la liste des code promotionnels disponibles à l'utilisateur, dans son dossier et dans le panier d'achats. (Type Booléen) | |
creationDate | Indique la date de création du code promotionnel. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
daysApplicableBeforeStart | Indique le nombre de jours avant le début de la session après quand le code ne sera plus utilisable. Indiquez "0" pour ne pas activer ce paramètre. (Type Number) | |
precision - texts - text - languageId | Text : commentaire affiché lors de l'utilisation du code promotionnel par les utilisateurs dans le système. languageId : Le nom peut être multilingue :
(Type number) | |
description - texts - 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 :
(Type number) |
Promocode/create
![]() | Permet de créer un code promotionnel sur votre environnement. |
Requête
Exemple de contenu d'appel de requête de création d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
name | X | Nom du code promotionnel. (Type String) |
code | Chaîne de caractères du code promotionnel qui sera utilisé par les utilisateurs. (Type String) | |
price | X | Montant du rabais octroyé par le code promotionnel (selon le champ "type"). (Type number) |
type | X | Unité de mesure du code promotionnel.
(Type number) |
uses | Nombre d'utilisation maximales du code promotionnel. (Type Number) | |
startDate | Date début pour l'utilisation du code promotionnel. Le code ne sera pas utilisable avant cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date fin pour l'utilisation du code promotionnel. Le code ne sera pas utilisable après cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
minPrice | Prix minimum sur la transaction pour l'utilisation du code promotionnel. Sur un prix inférieur, le code ne sera pas utilisable. (Type number) | |
status | X | Indique si le code promotionnel est activé ou non. Si inactif, le code promotionnel ne sera pas utilisable.
(Type number) |
canBeCombined | X | Indique si le code promotionnel peut être utilisé simultanément avec un ou plusieurs autres codes promotionnels partageant cette caractéristique. (Type Booléen) |
isShownInCatalog | Indique si le code promotionnel sera visible dans le catalogue pour les utilisateurs y ayant droit et s'il sera appliqué automatiquement à leur panier. Cette fonctionnalité ne peut être activée que si "canBeCombined" est à "true". (Type Booléen) | |
isVisibleForUsers | Indique si le code promotionnel sera affiché dans la liste des code promotionnels disponibles à l'utilisateur, dans son dossier et dans le panier d'achats. (Type Booléen) | |
creationDate | Indique la date de création du code promotionnel. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
daysApplicableBeforeStart | Indique le nombre de jours avant le début de la session après quand le code ne sera plus utilisable. Indiquez "0" pour ne pas activer ce paramètre. (Type Number) | |
precision - texts - text - languageId | Text : commentaire affiché lors de l'utilisation du code promotionnel par les utilisateurs dans le système. languageId : Le nom peut être multilingue :
(Type number) | |
description - texts - 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 :
(Type number) |
Réponse
Exemple du contenu d'appel de réponse de requête de création d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) |
Promocode/getlist
![]() | Permet d'obtenir des informations sur une liste de codes promotionnels de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
Aucun champ requis. Veuillez entrer des accolades vides. |
Réponse
Exemple du contenu d'appel de réponse de requête des informations d'une liste de codes promotionnels :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
clientId | Identifiant unique de votre organisation sur le serveur de SVIeSolutions. | |
name | Nom du code promotionnel. (Type String) | |
code | Chaîne de caractères du code promotionnel qui sera utilisé par les utilisateurs. (Type String) | |
price | Montant du rabais octroyé par le code promotionnel (selon le champ "type"). (Type number) | |
type | Unité de mesure du code promotionnel.
(Type number) | |
uses | Nombre d'utilisation maximales du code promotionnel. (Type Number) | |
startDate | Date début pour l'utilisation du code promotionnel. Le code ne sera pas utilisable avant cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date fin pour l'utilisation du code promotionnel. Le code ne sera pas utilisable après cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
minPrice | Prix minimum sur la transaction pour l'utilisation du code promotionnel. Sur un prix inférieur, le code ne sera pas utilisable. (Type number) | |
status | Indique si le code promotionnel est activé ou non. Si inactif, le code promotionnel ne sera pas utilisable.
(Type number) | |
canBeCombined | Indique si le code promotionnel peut être utilisé simultanément avec un ou plusieurs autres codes promotionnels partageant cette caractéristique. (Type Booléen) | |
isShownInCatalog | Indique si le code promotionnel sera visible dans le catalogue pour les utilisateurs y ayant droit et s'il sera appliqué automatiquement à leur panier. Cette fonctionnalité ne peut être activée que si "canBeCombined" est à "true". (Type Booléen) | |
isVisibleForUsers | Indique si le code promotionnel sera affiché dans la liste des code promotionnels disponibles à l'utilisateur, dans son dossier et dans le panier d'achats. (Type Booléen) | |
creationDate | Indique la date de création du code promotionnel. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
daysApplicableBeforeStart | Indique le nombre de jours avant le début de la session après quand le code ne sera plus utilisable. Indiquez "0" pour ne pas activer ce paramètre. (Type Number) | |
precision - texts - text - languageId | Text : commentaire affiché lors de l'utilisation du code promotionnel par les utilisateurs dans le système. languageId : Le nom peut être multilingue :
(Type number) | |
description - texts - 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 :
(Type number) |
Promocode/edit
![]() | Permet de modifier un code promotionnel sur votre environnement. |
Requête
Exemple de contenu d'appel de requête de modification d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
clientId | Identifiant unique de votre organisation sur le serveur de SVIeSolutions. | |
name | Nom du code promotionnel. (Type String) | |
code | Chaîne de caractères du code promotionnel qui sera utilisé par les utilisateurs. (Type String) | |
price | Montant du rabais octroyé par le code promotionnel (selon le champ "type"). (Type number) | |
type | Unité de mesure du code promotionnel.
(Type number) | |
uses | Nombre d'utilisation maximales du code promotionnel. (Type Number) | |
startDate | Date début pour l'utilisation du code promotionnel. Le code ne sera pas utilisable avant cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date fin pour l'utilisation du code promotionnel. Le code ne sera pas utilisable après cette date. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
minPrice | Prix minimum sur la transaction pour l'utilisation du code promotionnel. Sur un prix inférieur, le code ne sera pas utilisable. (Type number) | |
status | Indique si le code promotionnel est activé ou non. Si inactif, le code promotionnel ne sera pas utilisable.
(Type number) | |
canBeCombined | Indique si le code promotionnel peut être utilisé simultanément avec un ou plusieurs autres codes promotionnels partageant cette caractéristique. (Type Booléen) | |
isShownInCatalog | Indique si le code promotionnel sera visible dans le catalogue pour les utilisateurs y ayant droit et s'il sera appliqué automatiquement à leur panier. Cette fonctionnalité ne peut être activée que si "canBeCombined" est à "true". (Type Booléen) | |
isVisibleForUsers | Indique si le code promotionnel sera affiché dans la liste des code promotionnels disponibles à l'utilisateur, dans son dossier et dans le panier d'achats. (Type Booléen) | |
creationDate | Indique la date de création du code promotionnel. (Type Date YYYY-MM-DDTHH:MM:SSZ) | |
daysApplicableBeforeStart | Indique le nombre de jours avant le début de la session après quand le code ne sera plus utilisable. Indiquez "0" pour ne pas activer ce paramètre. (Type Number) | |
precision - texts - text - languageId | Text : commentaire affiché lors de l'utilisation du code promotionnel par les utilisateurs dans le système. languageId : Le nom peut être multilingue :
(Type number) | |
description - texts - 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 :
(Type number) |
Réponse
Exemple du contenu d'appel de réponse de requête de modification d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) |
Promocode/delete
![]() | Permet de supprimer un code promotionnel de votre environnement. |
Requête
Exemple de contenu d'appel de requête de suppression d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de suppression d'un code promotionnel :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) |
Promocode/adduser
![]() | Permet d'assigner un code promotionnel de votre environnement à un utilisateur. |
Requête
Exemple de contenu d'appel de requête d'assignation d'un code promotionnel de votre environnement à un utilisateur :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
userId | X | Identifiant unique de l'utilisateur. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'assignation d'un code promotionnel de votre environnement à un utilisateur :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
userId | Identifiant unique de l'utilisateur. (Type String) |
Promocode/removeuser
![]() | Permet de retirer l'assignation d'un code promotionnel de votre environnement à un utilisateur. |
Requête
Exemple de contenu d'appel de requête de retrait d'assignation d'un code promotionnel de votre environnement à un utilisateur :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
userId | X | Identifiant unique de l'utilisateur. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de retrait d'assignation d'un code promotionnel de votre environnement à un utilisateur :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
userId | Identifiant unique de l'utilisateur. (Type String) |
Promocode/getuserlist
![]() | Permet d'obtenir une liste des utilisateurs assignés à un code promotionnel de votre environnement. |
Requête
Exemple de contenu d'appel de requête d'une liste des utilisateurs assignés à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'une liste des utilisateurs assignés à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
userId | Identifiant unique de l'utilisateur. (Type String) |
Promocode/addbranch
![]() | Permet d'assigner un code promotionnel de votre environnement aux utilisateurs d'une branche de l'organigramme. |
Requête
Exemple de contenu d'appel de requête d'assignation d'un code promotionnel de votre environnement aux utilisateurs d'une branche de l'organigramme :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
branchId | X | Identifiant unique de la branche. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'assignation d'un code promotionnel de votre environnement aux utilisateurs d'une branche de l'organigramme :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
branchId | Identifiant unique de la branche. (Type String) |
Promocode/removebranch
![]() | Permet de retirer l'assignation d'un code promotionnel de votre environnement des utilisateurs d'une branche de l'organigramme. |
Requête
Exemple de contenu d'appel de requête de retrait d'assignation d'un code promotionnel de votre environnement des utilisateurs d'une branche de l'organigramme :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
branchId | X | Identifiant unique de la branche. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de retrait d'assignation d'un code promotionnel de votre environnement des utilisateurs d'une branche de l'organigramme :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
branchId | Identifiant unique de la branche. (Type String) |
Promocode/getbranchlist
![]() | Permet d'obtenir une liste des branches d'utilisateurs assignés à un code promotionnel de votre environnement. |
Requête
Exemple de contenu d'appel de requête d'une liste des branches d'utilisateurs assignées à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'une liste des branches d'utilisateurs assignées à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
branchId | Identifiant unique de la branche. (Type String) |
Promocode/addgroup
![]() | Permet d'assigner un code promotionnel de votre environnement aux utilisateurs d'un groupe. |
Requête
Exemple de contenu d'appel de requête d'assignation d'un code promotionnel de votre environnement aux utilisateurs d'un groupe :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
groupId | X | Identifiant unique du groupe. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'assignation d'un code promotionnel de votre environnement aux utilisateurs d'un groupe :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
groupId | Identifiant unique du groupe. (Type String) |
Promocode/removegroup
![]() | Permet de retirer l'assignation d'un code promotionnel de votre environnement d'un groupe d'utilisateurs. |
Requête
Exemple de contenu d'appel de requête de retrait d'assignation d'un code promotionnel de votre environnement d'un groupe d'utilisateurs :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
groupId | X | Identifiant unique du groupe. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de retrait d'assignation d'un code promotionnel de votre environnement d'un groupe d'utilisateurs :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
groupId | Identifiant unique du groupe. (Type String) |
Promocode/getgrouplist
![]() | Permet d'obtenir une liste des groupes d'utilisateurs assignés à un code promotionnel de votre environnement. |
Requête
Exemple de contenu d'appel de requête d'une liste des groupes d'utilisateurs assignés à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'une liste des groupes d'utilisateurs assignés à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
groupId | Identifiant unique du groupe. (Type String) |
Promocode/addworkspace
![]() | Permet d'assigner un code promotionnel de votre environnement à une formation. |
Requête
Exemple de contenu d'appel de requête d'assignation d'un code promotionnel de votre environnement à une formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
workspaceId | X | Identifiant unique de la formation. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'assignation d'un code promotionnel de votre environnement à une formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
workspaceId | Identifiant unique de la formation. (Type String) |
Promocode/addworkspaces
![]() | Permet d'assigner un code promotionnel de votre environnement à plusieurs formations. |
Requête
Exemple de contenu d'appel de requête d'assignation d'un code promotionnel de votre environnement à des formations :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
workspaces | X | Identifiants unique des formations. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'assignation d'un code promotionnel de votre environnement à des formations :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
workspaces | Identifiants unique des formations. (Type String) |
Promocode/removeworkspace
![]() | Permet de retirer l'assignation d'un code promotionnel de votre environnement d'une formation. |
Requête
Exemple de contenu d'appel de requête de retrait d'assignation d'un code promotionnel de votre environnement à une formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
workspaceId | X | Identifiant unique de la formation. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de retrait d'assignation d'un code promotionnel de votre environnement à une formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
workspaceId | Identifiant unique de la formation. (Type String) |
Promocode/getworkspacelist
![]() | Permet d'obtenir une liste des formations assignées à un code promotionnel de votre environnement. |
Requête
Exemple de contenu d'appel de requête d'une liste des formations assignées à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'une liste des formations assignées à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
workspaceId | Identifiant unique de la formation. (Type String) |
Promocode/addworkspaceinstance
![]() | Permet d'assigner un code promotionnel de votre environnement à une session de formation. |
Requête
Exemple de contenu d'appel de requête d'assignation d'un code promotionnel de votre environnement à une session de formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
workspaceInstanceId | X | Identifiant unique de la session de formation. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'assignation d'un code promotionnel de votre environnement à une session de formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
workspaceInstanceId | Identifiant unique de la session de formation. (Type String) |
Promocode/addworkspaceinstances
![]() | Permet d'assigner un code promotionnel de votre environnement à plusieurs sessions de formation. |
Requête
Exemple de contenu d'appel de requête d'assignation d'un code promotionnel de votre environnement à des sessions de formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
workspaceInstances | X | Identifiants unique des sessions de formation. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'assignation d'un code promotionnel de votre environnement à des sessions de formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
workspaceInstances | Identifiants unique des sessions de formation. (Type String) |
Promocode/removeworkspaceinstance
![]() | Permet de retirer l'assignation d'un code promotionnel de votre environnement d'une session formation. |
Requête
Exemple de contenu d'appel de requête de retrait d'assignation d'un code promotionnel de votre environnement à une session de formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
workspaceInstanceId | X | Identifiant unique de la session de formation. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de retrait d'assignation d'un code promotionnel de votre environnement à une session de formation :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
workspaceInstanceId | Identifiant unique de la session de formation. (Type String) |
Promocode/getworkspaceinstancelist
![]() | Permet d'obtenir une liste des sessions de formation assignées à un code promotionnel de votre environnement. |
Requête
Exemple de contenu d'appel de requête d'une liste des sessions de formations assignées à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique du code promotionnel. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête d'une liste des sessions de formation assignées à un code promotionnel de votre environnement :
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du code promotionnel. (Type String) | |
workspaceInstanceId | Identifiant unique de la session de formation. (Type String) |
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. |