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",
  "websiteId": "K%2fk8ggesQg8YFqtG6JUuzA%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",
  "filterEditDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterIndex" : 2
}

Les paramètre de filtre par date filterDate et filterEditDate sont optionnels et correspondent à la date de création et la date de modification de l’élément respectivement. La méthode retourne la liste des objets qui ont été créés après la date passée comme filtre. Ils peuvent être spécifiés seuls ou les deux dans la même requête. Type: String (YYYY-MM-DDTHH:MM:SSZ)

Note: Au moment de la création, la date de modification sera aussi mise à jour au même moment.

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"
}

{
  "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",
    "websiteId": "hVMfOwm8UIeOh2Y9fygdhA%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"    
    }
  }
]

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
  }]
}

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"
}

form.Add(New ByteArrayContent(request, 0, request.Length), "data")
form.Add(New ByteArrayContent(imageByteData, 0, mStream.Length), "file", "picture")

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