Utilisateurs (Lära et Via HTML)

Table des matières

UTILISATEURS
    User : user/get
    User : user/getlist
    User : user/create
    User : user/edit
    User : user/delete
    User : user/deactivate
    User : user/activate
    User : user/getbranchlist
    User : user/addtobranch
    User : user/removefrombranch
    User : user/search
    User : user/getpermissionlist
    Description des codes d’erreurs d’utilisateur
    User : user/updatepicture

UTILISATEURS

User : user/get

https://www.domaine.com/lmsapi/user/get

user/get (request) - Requête d'un utilisateur par identifiant

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

user/get (response) - Retourne un objet représentant un utilisateur

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d",
"password": "7Xm2k75vgw%2faO0GS44QhVQ%3d%3d",
"login": "userlogin",
"firstName": "Name",
"lastName": "LastName",
"language": 1,
"email": "email@email.com",
"companyName": "",
"functionTitle": "",
"phoneHome": "(418) 666-66666",
"phoneMobile": "",
"phoneWork": "",
"phonePublic": 2,
"timeZone": 10,
"address": "690 rue St-Joseph Est",
"address2": "",
"postalCode": "G1K3B9",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"enableNotifications": 1,
"portalId": "Ogx%2bs5YmxHoC9%2bbKFYtzMQ%3d%3d",
"inscriptionDate": "2005-11-01T14:36:36.263",
"expirationDate": "0001-01-01T00:00:00",
"status", 0,
"customFields": {
"Champ1": "Snow",
"Test": ""
}
}

User : user/getlist

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

/user/getlist (request)  – Requête une liste d’objet représentant les utilisateurs

{
"filterDate": "YYYY-MM-DDTHH:MM:SSZ"
"filterIndex" : 2
}

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)

Le paramètre de filtre par index est optionnel et correspond à une pagination de 200 utilisateurs. La méthode retourne la liste de 200 objets selon l’index passé comme filtre.

Un filtre par index de 1 retourne les utilisateurs 1 à 200 et un filtre par index de 2 retourne les utilisateurs de 201 à 400.

/user/getlist (response) - Retourne une liste d’objets représentant chacun des utilisateurs. La liste comprend les 100 premiers utilisateurs trouvés.

User : user/create

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

/user/create (request) - Requête de création d'un utilisateur
Description des champs

Nom

Obligatoire

Commentaires/description

id

 

Il s’agit de l’identifiant unique. Ce paramètre doit être vide lorsque la méthode create est utilisée, mais obligatoire pour le mode édition.

branchId

 

Identifiant de la branche assignée où inscrire l’utilisateur. Si vide, l’utilisateur sera inscrit dans la branche racine. Ne peut être modifié avec la fonction edit (Type string)

permissionId

 

Identifiant de la permission à attribuer à l’utilisateur. Si vide, la permission attribuée par défaut sera celle d’utilisateur. Ne peut être modifié avec la fonction edit (Type string)

password

 

Mot de passe de l'utilisateur (<= 250 caractères Type String)

login

 

Login de l'utilisateur. - Type String <= 250 caractère et le login ne doit pas exister

firstName

Prénom de l'utilisateur - Type String <=50 caractères

lastName

Nom de famille de l'utilisateur - Type Stri <=50 caractères

language

La langue d’affichage par défaut dans Via pour l’utilisateur est paramétrable selon la liste des constantes suivantes :  

  • 1 = Français (Canada) 
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol

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

email

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 

Champ texte informatif qui peut s’avérer pratique lorsqu’un conférencier invité vient donner une conférence sur votre site.

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 : 

  • 0 = aucun numéro de téléphone ne sera rendu public
  • 1 = le numéro de cellulaire sera rendu public
  • 2 = le numéro à la maison sera rendu public
  • 3 = le numéro au bureau sera rendu public

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.
Si cette valeur est vide, l’API utilise le fuseau horaire défini par défaut pour l’organisation dans laquelle l’utilisateur est créé. 

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

customFields

 

Champs sur mesure reliés à l’utilisateur

pictureURL

 

URL vers la photo de profil. (L’image sera importée sur le serveur) Type String

sendMailNotification

 

Indique si un courriel de création de compte est envoyé à l’utilisateur concerné ou pas. Par défaut à « false » (Type booléen)

enableNotifications

 

Indique si l’utilisateur pourra recevoir par courriel des notifications  liées au fonctionnement du site.
Par défaut à « true » (Type booléen)

forcePasswordChange

 

Indique si le mot de passe de l’utilisateur doit être changé à la première connexion ou pas. Par défaut à « false » (Type booléen)

status

 

(Lecture seule)

Indique si le statut de l’utilisateur.

  • 0 = Actif
  • 1 = Inactif

 (Type number)

/user/create (response) - Retourne l'identifiant de l'utilisateur créé.

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

User : user/edit

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

/user/edit (request) - Requête de modification d'un utilisateur
ATTENTION : La méthode nécessite uniquement la valeur ‘’id’’ comme obligatoire. Les champs passés sont mis à jour, les champs qui ne sont pas renseignés ne sont simplement pas mis à jour.

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/user/edit (response) - Retourne l'identifiant de l'utilisateur modifié

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

User : user/delete

https://www.domaine.com/lmsapi/user/delete

/user/delete (request) - Supprime un utilisateur

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/user/delete (response) - Retourne l'identifiant de l'utilisateur supprimé

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

User : user/deactivate

https://www.domaine.com/lmsapi/user/deactivate

/user/deactivate (request) - Désactive un utilisateur

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d",
"expirationDate" : "2022-11-01T00:00:00.000"
}

/user/deactivate (response) - Retourne l'identifiant de l'utilisateur désactivé

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Le champ expirationDate est optionnel, si elle est passé l'utilisateur sera désactivé à cette date.

User : user/activate

https://www.domaine.com/lmsapi/user/activate

/user/activate (request) - Active un utilisateur

{
  "id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/user/activate (response) - Retourne l'identifiant de l'utilisateur activé

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

User : user/getbranchlist

https://www.domaine.com/lmsapi/catalog/getbranchlist

/user/getbranchlist (request) - Requête de la liste des branches d’un utilisateur

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

/user/getbranchlist (response) - Retourne une liste d'objets d’identifiant d’utilisateur, de branche et de permission

[{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"branchId": "edFrrvGGeT9KI0783Dznkw%3d%3d"
"permissionId": "edFrrvGGeT9KI0783Dznkw%3d%3d"
}, {
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
"permissionId": "edFrrvGGeT9KI0783Dznkw%3d%3d"
}
]

User : user/addtobranch

https://www.domaine.com/lmsapi/user/addtobranch

/user/addtobranch (request) – Ajoute l’utilisateur à une branche

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
"branchId": "PDL4GdCE%2fxiBbqyuKV9E3g%3d%3d"
}

/user/addtobranch (response) - Retourne l'identifiant de l'utilisateur ajouté à la branche et l'identifiant de la branche

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
"branchId": "PDL4GdCE%2fxiBbqyuKV9E3g%3d%3d"
}

User : user/removefrombranch

https://www.domaine.com/lmsapi/user/removefrombranch

/user/removefrombranch (request) – Retire l’utilisateur d’une branche

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
"branchId": "PDL4GdCE%2fxiBbqyuKV9E3g%3d%3d"
}

/user/removefrombranch (response) - Retourne l'identifiant de l'utilisateur retiré de la branche et l'identifiant de la branche

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
"branchId": "PDL4GdCE%2fxiBbqyuKV9E3g%3d%3d"
}

User : user/search

https://www.domaine.com/lmsapi/user/search

/user/search (request) – Recherche un utilisateur selon les valeurs de recherches dans l’appel

{
"login": "test",
"email": "email@email.com",
“includeInactive” : false,
"customFields": {
"UniqueID": "34234234235",
}
}

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 »).

/user/search (response) – Retourne un objet représentant un utilisateur

https://www.domaine.com/lmsapi/user/search

[
{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d",
"password": "7Xm2k75vgw%2faO0GS44QhVQ%3d%3d",
"login": "test",
"firstName": "Name",
"lastName": "LastName",
"language": 1,
"email": "email@email.com",
"companyName": “”,
"functionTitle": “”,
"phoneHome": "(418) 666-66666",
"phoneMobile": “”,
"phoneWork": “”,
"phonePublic": 2,
"timeZone": 10,
"address": "690 rue St-Joseph Est",
"address2": "",
"postalCode": "G1K3B9",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"portalId", "Ogx%2bs5YmxHoC9%2bbKFYtzMQ%3d%3d",
"status", 0,
"customFields": {
"UniqueID": "34234234235"
}
}
]

Description des champs

Nom

Obligatoire

Commentaires/description

login

 

Champ de recherche pour le nom d’utilisateur

Ce champ est requis si les autres champs sont vides.

email

 

Champ de recherche pour le courriel de l’utilisateur

Ce champ est requis si les autres champs sont vides.

includeInactive

 

Champ de recherche pour définir si on veut inclure les utilisateurs inactif.

customFields

 

Champ de recherche pour les champs personnalisés.

Ce champ est requis si les autres champs sont vides.

User : user/getpermissionlist

https://www.domaine.com/lmsapi/user/getpermissionlist

/user/getpermissionlist (request) - Requête la liste des permissions

ATTENTION : la méthode ne requière aucun paramètre.

/user/getpermissionlist (response) - Retourne la liste des permissions

{
[{
"id":"vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
"name":{
"texts":[{
"text":"Administrateur Système",
"languageId":1
}]
},
"description":{
"texts":[{
"text":"Profil d'administrateur par défaut",
"languageId":1
}]
},
"isDefaultAdminPermission":true,
"isDefaultUserPermission":false
}, {
"id":"BzEm1iKI2qP86aUK38RlVg%3d%3d",
"name":{
"texts":[{
"text":"Utilisateur",
"languageId":1
]}
}
"description":{
"texts":[{
"text":"Profil d'utilisateur par défaut",
"languageId":1
]}
},
"isDefaultAdminPermission":false,
"isDefaultUserPermission":true
}]
}

Description des champs

Nom

Obligatoire

Commentaires/description

isDefaultAdminPermission

 

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)

isDefaultUserPermission

 

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)

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.

User : user/updatepicture

https://www.domaine.com/lmsapi/user/updatepicture

/user/updatepicture (request) - 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.

/user/updatepicture (response) - Retourne l'identifiant de l'utilisateur modifié

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Nous sommes désolés de ne pas avoir pu répondre à votre question. Aidez-nous à améliorer cet article grâce à vos commentaires.