 | TABLE OF CONTENTS Provider/getProvider/getlist Provider/create Provider/edit Provider error code descriptions |
Service providers
The "service providers" are the training providers in your environment. A provider in the API is named "provider". |  |
Provider/get
 | Returns all the information relating to a service provider in your environment. |
Request
Example of request call content for information on a service provider:
{
"id":"tOUS7VjIr5yFDEemJYsldA%3d%3d"
}Field descriptions
| Name | Required | Comment/description |
| id | X | Unique identifier of the service provider. (String type) |
Response
Example of response call content for information on a service provider:
{
"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"
}Field descriptions
Name | Comments/description |
| Id | Unique identifier of the service provider. |
branchId | Unique identifier of the branch of the service provider. |
name | Name of the service provider displayed to administrators.
|
shortName | Short name of the service provider displayed to administrators.
|
allowUnsubscribe | Whether to allow the cancellation of training enrolments for self-enrolled users. |
allowLimitSubscribe | Limit the enrolment capacity up to a number of days before the start of the session. |
nbDaysLimitSubscribe | Number of days before the start of the session during which enrolments are accepted. |
allowSubscribeRebate | Enable a discount for early enrolments. |
percentSubscribeRebate | Discount percentage granted for early enrolments. |
nbDaysSubscribeRebate | Number of days before the start of the session for granting an early discount. |
currencyId | Identifier of the currency associated with the service provider.
|
countryId | Country associated with the service provider. (See Appendix 3: Countries and States/Provinces) |
stateId | State or province associated with the service provider. (See Appendix 3: Countries and States/Provinces) |
cancellationText | Enrolment and cancellation policy of the service provider.
|
providerEmail | The first part of the provider's email address that will be used to send notifications. Example: via in the email address via@sviesolutions.com |
providerSenderName | The name that will be displayed when the email is received. E.g.: Support de via |
providerEmailDomain | The second part of the provider's email address that will be used to send notifications. Example: @sviesolutions.com in the email address via@sviesolutions.com
This field cannot be modified. It is only available in the get request. |
| refundPolicies | Refund policies associated with the service provider.
|
| creationDate | Creation date of the service provider. |
| createdByUserID | Unique identifier of the user who created the service provider. |
Provider : provider/getlist
https://www.domaine.com/lmsapi/provider/getlist
| Returns the list of all the service providers in your environment. |
Request
Example of request call content for the list of service providers:
{
"filterDate": “YYYY-MM-DDTHH:MM:SSZ”
}The date filter parameter is optional and corresponds to the creation date of the element. The method returns the list of objects that were created after the date passed as a filter.
(Minimum creation date) - String (YYYY-MM-DDTHH:MM:SSZ)
Field descriptions
| Name | Required | Comments/description |
| filterDate | Optional parameter corresponding to the creation date of the element. The method returns the list of objects that were created after the date passed as a filter. Type: String (YYYY-MM-DDTHH:MM:SSZ) |
Response
Example of response call content for the list of service providers:
[
{
"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"
}
]Field descriptions
Each element of the list contains the same fields as those returned by provider/get:
Name | Comments/description |
| Id | Unique identifier of the service provider. |
branchId | Unique identifier of the branch of the service provider. |
name | Name of the service provider displayed to administrators.
|
shortName | Short name of the service provider displayed to administrators.
|
allowUnsubscribe | Whether to allow the cancellation of training enrolments for self-enrolled users. |
allowLimitSubscribe | Limit the enrolment capacity up to a number of days before the start of the session. |
nbDaysLimitSubscribe | Number of days before the start of the session during which enrolments are accepted. |
allowSubscribeRebate | Enable a discount for early enrolments. |
percentSubscribeRebate | Discount percentage granted for early enrolments. |
nbDaysSubscribeRebate | Number of days before the start of the session for granting an early discount. |
currencyId | Identifier of the currency associated with the service provider.
|
countryId | Country associated with the service provider. (See Appendix 3: Countries and States/Provinces) |
stateId | State or province associated with the service provider. (See Appendix 3: Countries and States/Provinces) |
cancellationText | Enrolment and cancellation policy of the service provider.
|
providerEmail | The first part of the provider's email address that will be used to send notifications. Example: via in the email address via@sviesolutions.com |
providerSenderName | The name that will be displayed when the email is received. E.g.: Support de via |
providerEmailDomain | The second part of the provider's email address that will be used to send notifications. Example: @sviesolutions.com in the email address via@sviesolutions.com
This field cannot be modified. It is only available in the get request. |
| refundPolicies | Refund policies associated with the service provider.
|
| creationDate | Creation date of the service provider. |
| createdByUserID | Unique identifier of the user who created the service provider. |
Provider : provider/create
https://www.domaine.com/lmsapi/provider/create
| Creates a service provider in your environment. |
Request
Example of request call content to create a service provider:
{
"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": []
}
}Field descriptions
| Name | Required | Comments/description |
| branchId | X | Unique identifier of the branch to which the service provider is attached. (String type) |
| name | X | Name of the service provider displayed to administrators, as multilingual texts (texts). (String type, between 3 and 150 characters) |
| shortName | X | Short name of the service provider, as multilingual texts (texts). (String type, between 3 and 50 characters) |
| allowUnsubscribe | Whether to allow the cancellation of training enrolments for self-enrolled users. (Boolean type, false by default) | |
| allowLimitSubscribe | Limit enrolments up to a number of days before the start of the session. (Boolean type) | |
| nbDaysLimitSubscribe | Number of days before the start of the session during which enrolments are accepted. (Short type) | |
| allowSubscribeRebate | Grant a discount for early enrolments. (Boolean type) | |
| percentSubscribeRebate | Discount percentage for an early enrolment. (Number type) | |
| nbDaysSubscribeRebate | Number of days before the start of the session for granting a discount. (Short type) | |
| currencyId | Identifier of the currency associated with the service provider. 1 = CAD, 2 = USD, 3 = EUR (Number type) | |
| countryId | Country of the service provider. (Number type – See Appendix 3: Countries and States/Provinces) | |
| stateId | State or province of the service provider. (Number type – See Appendix 3: Countries and States/Provinces) | |
| cancellationText | Enrolment and cancellation policy, as multilingual texts (texts). (String type) |
Response
Example of response call content when creating a service provider:
{
"id": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}The function returns the identifier of the created service provider.
Field descriptions
| Name | Comments/description |
| id | Unique identifier of the created service provider. (String type) |
Provider : provider/edit
https://www.domaine.com/lmsapi/provider/edit
| Modifies an existing service provider. |
Request
Example of request call content to edit a service provider:
{
"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"
}IMPORTANT: When editing, only the Id value is required.
Field descriptions
Name | Required | Comments/description |
| Id | X | Unique identifier of the service provider. |
branchId |
| Unique identifier of the branch of the service provider. |
name | Name of the service provider displayed to administrators.
| |
shortName text languageId | Text: Short name of the service provider as seen by users in the system. (String type, must be between 5 and 50 characters) languageId: The name can be multilingual:
(Number type) Required in creation mode only | |
allowUnsubscribe |
| Whether to allow the cancellation of training enrolments for self-enrolled users (Boolean type, false by default) |
percentPartialRefund |
| Refund percentage applicable when the participant cancels within the prescribed period (Number type) |
allowLimitSubscribe |
| Limit enrolments up to a number of days before the start of the session (Boolean type)
|
nbDaysLimitSubscribe |
| Day limit before the start of the session during which enrolments are accepted (Short type) |
allowSubscribeRebate |
| Grant a discount for early enrolments (Boolean type) |
percentSubscribeRebate |
| Discount percentage for an early enrolment (Number type) |
nbDaysSubscribeRebate |
| Number of days before the start of the session for granting a discount (Short type) |
currencyId |
| Identifier of the associated currency (Number type)
|
countryId | Country of the service provider - Number type (See Appendix 3: Countries and States/Provinces)
| |
stateId | State or province of the service provider - Number type (See Appendix 3: Countries and States/Provinces)
| |
cancellationText text languageId |
| Multilingual texts of the enrolment and cancellation policy
"texts": [{ "text": "Mon annulation", - Type: String "languageId": 1 - Type: Number
|
providerEmail |
| The first part of the provider's email address that will be used to send notifications. Example: via in the email address via@sviesolutions.com |
providerSenderName |
| The name that will be displayed when the email is received. E.g.: Support de via |
providerEmailDomain |
| The second part of the provider's email address that will be used to send notifications. Example: @sviesolutions.com in the email address via@sviesolutions.com
This field cannot be modified. It is only available in the get request. |
Response
Example of response call content when editing a service provider:
{
"id": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}Field descriptions
| Name | Comments/description |
| id | Unique identifier of the modified service provider. (String type) |
Provider error code descriptions
Number | Message | Comments/description |
300 | Required id | You must provide an identifier for the provider. |
301 | Invalid id | The identifier provided for the provider is invalid. |
302 | Required branchId | You must provide an identifier for the branch. |
303 | Invalid branchId | The identifier provided for the branch is invalid. |
304 | Invalid allowLimitSubscribe | You must provide "True" or "False". |
305 | Invalid allowSubscribeRebate | You must provide "True" or "False". |
306 | Invalid allowUnsubscribe | You must provide "True" or "False". |
307 | Required name | You must provide a name for the provider. |
308 | Invalid nameLength | The provider name must contain between 3 and 150 characters inclusively. |
309 | Required shortName | You must provide a short name for the provider. |
310 | Invalid shortNameLength | The provider short name must contain between 3 and 50 characters inclusively. |
311 | Invalid providerEmailLength | The first part of the email address is required and must contain between 1 and 250 characters inclusively. |
312 | Invalid providerSenderNameLength | The sender name must contain a maximum of 50 characters. |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article