UTILISATEURS
Les « utilisateurs » correspondent à tout compte créé dans votre environnement Lära LMS, et sont nommées dans l'API « user ». |  |
User/get
 | Retourne l’ensemble des informations relatives à un utilisateur spécifiquement. |
Requête
Exemple de contenu d'appel de requête des informations pour un utilisateur :
{
"id": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaire/description |
| id | X | Identifiant unique de l'utilisateur. (Type string) |
Réponse
Exemple d'un contenu d'appel de réponse des informations pour un utilisateur :
{
"id": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
"websiteId": "ZRtLSlsH5%2bKhhAxU0I4Lgg%3d%3d",
"login": "Jhemington",
"firstName": "Jessica",
"lastName": "Hemington",
"language": 1,
"email": "jhemington@sviesolutions.com",
"companyName": "SVIeSolutions",
"functionTitle": "Agentes des ressources humaines",
"hourlyWage": 0.00,
"phoneHome": "418 948-4848",
"phoneMobile": "418 948-4848",
"phoneWork": "418 948-4848",
"phonePublic": 0,
"timeZone": 10,
"address": "234, du Faubourg",
"address2": "bur. 404",
"postalCode": "1H1 H1H",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"portalId": "pVwwetET1HGiEZIfRQOoxo%3d%3d",
"inscriptionDate": "2021-10-08T09:21:37.657",
"expirationDate": "0001-01-01T00:00:00",
"enableNotifications": true,
"viaAccessMode": 0,
"status": 0,
"customFields": {
"ismember": true,
"job_title": "RH",
"Num_membre": "17MQ198"
},
"approverUserId": "y9DDvS6G4UzxlxV%2fPuEWqA%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. Ce paramètre doit être vide lorsque la méthode create est utilisée, mais obligatoire pour le mode édition. | |
| websiteId | Il s’agit de l’identifiant unique de l'utilisateur dans l'interface Lära LMS. | |
login |
| Identifiant de l'utilisateur. (Type String, >=4 et <= 250 caractère. Il doit s'agir d'un identifiant unique sur le serveur) |
firstName | Prénom de l'utilisateur. (Type String, <=50 caractères) | |
lastName | Nom de famille de l'utilisateur. (Type String, <=50 caractères) | |
language | La langue d’affichage par défaut est paramétrable selon la liste des constantes suivantes :
Si cette valeur est vide, l’API utilise la langue définie par défaut pour l’organisation dans laquelle l’utilisateur est créé. (Type Number) | |
Une validation du format est effectuée par le service web conformément au standard RFC2822 (<=100 caractères et le courriel doit être valide) | ||
companyName |
| Nom de compagnie de l'utilisateur. (Type String <=100 caractères) |
functionTitle |
| Fonction de l'utilisateur dans l’organisation. (Type String <= 100 caractères) |
| hourlyWage | Taux horaire de l'utilisateur. (Type Decimal <= 999, max 2 décimales) | |
phoneHome |
| Numéro de téléphone de l'utilisateur. (Type String <=40 caractères) |
phoneMobile |
| Numéro de téléphone mobile de l'utilisateur. (Type String <=40 caractères) |
phoneWork |
| Numéro de téléphone au travail de l'utilisateur. (Type String <=40 caractères |
phonePublic |
| Le phonePublic indique quel numéro de téléphone sera diffusé aux autres utilisateurs de Via selon la liste des constantes suivantes :
Lorsque ce paramètre est vide, la valeur 0 est appliquée. (Type Number) |
timeZone |
| Les utilisateurs de via sont invités à des rencontres communes sans toutefois être au même emplacement. Via donne donc la possibilité à chacun de gérer son fuseau horaire pour visualiser les rencontres selon son heure. La liste complète des constantes (0 à 77) est disponible en annexe du document. |
address |
| Adresse de l’utilisateur. (Type String <=100 caractères) |
address2 |
| Informations additionnelles sur l’adresse (app, boite à lettre, étage). (Type String, <=100 caractères) |
postalCode |
| Code postal de l’utilisateur. (Type String <=50 caractères) |
city |
| Ville de l’utilisateur. (Type String <=100 caractères) |
countryId |
| Pays de l’utilisateur – Type Number (Voir Annexe 3 : Pays et États/Provinces). |
stateId |
| Chiffre indiquant l'état de l'utilisateur - Type Number (Voir Annexe 3 : Pays et États/Provinces). |
portalID |
| Identifiant du portail par défaut de l’utilisateur (Type String) |
| inscriptionDate | La date de création du compte utilisateur. | |
| expirationDate | La date d'expiration du compte utilisateur. | |
enableNotifications | Indique si l’utilisateur pourra recevoir par courriel des notifications liées au fonctionnement du site et des campagnes de promotion. Par défaut à « true » | |
| viaAccessMode | Indique le mode d'accès à Via Classique, si votre organisation utilise toujours ce logiciel.
| |
| status | (Lecture seule) Indique l'état d'activation du compte utilisateur.
(Type Number) | |
customFields |
| Champs sur mesure reliés à l’utilisateur. |
| approverUserId | Identifiant de l'approbateur de l'utilisateur (Type String) |
User/getlist
 | Retourne une liste d'utilisateurs de votre environnement. |
Requête
Exemple de contenu d'appel de requête d'une liste d'utilisateurs :
{
"filterDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterEditDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterIndex" : 2
}Description des champs
| Nom | Obligatoire | Commentaire/description |
filterDate | Date de la création du compte utilisateur dans l'environnement. L'appel retournera les comptes créé après ce moment. Peut être utilisé avec filterEditDate ou seul. (Type String, YYYY-MM-DDTHH:MM:SSZ) | |
| filterEditDate | Date de la dernière modification du compte utilisateur dans l'environnement. L'appel retournera les comptes modifiés après ce moment. Peut être utilisé avec filterDate ou seul. La date de modification est aussi modifiée lors de la création. (Type String, YYYY-MM-DDTHH:MM:SSZ) | |
| filterIndex | L'appel retourne par défaut les utilisateurs 1 à 200 (filterIndex = 1), et un filtre par index de 2 retourne les utilisateurs de 201 à 400. |
Réponse
Exemple d'un contenu d'appel de réponse d'une liste d'utilisateurs :
[
{
"id": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
"websiteId": "ZRtLSlsH5%2bKhhAxU0I4Lgg%3d%3d",
"login": "Jhemington",
"firstName": "Jessica",
"lastName": "Hemington",
"language": 1,
"email": "jhemington@sviesolutions.com",
"companyName": "SVIeSolutions",
"functionTitle": "Agentes des ressources humaines",
"phoneHome": "418 948-4848",
"phoneMobile": "418 948-4848",
"phoneWork": "418 948-4848",
"phonePublic": 0,
"timeZone": 10,
"address": "234, du Faubourg",
"address2": "bur. 404",
"postalCode": "1H1 H1H",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"portalId": "pVwwetET1HGiEZIfRQOoxo%3d%3d",
"inscriptionDate": "2021-10-08T09:21:37.657",
"expirationDate": "0001-01-01T00:00:00",
"enableNotifications": true,
"viaAccessMode": 0,
"status": 0,
"customFields": {
"ismember": true,
"job_title": "RH",
"Num_membre": "17MQ198"
}
},
{
"id": "PocQsTYxCq%2frp6YE%2bkHIjg%3d%3d",
"websiteId": "ZFqLDlsH5%2bKhhAxU0I4Lgg%3d%3d",
"login": "Rhemington",
"firstName": "Rebbeca",
"lastName": "Hemington",
"language": 1,
"email": "rhemington@sviesolutions.com",
"companyName": "SVIeSolutions",
"functionTitle": "Agentes des ressources humaines",
"phoneHome": "418 948-4848",
"phoneMobile": "418 948-4848",
"phoneWork": "418 948-4848",
"phonePublic": 0,
"timeZone": 10,
"address": "234, du Faubourg",
"address2": "bur. 404",
"postalCode": "1H1 H1H",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"portalId": "pVwwetET1HGiEZIfRQOoxo%3d%3d",
"inscriptionDate": "2021-10-08T09:21:37.657",
"expirationDate": "0001-01-01T00:00:00",
"enableNotifications": true,
"viaAccessMode": 0,
"status": 0,
"customFields": {
"ismember": true,
"job_title": "RH",
"Num_membre": "17MQ198"
},
"approverUserId": "y9DDvS6G4UzxlxV%2fPuEWqA%3d%3d"
}
]Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. Ce paramètre doit être vide lorsque la méthode create est utilisée, mais obligatoire pour le mode édition. | |
| websiteId | Il s’agit de l’identifiant unique de l'utilisateur dans l'interface Lära LMS. | |
login |
| Identifiant de l'utilisateur. (Type String, >=4 et <= 250 caractère. Il doit s'agir d'un identifiant unique sur le serveur) |
firstName | Prénom de l'utilisateur. (Type String, <=50 caractères) | |
lastName | Nom de famille de l'utilisateur. (Type String, <=50 caractères) | |
language | La langue d’affichage par défaut est paramétrable selon la liste des constantes suivantes :
Si cette valeur est vide, l’API utilise la langue définie par défaut pour l’organisation dans laquelle l’utilisateur est créé. (Type Number) | |
Une validation du format est effectuée par le service web conformément au standard RFC2822 (<=100 caractères et le courriel doit être valide) | ||
companyName |
| Nom de compagnie de l'utilisateur. (Type String <=100 caractères) |
functionTitle |
| Fonction de l'utilisateur dans l’organisation. (Type String <= 100 caractères) |
phoneHome |
| Numéro de téléphone de l'utilisateur. (Type String <=40 caractères) |
phoneMobile |
| Numéro de téléphone mobile de l'utilisateur. (Type String <=40 caractères) |
phoneWork |
| Numéro de téléphone au travail de l'utilisateur. (Type String <=40 caractères |
phonePublic |
| Le phonePublic indique quel numéro de téléphone sera diffusé aux autres utilisateurs de Via selon la liste des constantes suivantes :
Lorsque ce paramètre est vide, la valeur 0 est appliquée. (Type Number) |
timeZone |
| Les utilisateurs de via sont invités à des rencontres communes sans toutefois être au même emplacement. Via donne donc la possibilité à chacun de gérer son fuseau horaire pour visualiser les rencontres selon son heure. La liste complète des constantes (0 à 77) est disponible en annexe du document. |
address |
| Adresse de l’utilisateur. (Type String <=100 caractères) |
address2 |
| Informations additionnelles sur l’adresse (app, boite à lettre, étage). (Type String, <=100 caractères) |
postalCode |
| Code postal de l’utilisateur. (Type String <=50 caractères) |
city |
| Ville de l’utilisateur. (Type String <=100 caractères) |
countryId |
| Pays de l’utilisateur – Type Number (Voir Annexe 3 : Pays et États/Provinces). |
stateId |
| Chiffre indiquant l'état de l'utilisateur - Type Number (Voir Annexe 3 : Pays et États/Provinces). |
portalID |
| Identifiant du portail par défaut de l’utilisateur (Type String) |
| inscriptionDate | La date de création du compte utilisateur. (Type String, YYYY-MM-DDTHH:MM:SSZ) | |
| expirationDate | La date d'expiration du compte utilisateur. (Type String, YYYY-MM-DDTHH:MM:SSZ) | |
enableNotifications | Indique si l’utilisateur pourra recevoir par courriel des notifications liées au fonctionnement du site et des campagnes de promotion. Par défaut à « true » (Type booléen) | |
| viaAccessMode | Indique le mode d'accès à Via Classique, si votre organisation utilise toujours ce logiciel.
| |
| status | (Lecture seule) Indique l'état d'activation du compte utilisateur.
(Type Number) | |
customFields |
| Champs sur mesure reliés à l’utilisateur. |
| approverUserId | Identifiant de l'approbateur de l'utilisateur (Type String) |
User/create
 | Permet de créer un nouvel utilisateur sur votre environnement. |
Requête
Exemple de contenu d'appel de requête de création d'un utilisateur :
{
"branchId":"EZIGUBLNy2lT%2bGEqj%2bRPHw%3d%3d",
"PermissionId" : "keRAK5MldUQPi4btSHrvNA%3d%3d",
"Password":"Jasmin1234",
"login": "JasminDuberger1234",
"firstName": "Jasmin",
"lastName": "Duberger",
"language": 1,
"email": "jduberger@gmail.com",
"companyName": "Duberger et Fils",
"functionTitle": "Président",
"hourlyWage": 0.00,
"phoneHome": "1 418 644-4444",
"phoneMobile": "1 418 808-0808",
"phoneWork": "1 800 733-1333",
"phonePublic": 0,
"timeZone": 10,
"address": "13, rue Duberger",
"address2": "Duberger-Les-Saules",
"postalCode": "H0H 0H0",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"portalId": "pMwiytSS1YRiELXfRQOwxw%3d%3d",
"expirationDate": "2025-12-31T00:00:00",
"enableNotifications": true,
"viaAccessMode": 0,
"status": 0,
"pictureURL":"https://laralms.sviesolutions.com/Covers/3717/cover_400.jpg",
"sendMailNotification":true,
"forcePasswordChange":true,
"customFields": {
"ismember": true,
"job_title": "Plombier",
"Num_membre": "DUBER109"
},
"approverUserId": "y9DDvS6G4UzxlxV%2fPuEWqA%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| branchId | Identifiant de la branche assignée où inscrire l’utilisateur. Si vide, l’utilisateur sera inscrit dans la branche racine. Pour modifier la branche d'un utilisateur, utilisez les appels « User/addtobranch » et « User/removefrombranch » (Type String) | |
| PermissionId | Identifiant du profil de droits à attribuer à l’utilisateur. Si vide, le profil de droits attribué par défaut sera « Utilisateur ». Les profils de droits sur des branches doivent être modifiés par les appels de type /branch (Type String) | |
| Password | Mot de passe de l'utilisateur. Si aucun mot de passe n'est fourni, un mot de passe aléatoire sera généré. (Type String, < = 250 caractères) | |
login |
| Identifiant de l'utilisateur. (Type String, >=4 et <= 250 caractère. Il doit s'agir d'un identifiant unique sur le serveur) |
firstName | X | Prénom de l'utilisateur. (Type String, <=50 caractères) |
lastName | X | Nom de famille de l'utilisateur. (Type String, <=50 caractères) |
language | X | La langue d’affichage par défaut est paramétrable selon la liste des constantes suivantes :
Si cette valeur est vide, l’API utilise la langue définie par défaut pour l’organisation dans laquelle l’utilisateur est créé. (Type Number) |
X | Une validation du format est effectuée par le service web conformément au standard RFC2822 (<=100 caractères et le courriel doit être valide) | |
companyName |
| Nom de compagnie de l'utilisateur. (Type String <=100 caractères) |
functionTitle |
| Fonction de l'utilisateur dans l’organisation. (Type String <= 100 caractères) |
| hourlyWage | Taux horaire de l'utilisateur. (Type Decimal <= 999, max 2 décimales) | |
phoneHome |
| Numéro de téléphone de l'utilisateur. (Type String <=40 caractères) |
phoneMobile |
| Numéro de téléphone mobile de l'utilisateur. (Type String <=40 caractères) |
phoneWork |
| Numéro de téléphone au travail de l'utilisateur. (Type String <=40 caractères |
phonePublic |
| Le phonePublic indique quel numéro de téléphone sera diffusé aux autres utilisateurs de Via selon la liste des constantes suivantes :
Lorsque ce paramètre est vide, la valeur 0 est appliquée. (Type Number) |
timeZone |
| Les utilisateurs de via sont invités à des rencontres communes sans toutefois être au même emplacement. Via donne donc la possibilité à chacun de gérer son fuseau horaire pour visualiser les rencontres selon son heure. La liste complète des constantes (0 à 77) est disponible en annexe du document. |
address |
| Adresse de l’utilisateur. (Type String <=100 caractères) |
address2 |
| Informations additionnelles sur l’adresse (app, boite à lettre, étage). (Type String, <=100 caractères) |
postalCode |
| Code postal de l’utilisateur. (Type String <=50 caractères) |
city |
| Ville de l’utilisateur. (Type String <=100 caractères) |
countryId |
| Pays de l’utilisateur. (Type Number, voir Annexe 3 : Pays et États/Provinces) |
stateId |
| Chiffre indiquant l'état de l'utilisateur. (Type Number, voir Annexe 3 : Pays et États/Provinces) |
portalID |
| Identifiant du portail par défaut de l’utilisateur. (Type String) |
| expirationDate | La date d'expiration du compte utilisateur. (Type String, YYYY-MM-DDTHH:MM:SSZ) | |
enableNotifications | Indique si l’utilisateur pourra recevoir par courriel des notifications liées au fonctionnement du site et des campagnes de promotion. Par défaut à « true » (Type booléen) | |
| viaAccessMode | Indique le mode d'accès à Via Classique, si votre organisation utilise toujours ce logiciel.
| |
| status | (Lecture seule) Indique l'état d'activation du compte utilisateur.
(Type Number) | |
| pictureUrl | Adresse URL de l'hébergement de la photo de profil de l'utilisateur. (type String) | |
| sendMailNotification | Indique si un courriel de confirmation de création de compte sera envoyé à l'utilisateur. | |
customFields |
| Champs sur mesure reliés à l’utilisateur. |
| approverUserId | Identifiant d'un utilisateur ayant le droit d'approbateur (Type String) |
Réponse
Exemple d'un contenu d'appel de réponse de création d'un utilisateur. Le système renvoie l'identifiant unique de l'utilisateur créé :
{
"id": "R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. Ce paramètre doit être vide lorsque la méthode create est utilisée, mais obligatoire pour le mode édition. |
User/edit
 | Permet de modifier un utilisateur sur votre environnement. |
Requête
Exemple de contenu d'appel de requête de modification d'un utilisateur. Les champs renseignés sont mis à jour, ceux qui sont absents ou identiques sont ignorés :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"branchId":"EZIGUBLNy2lT%2bGEqj%2bRPHw%3d%3d",
"PermissionId" : "keRAK5MldUQPi4btSHrvNA%3d%3d",
"Password":"Jasmin1234",
"login": "JasminDuberger1234",
"firstName": "Jasmin",
"lastName": "Duberger",
"language": 1,
"email": "jduberger@gmail.com",
"companyName": "Duberger et Fils",
"functionTitle": "Président",
"hourlyWage": 0.00,
"phoneHome": "1 418 644-4444",
"phoneMobile": "1 418 808-0808",
"phoneWork": "1 800 733-1333",
"phonePublic": 0,
"timeZone": 10,
"address": "13, rue Duberger",
"address2": "Duberger-Les-Saules",
"postalCode": "H0H 0H0",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"portalId": "pMwiytSS1YRiELXfRQOwxw%3d%3d",
"expirationDate": "2025-12-31T00:00:00",
"enableNotifications": true,
"viaAccessMode": 0,
"status": 0,
"pictureURL":"https://laralms.sviesolutions.com/3848/cover_400.jpg",
"expirationDate": "2025-01-01T00:00:00",
"customFields": {
"ismember": true,
"job_title": "Plombier",
"Num_membre": "DUBER109"
},
"approverUserId": "y9DDvS6G4UzxlxV%2fPuEWqA%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. Ce paramètre doit être vide lorsque la méthode create est utilisée, mais obligatoire pour le mode édition. |
| Password | Mot de passe de l'utilisateur. (Type String, < = 250 caractères) | |
login |
| Identifiant de l'utilisateur. (Type String, >=4 et <= 250 caractère. Il doit s'agir d'un identifiant unique sur le serveur) |
firstName | Prénom de l'utilisateur. (Type String, <=50 caractères) | |
lastName | Nom de famille de l'utilisateur. (Type String, <=50 caractères) | |
language | La langue d’affichage par défaut est paramétrable selon la liste des constantes suivantes :
Si cette valeur est vide, l’API utilise la langue définie par défaut pour l’organisation dans laquelle l’utilisateur est créé. (Type Number) | |
Une validation du format est effectuée par le service web conformément au standard RFC2822 (<=100 caractères et le courriel doit être valide) | ||
companyName |
| Nom de compagnie de l'utilisateur. (Type String <=100 caractères) |
functionTitle |
| Fonction de l'utilisateur dans l’organisation. (Type String <= 100 caractères) |
| hourlyWage | Taux horaire de l'utilisateur. (Type Decimal <= 999, max 2 décimales) | |
phoneHome |
| Numéro de téléphone de l'utilisateur. (Type String <=40 caractères) |
phoneMobile |
| Numéro de téléphone mobile de l'utilisateur. (Type String <=40 caractères) |
phoneWork |
| Numéro de téléphone au travail de l'utilisateur. (Type String <=40 caractères |
phonePublic |
| Le phonePublic indique quel numéro de téléphone sera diffusé aux autres utilisateurs de Via selon la liste des constantes suivantes :
Lorsque ce paramètre est vide, la valeur 0 est appliquée. (Type Number) |
timeZone |
| Les utilisateurs de via sont invités à des rencontres communes sans toutefois être au même emplacement. Via donne donc la possibilité à chacun de gérer son fuseau horaire pour visualiser les rencontres selon son heure. La liste complète des constantes (0 à 77) est disponible en annexe du document. |
address |
| Adresse de l’utilisateur. (Type String <=100 caractères) |
address2 |
| Informations additionnelles sur l’adresse (app, boite à lettre, étage). (Type String, <=100 caractères) |
postalCode |
| Code postal de l’utilisateur. (Type String <=50 caractères) |
city |
| Ville de l’utilisateur. (Type String <=100 caractères) |
countryId |
| Pays de l’utilisateur. (Type Number, voir Annexe 3 : Pays et États/Provinces) |
stateId |
| Chiffre indiquant l'état de l'utilisateur. (Type Number, voir Annexe 3 : Pays et États/Provinces) |
portalID |
| Identifiant du portail par défaut de l’utilisateur. (Type String) |
| viaAccessMode | Indique le mode d'accès à Via Classique, si votre organisation utilise toujours ce logiciel.
| |
| pictureUrl | Adresse URL de l'hébergement de la photo de profil de l'utilisateur. (type String) | |
| unableNotifications | Indique si l'utilisateur recevra par courriel les notifications liées au site et les campagnes de promotion. | |
| expirationDate | La date d'expiration du compte utilisateur. (Type String, YYYY-MM-DDTHH:MM:SSZ) | |
| status | (Lecture seule) Indique l'état d'activation du compte utilisateur.
(Type Number) | |
customFields |
| Champs sur mesure reliés à l’utilisateur. |
| approverUserId | Identifiant d'un utilisateur ayant le droit d'approbateur (Type String) |
Réponse
Exemple d'un contenu d'appel de réponse de modification d'un utilisateur. Le système renvoie l'identifiant unique de l'utilisateur modifié :
{
"id": "R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. Ce paramètre doit être vide lorsque la méthode create est utilisée, mais obligatoire pour le mode édition. |
User/delete
 | Permet de supprimer un utilisateur de votre environnement. |
Requête
Exemple de contenu d'appel de requête de suppression d'un utilisateur.
ATTENTION : cette action est irréversible!
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. (Type String) |
Réponse
Exemple d'un contenu d'appel de réponse de suppression d'un utilisateur. Le système renvoie l'identifiant unique de l'utilisateur supprimé :
{
"id": "R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. |
User/deactivate
 | Permet désactiver un utilisateur de votre environnement. Le compte et les données seront conservés, mais l'utilisateur n'aura plus accès à l'environnement. |
Requête
Exemple de contenu d'appel de requête de désactivation d'un utilisateur :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"expirationDate" : "2029-12-31T00:00:00.000"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. (Type String) |
| expirationDate | Il s'agit de la date à laquelle l'utilisateur sera désativé. (Type String, YYYY-MM-DDTHH:MM:SSZ) |
Réponse
Exemple d'un contenu d'appel de réponse de désactivation d'un utilisateur. Le système renvoie l'identifiant unique de l'utilisateur désactivé :
{
"id": "R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. |
User/activate
 | Permet de réactiver un utilisateur de votre environnement. L'utilisateur aura de nouveau accès à l'environnement. |
Requête
Exemple de contenu d'appel de requête de réactivation d'un utilisateur :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. (Type String) |
Réponse
Exemple d'un contenu d'appel de réponse de réactivation d'un utilisateur. Le système renvoie l'identifiant unique de l'utilisateur réactivé :
{
"id": "R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. |
User/getbranchlist
 | Permet d'obtenir la liste des branches d'un utilisateur de votre environnement, ainsi que son profil de droit sur chacune de ces branches. |
Requête
Exemple de contenu d'appel de requête des branches et des profils de droits d'un utilisateur :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. (Type String) |
Réponse
Exemple d'un contenu d'appel de réponse des branches et des profils de droits d'un utilisateur. Le système renvoie la liste des branches et des profils de droits qui y sont respectivement associés :
[
{
"id": "R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"branchId": "HAwToYn4CzS208NIAwBVEQ%3d%3d",
"permissionId": "pJlqyk0x52S%2f5ZZGxAITFw%3d%3d"
},
{
"id": "R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"branchId": "61%2bwMxJmDOvWFQrEjS4p4g%3d%3d",
"permissionId": "pJlqyk0x52S%2f5ZZGxAITFw%3d%3d"
},
{
"id": "R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"branchId": "EZIGUBLNy2lT%2bGEqj%2bRPHw%3d%3d",
"permissionId": "keRAK5MldUQPi4btSHrvNA%3d%3d"
}
]
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. | |
| branchId | Il s'agit de l'identifiant unique de la branche dans l'API. | |
| permissionId | Il s'agit de l'identifiant unique du profil de droit dans l'API. |
User/addtobranch
 | Permet d'ajouter un utilisateur de votre environnement à une branche. |
Requête
Exemple de contenu d'appel de requête d'association d'un utilisateur à une branche :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"branchId": "PDL4GdCE%2fxiBbqyuKV9E3g%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. (Type String) |
| branchId | X | Il s'agit de l'identifiant unique de la branche dans l'API. (Type String) |
Réponse
Exemple d'un contenu d'appel de réponse d'association d'un utilisateur à une branche. Le système renvoie l'identifiant de l'utilisateur et l'identifiant de la branche :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"branchId": "PDL4GdCE%2fxiBbqyuKV9E3g%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. | |
| branchId | Il s'agit de l'identifiant unique de la branche dans l'API. |
User/removefrombranch
 | Permet de retirer un utilisateur d'une branche. |
Requête
Exemple de contenu d'appel de requête de désassociation d'un utilisateur d'une branche :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"branchId": "PDL4GdCE%2fxiBbqyuKV9E3g%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. (Type String) |
| branchId | X | Il s'agit de l'identifiant unique de la branche dans l'API. (Type String) |
Réponse
Exemple d'un contenu d'appel de réponse de désassociation d'un utilisateur d'une branche . Le système renvoie l'identifiant de l'utilisateur et l'identifiant de la branche :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d",
"branchId": "PDL4GdCE%2fxiBbqyuKV9E3g%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. | |
| branchId | Il s'agit de l'identifiant unique de la branche dans l'API. |
User/search
 | Permet rechercher un utilisateur à l'aide de champs de recherche. |
Requête
Exemple de contenu d'appel de requête de recherche d'un utilisateur.
ATTENTION : les valeurs de recherches sont cumulées. Par exemple, si l’on cherche un login et un courriel, il retournera uniquement les enregistrements correspondants aux deux critères (« AND »).
{
"login": "JasminDuberger1234",
"email": "jduberger@gmail.com",
“includeInactive” : false,
"customFields": {
"ismember": true,
"job_title": "Plombier",
"Num_membre": "DUBER109"
}
}Description des champs
Nom | Obligatoire | Commentaires/description |
login |
| Champ de recherche pour le nom d’utilisateur. (Type String) Ce champ est requis si les autres champs sont vides. |
| Champ de recherche pour le courriel de l’utilisateur. (Type String) Ce champ est requis si les autres champs sont vides. | |
includeInactive |
| Champ de recherche pour définir si on veut inclure les utilisateurs inactif. (Type Bool |
customFields |
| Champ de recherche pour les champs personnalisés. Ce champ est requis si les autres champs sont vides. |
Réponse
Exemple d'un contenu d'appel de réponse de recherche d'un utilisateur :
{
"id": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
"websiteId": "ZRtLSlsH5%2bKhhAxU0I4Lgg%3d%3d",
"login": "Jhemington",
"firstName": "Jessica",
"lastName": "Hemington",
"language": 1,
"email": "jhemington@sviesolutions.com",
"companyName": "SVIeSolutions",
"functionTitle": "Agentes des ressources humaines",
"hourlyWage": 0.00,
"phoneHome": "418 948-4848",
"phoneMobile": "418 948-4848",
"phoneWork": "418 948-4848",
"phonePublic": 0,
"timeZone": 10,
"address": "234, du Faubourg",
"address2": "bur. 404",
"postalCode": "1H1 H1H",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"portalId": "pVwwetET1HGiEZIfRQOoxo%3d%3d",
"inscriptionDate": "2021-10-08T09:21:37.657",
"expirationDate": "0001-01-01T00:00:00",
"enableNotifications": true,
"viaAccessMode": 0,
"status": 0,
"customFields": {
"ismember": true,
"job_title": "RH",
"Num_membre": "17MQ198"
}
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. Ce paramètre doit être vide lorsque la méthode create est utilisée, mais obligatoire pour le mode édition. | |
| websiteId | Il s’agit de l’identifiant unique de l'utilisateur dans l'interface Lära LMS. | |
login |
| Identifiant de l'utilisateur. (Type String, >=4 et <= 250 caractère. Il doit s'agir d'un identifiant unique sur le serveur) |
firstName | Prénom de l'utilisateur. (Type String, <=50 caractères) | |
lastName | Nom de famille de l'utilisateur. (Type String, <=50 caractères) | |
language | La langue d’affichage par défaut est paramétrable selon la liste des constantes suivantes :
Si cette valeur est vide, l’API utilise la langue définie par défaut pour l’organisation dans laquelle l’utilisateur est créé. (Type Number) | |
Une validation du format est effectuée par le service web conformément au standard RFC2822 (<=100 caractères et le courriel doit être valide) | ||
companyName |
| Nom de compagnie de l'utilisateur. (Type String <=100 caractères) |
functionTitle |
| Fonction de l'utilisateur dans l’organisation. (Type String <= 100 caractères) |
| hourlyWage | Taux horaire de l'utilisateur. (Type Decimal <= 999, max 2 décimales) | |
phoneHome |
| Numéro de téléphone de l'utilisateur. (Type String <=40 caractères) |
phoneMobile |
| Numéro de téléphone mobile de l'utilisateur. (Type String <=40 caractères) |
phoneWork |
| Numéro de téléphone au travail de l'utilisateur. (Type String <=40 caractères |
phonePublic |
| Le phonePublic indique quel numéro de téléphone sera diffusé aux autres utilisateurs de Via selon la liste des constantes suivantes :
Lorsque ce paramètre est vide, la valeur 0 est appliquée. (Type Number) |
timeZone |
| Les utilisateurs de via sont invités à des rencontres communes sans toutefois être au même emplacement. Via donne donc la possibilité à chacun de gérer son fuseau horaire pour visualiser les rencontres selon son heure. La liste complète des constantes (0 à 77) est disponible en annexe du document. |
address |
| Adresse de l’utilisateur. (Type String <=100 caractères) |
address2 |
| Informations additionnelles sur l’adresse (app, boite à lettre, étage). (Type String, <=100 caractères) |
postalCode |
| Code postal de l’utilisateur. (Type String <=50 caractères) |
city |
| Ville de l’utilisateur. (Type String <=100 caractères) |
countryId |
| Pays de l’utilisateur – Type Number (Voir Annexe 3 : Pays et États/Provinces). |
stateId |
| Chiffre indiquant l'état de l'utilisateur - Type Number (Voir Annexe 3 : Pays et États/Provinces). |
portalID |
| Identifiant du portail par défaut de l’utilisateur (Type String) |
| inscriptionDate | La date de création du compte utilisateur. | |
| expirationDate | La date d'expiration du compte utilisateur. | |
enableNotifications | Indique si l’utilisateur pourra recevoir par courriel des notifications liées au fonctionnement du site et des campagnes de promotion. Par défaut à « true » (Type booléen) | |
| viaAccessMode | Indique le mode d'accès à Via Classique, si votre organisation utilise toujours ce logiciel.
| |
| status | (Lecture seule) Indique l'état d'activation du compte utilisateur.
(Type Number) | |
customFields |
| Champs sur mesure reliés à l’utilisateur. |
User/getpermissionlist
 | Permet de consulter la liste des profils de droits de l'environnement. |
Requête
Exemple de contenu d'appel de requête des profils de droits de l'environnement * :
{}* Aucun champ n'est requis.
Réponse
Exemple d'un contenu d'appel de réponse des profils de droits de l'environnement :
[
{
"id": "tYGlIky4aK%2f7Z1joMMQL0g%3d%3d",
"name": {
"texts": [
{
"text": "Administrateur Système",
"languageId": 1
},
{
"languageId": 2
},
{
"languageId": 3
},
{
"languageId": 4
}
],
"ErrorID": 0
},
"description": {
"texts": [
{
"text": "Droits d'administrateur par défaut",
"languageId": 1
},
{
"languageId": 2
},
{
"languageId": 3
},
{
"languageId": 4
}
],
"ErrorID": 0
},
"isAdminPermission": true,
"isUserPermission": false
},
{
"id": "pJlqyk0x52S%2f5ZZGxAITFw%3d%3d",
"name": {
"texts": [
{
"text": "Utilisateur",
"languageId": 1
},
{
"text": "User",
"languageId": 2
},
{
"text": "Usuario",
"languageId": 3
},
{
"languageId": 4
}
],
"ErrorID": 0
},
"description": {
"texts": [
{
"text": "Droits d'utilisateur par défaut",
"languageId": 1
},
{
"text": "User by default",
"languageId": 2
},
{
"text": "Usuario por defecto",
"languageId": 3
},
{
"languageId": 4
}
],
"ErrorID": 0
},
"isAdminPermission": false,
"isUserPermission": true
}
]
Description des champs
Nom | Obligatoire | Commentaires/description |
| id | Il s'agit de l'identifiant unique du profil de droits dans l'API. | |
| Name | Nom administratif du profil de droits.
| |
| ErrorID | ||
| description | Description administrative du profil de droits.
| |
isAdminPermission |
| Indique s’il s’agit de la permission administrateur par défaut. Elle ne peut être modifiée ou supprimée, ni attribuée par défaut à un utilisateur sans le spécifier. (Type Booléen) |
isUserPermission |
| Indique s’il s’agit de la permission utilisateur par défaut. Cette propriété ne peut être affectée à une autre permission. Cependant, il est possible de modifier les capacités de cette permission dans l’interface administrateur. (Type Booléen) |
User/getsso
 | Permet d'obtenir le jeton d'authentification d'un utilisateur. |
Requête
Exemple de contenu d'appel de requête de jeton d'authentification d'un utilisateur :
{
"id": "MS6Hj2EsyN8wvPrcAWAZMA%3d%3d",
"portalId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d",
"refId": "WSmUkyUmFT%2bEGm2dllhihg%3d%3d",
"subRefId": "WSmUkyUmFT%2bEGm2dllhihg%3d%3d",
"redirectType": 4,
"urlRedirect": null,
"forceAccess": 1
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Il s’agit de l’identifiant unique de l’utilisateur dans l'API. (Type String) |
portalId |
| Portail par défaut pour la personnalisation et le sign out. Si la valeur est vide, le portail par défaut est utilisé. (Type String) |
refId |
| ID de référence en fonction du redirectType, nécessaire pour les modes 3, 4 et 8. (Type String) |
subRefId |
| ID de référence en fonction du redirectType, nécessaire pour le mode 8, ID d’enregistrement. (Type String) Il est important de récupérer le returnURL placé sur l’url du bouton qui envoie l’utilisateur vers le SSO afin que vous puissiez le retourner connecté dans le bon contexte. Vous devez réencoder en format URL ce paramètre afin qu’il puisse être valide. |
redirectType | RedirectTypes
Noter que la valeur urlRedirect n’est pas obligatoire si la valeur redirectType est fournie. | |
urlRedirect | Il s’agit de l’url de redirection une fois l’utilisateur authentifié. Noter que la valeur redirectType n’est pas obligatoire si la valeur urlRedirect est fournie. | |
forceAccess |
| Paramètre optionnel qui est prit en compte uniquement pour le redirectType 8 (Application Via HTML5). |
Réponse
Exemple d'un contenu d'appel de réponse requête de jeton d'authentification d'un utilisateur :
{
"urlSSO":"https://portailpreprod.sviesolutions.com/Web/SignInSSO?token=8c629721c8dc40c399fa454a289cc883"
}Description des champs
Nom | Obligatoire | Commentaires/description |
urlSSO | URL de redirection de l'utilisateur à la connexion. |
User/updatepicture
| Permet de modifier la photo de profil d'un utilisateur. |
Requête
Exemple de contenu d'appel de requête de modification de la photo de profil d'un utilisateur :
ENTRER CODE
Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. (Type String) |
| branchId | X | Il s'agit de l'identifiant unique de la branche dans l'API. (Type String) |
Réponse
Exemple d'un contenu d'appel de modification de la photo de profil d'un utilisateur. Le système retourne l'identifiant de l'utilisateur :
{
"id":"R2gbgKeLz4xUqsTSfcwsNQ%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
id | Il s’agit de l’identifiant unique de l'utilisateur dans l'API. |
Requête de modification de la photo de profil d'un utilisateur
ATTENTION : La méthode nécessite le format « Content-Type: multipart/form-data », où la première node doit s’appeler « data » et contenir l’identifiant de l’utilisateur. La photo doit être dans une node « file » sous format bytes et doit comporter un nom (sans importance, mais c’est ce qui désigne que l’on reçoit un fichier).
{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}Exemple
form.Add(New ByteArrayContent(request, 0, request.Length), "data")
form.Add(New ByteArrayContent(imageByteData, 0, mStream.Length), "file", "picture")
Résultat
POST /toto HTTP/1.1
Content-Length: 68137
Content-Type: multipart/form-data; boundary=xxBOUNDARYxx
Content-Disposition: form-data; name="data"
xxBOUNDARYxx
(Le JSON contenant l’identifiant)
xxBOUNDARYxx
Content-Disposition: form-data; name="file"; filename="picture"
Content-Type: image/jpeg
(contenu du fichier envoyé)
xxBOUNDARYxx
ATTENTION : L’image sera rognée pour respecter un format 320x240. Une photo en mode portrait sera redimensionnée proportionnellement pour prendre toute la largeur, alors qu’une photo en mode paysage sera redimensionnée pour prendre toute la hauteur (voir image ci-dessous). La transparence sera ignorée.
Description des codes d’erreurs d’utilisateur
Numéro | Message | Commentaires/description |
100 | Required id | Vous devez fournir un identifiant pour l’utilisateur. |
101 | Invalid id | L’identifiant fourni pour l’utilisateur est invalide. |
102 | Required branchId | Vous devez fournir un identifiant pour la branche. |
103 | Invalid branchId | L’identifiant fourni pour la branche est invalide. |
104 | Invalid password length | Le mot de passe doit contenir de 3 à 250 caractères inclusivement. |
105 | Invalid password character | Le mot de passe contient un ou plusieurs caractères interdits. |
106 | Invalid login length | Le nom d’utilisateur doit contenir de 3 à 250 caractères inclusivement. |
107 | Invaid login character | Le nom d’utilisateur contient un ou plusieurs caractères interdits. |
108 | Login already exists | Le nom d’utilisateur que vous souhaitez utiliser existe déjà. |
109 | Invalid first name length | Le prénom doit contenir de 1 à 50 caractères inclusivement. |
110 | Required first name | Vous devez fournir un prénom. |
111 | Invalid last name length | Le nom de famille doit contenir de 1 à 50 caractères inclusivement. |
112 | Required last name | Vous devez fournir le nom de famille. |
113 | Invalid email length | Le courriel doit contenir un maximum de 100 caractères. |
114 | Invalid email format | Le courriel n’est pas dans un format valide. Exemple : adresse@domaine.com |
115 | Required email | Vous devez fournir un courriel. |
116 | Invalid companyName length | Le nom de l’organisation doit contenir un maximum de 100 caractères inclusivement. |
117 | Invalid functionTitle length | La fonction dans l'organisation doit contenir un maximum de 100 caractères inclusivement. |
118 | Invalid phoneHome length | Le téléphone domicile doit contenir un maximum de 40 caractères inclusivement. |
119 | Invalid phoneMobile length | Le téléphone cellulaire doit contenir un maximum de 40 caractères inclusivement. |
120 | Invalid phoneWork length | Le téléphone bureau doit contenir un maximum de 40 caractères inclusivement. |
121 | Invalid phonePublic | Le téléphone public fourni doit être de 0 à 3 inclusivement. |
122 | Invalid language | Le langage fourni doit être de 0 à 4 inclusivement. |
123 | Required language | Le langage est requis. |
124 | Invalid timezone | Le fuseau horaire doit être de 0 à 77 inclusivement à l’exception de 52. |
125 | Required timezone | Le fuseau horaire est requis. |
126 | Invalid address length | L’adresse doit contenir un maximum de 100 caractères inclusivement. |
127 | Invalid city length | Le nom de la ville doit contenir un maximum de 100 caractères inclusivement. |
128 | Invalid postalCode length | Le code postal doit contenir un maximum de 50 caractères inclusivement. |
129 | Invalid address2 length | L’adresse 2 doit contenir un maximum de 100 caractères inclusivement. |
130 | Search field required | Vous devez fournir au moins un des trois champs suivant lors de la recherche. Login, Email ou customFields. |
131 | Invalid data | Une erreur s’est produite lors de la création de l’utilisateur. Contacter le support si vous avez cette erreur. |
132 | Invalid redirectType | Le type de redirection doit être de 1 à 5 inclusivement. |
133 | Invalid portalId | L’identifiant fourni pour le portail est invalide. |
134 | Invalid refId | L’identifiant de référence en fonction du redirectType est invalide. Il est seulement nécessaire pour les modes 3, 4, 8. |
135 | Invalid urlRedirect | L’url de redirection est invalide. Utilisez le modèle suivant : https://domaine.com |
141 | Invalid subRefId | L’identifiant de référence en fonction du redirectType est invalide. Il est seulement nécessaire pour le mode 8. |
| 142 | Invalid approverUserId | L’identifiant fourni pour l'utilisateur approbateur est invalide |
| 143 | ApproverUserId does not have right | L'identifiant de l'utilisateur approbateur n'a pas le droit de voir les approbations |
| 144 | Invalid hourlyWage Value | La valeur doit avoir un maximum de 2 décimales et être entre 0 et 999 inclusivement |