 | TABL |
Fournisseurs de services
Les « fournisseurs de services » sont les dispensateurs de formations de votre environnement. Un dispensateur dans l'API est nommé « provider ». |  |
Provider/get
 | Retourne l’ensemble des informations relatives à un fournisseur de services de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations pour un fournisseur de services :
{
"id":"tOUS7VjIr5yFDEemJYsldA%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaire/description |
| id | X | Identifiant unique du fournisseur de services. (Type string) |
Réponse
Exemple d'un contenu d'appel de réponse des informations pour un fournisseur de services :
{
"id": "tOUS7VjIr5yFDEemJYsldA%3d%3d",
"branchId": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",
"name": {
"texts": [
{
"text": "SVIeSolutions",
"languageId": 1
},
{
"text": "SVIeSolutions",
"languageId": 2
},
{
"text": "SVIeSolutions",
"languageId": 3
}
],
"ErrorID": 0
},
"shortName": {
"texts": [
{
"text": "SVI",
"languageId": 1
},
{
"text": "SVI",
"languageId": 2
},
{
"text": "SVI",
"languageId": 3
}
],
"ErrorID": 0
},
"allowUnsubscribe": true,
"nbDaysAllowUnsubscribe": 15,
"percentPartialRefund": 75.0,
"allowLimitSubscribe": true,
"nbDaysLimitSubscribe": 1,
"allowSubscribeRebate": true,
"percentSubscribeRebate": 15.0,
"nbDaysSubscribeRebate": 20,
"currencyId": 1,
"countryId": 37,
"stateId": 11,
"providerEmail": "Via",
"providerSenderName": "SVIeSolutions",
"providerEmailDomain": "@SVIeSolutions.com",
"cancellationText": {
"texts": [
{
"text": "<p><strong>Politique d'inscription :</strong></p><ul><li>Les inscriptions ne peuvent être effectuées qu'en ligne sur notre portail de formation.</li><li>Les places sont attribuées dans l'ordre d'inscription.</li><li>Une confirmation d'inscription vous sera envoyée par courrier électronique une fois que nous aurons reçu votre paiement intégral.</li></ul><p><strong>",
"languageId": 1
}
],
"ErrorID": 0
},
"creationDate": "2023-01-11T09:29:41.457",
"createdByUserID": "npx3BF6FKYVE4SX0Ltve2Q%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| Id | X | Identifiant unique du fournisseur de services. |
branchId |
| Identifiant unique de la branche du fournisseur de services. |
name | Nom du fournisseur de services affiché aux administrateurs.
| |
shortName | Nom court du fournisseur de services affiché aux administrateurs.
| |
allowUnsubscribe |
| Permettre ou non l'annulation des inscriptions aux formations pour les utilisateurs en autoinscription. |
nbDaysAllowUnsubscribe |
| Nombre limite de jours avant le début de la date de session pour permettre une annulation d'inscription. |
percentPartialRefund |
| Pourcentage de remboursement applicable lors de l’annulation du participant avant le délai prescrit. |
allowLimitSubscribe |
| Limiter la capacité d'inscription jusqu'à un nombre de jours avant le début de la session. |
nbDaysLimitSubscribe |
| Nombre de jours avant le début de la session pour recevoir les inscriptions. |
allowSubscribeRebate |
| Activer un rabais pour les inscriptions hâtives. |
percentSubscribeRebate |
| Pourcentage de rabais octroyé pour les inscriptions hâtives. |
nbDaysSubscribeRebate |
| Nombre de jours avant le début de la session pour attribuer un rabais hâtif. |
currencyId |
| Identifiant de la devise associée au fournisseur de services.
|
countryId | Pays associé au fournisseur de services. (Voir Annexe 3 : Pays et États/Provinces) | |
stateId | État ou province associée au fournisseur de services. (Voir Annexe 3 : Pays et États/Provinces) | |
cancellationText |
| Politique d'inscription et d'annulation du fournisseur de services.
|
providerEmail |
| La première partie du courriel du fournisseur qui sera utilisée pour envoyer les notifications. Exemple : via dans le courriel via@sviesolutions.com |
providerSenderName |
| Le nom qui sera affiché lors de la réception du courriel. Ex : Support de via |
providerEmailDomain |
| La deuxième partie du courriel du fournisseur qui sera utilisée pour envoyer les notifications. Exemple : @sviesolutions.com dans le courriel via@sviesolutions.com
Ce champ n’est pas modifiable. Il sera seulement disponible dans la requête get. |
Provider : provider/getlist
https://www.domaine.com/lmsapi/provider/getlist
/provider/getlist (request) – Requête une liste des fournisseurs de services du client.
{
"filterDate": “YYYY-MM-DDTHH:MM:SSZ”
}Le paramètre de filtre par date est optionnel et correspond à la date de création de l’élément. La méthode retourne la liste des objets qui ont été créés après la date passée comme filtre.
(Date de création minimale) -String (YYYY-MM-DDTHH:MM:SSZ)
/provider/getlist (response) - Retourne une liste d'objets représentant chacun des fournisseurs de services.
Provider : provider/create
https://www.domaine.com/lmsapi/provider/create
/provider/create (request) - Requête de création d'un fournisseur de services
{
"id": "BzEm1iKI2qP86aUK38RlVg%3d%3d",
"branchId": “”,
"allowUnsubscribe": false,
"nbDaysAllowUnsubscribe": 0,
"percentPartialRefund": 0.0,
"allowLimitSubscribe": false,
"nbDaysLimitSubscribe": 0,
"allowSubscribeRebate": false,
"percentSubscribeRebate": 0.0,
"nbDaysSubscribeRebate": 0,
"currencyId": 2,
"countryId": 37,
"stateId": 11,
"name": {
"texts": [{
"text": "Fournisseur 1",
"languageId": 1
}
]
},
"shortName": {
"texts": [{
"text": "Fournisseur 1",
"languageId": 1
}
]
},
"cancellationText": {
"texts": []
}
}/provider/create (response) - Retourne l'identifiant du fournisseur de services créé
{
"id": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}La fonction vous retourne l’identifiant du fournisseur de services créé.
Provider : provider/edit
https://www.domaine.com/lmsapi/provider/edit
/provider/edit (request) - Requête d'édition d'un fournisseur de services
{
"id": "BzEm1iKI2qP86aUK38RlVg%3d%3d",
"branchID": “”,
"allowUnsubscribe": false,
"nbDaysAllowUnsubscribe": 0,
"percentPartialRefund": 0.0,
"allowLimitSubscribe": false,
"nbDaysLimitSubscribe": 0,
"allowSubscribeRebate": false,
"percentSubscribeRebate": 0.0,
"nbDaysSubscribeRebate": 0,
"currencyID": 2,
"countryId": 37,
"stateId": 11,
"name": {
"texts": [{
"text": "Fournisseur 1",
"languageId": 1
}
]
},
"shortName": {
"texts": [{
"text": "Fournisseur 1",
"languageId": 1
}
]
},
"cancellationText": {
"texts": []
}
"providerEmail": via,
"providerSenderName": Support de via
}ATTENTION : En édition, seule la valeur Id est obligatoire.
/provider/edit (response) - Retourne l'identifiant du fournisseur de services modifié
{
"id": "BzEm1iKI2qP86aUK38RlVg%3d%3d" (Identifiant du Fournisseur de services)
}Description des champs
Nom | Obligatoire | Commentaires/description |
| Id | X | Identifiant unique du fournisseur de services. |
branchId |
| Identifiant unique de la branche du fournisseur de services. |
name | Nom du fournisseur de services affiché aux administrateurs.
| |
shortName text languageId | Text : Nom du fournisseur de service raccourci tel que vu par les utilisateurs dans le système. (Type string doit être entre 5 et 50 caractères) languadeId : Le nom peut être multilingue :
(Type Number) Obligatoire en mode création seulement | |
allowUnsubscribe |
| Permettre ou non l'annulation des inscriptions aux formations pour les utilisateurs en auto-inscription (Type: Boolean, false par défaut) |
nbDaysAllowUnsubscribe |
| Nombre limite de jours avant le début de la date de session pour permettre une annulation d'inscription (Type Short) |
percentPartialRefund |
| Pourcentage de remboursement applicable lors de l’annulation du participant pendant le délai prescrit (Type Number) |
allowLimitSubscribe |
| Limiter les inscriptions jusqu'à un nombre de jours avant le début de la session (Type Boolean)
|
nbDaysLimitSubscribe |
| Limite de jours avant le début de la session pour recevoir des inscriptions (Type Short) |
allowSubscribeRebate |
| Allouer un rabais pour les inscriptions hâtives (Type Boolean) |
percentSubscribeRebate |
| Pourcentage de rabais d'une inscription hâtive (Type Number) |
nbDaysSubscribeRebate |
| Nombre de jours avant le début de la session pour attribuer un rabais (Type Short) |
currencyId |
| Identifiant de la devise associée (Type Number)
|
countryId | Pays du fournisseur de service - Type Number (Voir Annexe 3 : Pays et États/Provinces)
| |
stateId | État ou province du fournisseur de service - Type Number (Voir Annexe 3 : Pays et États/Provinces)
| |
cancellationText text languadeId |
| Textes multilingues de la politique d’inscription et d’annulation
"texts": [{ "text": "Mon annulation", -Type: String "languageId": 1 -Type: Number
|
providerEmail |
| La première partie du courriel du fournisseur qui sera utilisée pour envoyer les notifications. Exemple : via dans le courriel via@sviesolutions.com |
providerSenderName |
| Le nom qui sera affiché lors de la réception du courriel. Ex : Support de via |
providerEmailDomain |
| La deuxième partie du courriel du fournisseur qui sera utilisée pour envoyer les notifications. Exemple : @sviesolutions.com dans le courriel via@sviesolutions.com
Ce champ n’est pas modifiable. Il sera seulement disponible dans la requête get. |
Description des codes d’erreurs de fournisseur
Numéro | Message | Commentaires/description |
300 | Required id | Vous devez fournir un identifiant pour le fournisseur. |
301 | Invalid id | L’identifiant fourni pour le fournisseur est invalide. |
302 | Required branchId | Vous devez fournir un identifiant pour la branche. |
303 | Invalid branchId | L’identifiant fourni pour la branche est invalide. |
304 | Invalid allowLimitSubscribe | Vous devez fournir "True" ou "False". |
305 | Invalid allowSubscribeRebate | Vous devez fournir "True" ou "False". |
306 | Invalid allowUnsubscribe | Vous devez fournir "True" ou "False". |
307 | Required name | Vous devez fournir un nom pour le fournisseur. |
308 | Invalid nameLength | Le nom du fournisseur doit contenir de 3 à 150 caractères inclusivement. |
309 | Required shortName | Vous devez fournir une abréviation pour le fournisseur. |
310 | Invalid shortNameLength | L’abréviation du fournisseur doit contenir de 3 à 50 caractères inclusivement. |
311 | Invalid providerEmailLength | La première partie du courriel est requise et doit contenir de 1 à 250 caractères inclusivement. |
312 | Invalid providerSenderNameLength | Le nom d’expéditeur doit contenir un maximum de 50 caractères. |