TABLE DES MATIÈRES Provider/get Provider/getlist Provider/create Provider/edit Description des codes d’erreurs de fournisseur

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. Adresse de l'appel API : https://.../lmsapi/provider/get

Requête

Exemple de contenu d'appel de requête des informations pour un fournisseur de services :

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

Description des champs

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,
    "refundPolicies": [
        {
            "refundPolicyId": "BD3xDerLkQkM1lZrxBxOUw%3d%3d",
            "providerId": "tOUS7VjIr5yFDEemJYsldA%3d%3d",
            "refundPercent": 75.0,
            "daysBeforeEventLimit": 15
        }
    ],
    "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

Provider : provider/getlist

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

Retourne la liste de l’ensemble des fournisseurs de services de votre environnement. Adresse de l'appel API : https://.../lmsapi/provider/getlist

Requête

Exemple de contenu d'appel de requête de la liste des fournisseurs de services :

{
  "filterDate": “YYYY-MM-DDTHH:MM:SSZ”
}

(Date de création minimale) -String (YYYY-MM-DDTHH:MM:SSZ)

Description des champs

Réponse

Exemple de contenu d'appel de réponse de la liste des fournisseurs de services :

[
    {
        "id": "tOUS7VjIr5yFDEemJYsldA%3d%3d",
        "branchId": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",
        "name": {
            "texts": [
                {
                    "text": "SVIeSolutions",
                    "languageId": 1
                }
            ],
            "ErrorID": 0
        },
        "shortName": {
            "texts": [
                {
                    "text": "SVI",
                    "languageId": 1
                }
            ],
            "ErrorID": 0
        },
        "allowUnsubscribe": true,
        "allowLimitSubscribe": true,
        "nbDaysLimitSubscribe": 1,
        "allowSubscribeRebate": true,
        "percentSubscribeRebate": 15.0,
        "nbDaysSubscribeRebate": 20,
        "currencyId": 1,
        "countryId": 37,
        "stateId": 11,
        "creationDate": "2023-01-11T09:29:41.457",
        "createdByUserID": "npx3BF6FKYVE4SX0Ltve2Q%3d%3d"
    }
]

Description des champs

Chaque élément de la liste contient les mêmes champs que ceux retournés par provider/get :

Provider : provider/create

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

Permet de créer un fournisseur de services dans votre environnement. Adresse de l'appel API : https://.../lmsapi/provider/create

Requête

Exemple de contenu d'appel de requête de création d'un fournisseur de services :

{
  "branchId": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d", 
  "allowUnsubscribe": false, 
  "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": []
  }
}

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

Provider : provider/edit

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

Permet de modifier un fournisseur de services existant. Adresse de l'appel API : https://.../lmsapi/provider/edit

Requête

Exemple de contenu d'appel de requête d'édition d'un fournisseur de services :

{
  "id": "BzEm1iKI2qP86aUK38RlVg%3d%3d",
  "branchId": "",
  "allowUnsubscribe": false, 
  "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"
}

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