Portails (Lära et Via HTML)

Miro Lagueux

Modifié le : Mer, 8 Nov., 2023 à 10:42 H

Table des matières

PORTAILS
Portails : portal /get
Portails : portal /getlist
Portails : portal /create
Portails : portal/edit
Description des codes d’erreurs de portail

PORTAILS

Portails : portal /get

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

/portal/get (request) - Requête d’un portail par identifiant

}  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d" (Obligatoire)}

/portal/get (response) – Retourne le détail d’un portail

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d", 
  "title": {
    "texts": [{
        "text": "MonPortail",
        "languageId": 1
      }
    ]
  },
  "subTitle": {
    "texts": [{
        "text": "Mon sous-titre",
        "languageId": 1
      }
    ]
  },

  "description": {
    "texts": [{
        "text": "Ma description",
        "languageId": 1
      }
    ]
  },


  "newAccountButtonLabel": {
    "texts": [{
        "text": "Inscrivez-vous!",
        "languageId": 1
      }
    ]
  },


  "newAccountDescription": {
    "texts": [{
        "text": "Inscrivez-vous dès maintenant en remplissant le formulaire suivant : ",
        "languageId": 1
      }
    ]
  },


  "branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "coverID": 3
  "allowNewAccount": false,
  "creationDate": "2018-01-01",
  "url": "siteUrl/monUrl",
  "name": "nom de portail",
  "dns": "mondns"
  "language": 1,
  "newUserLanguage": 1,
  "hasCustomLogo": false,
  "lastModificationDate": "2018-01-02",
  "defaultBranchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "isDefaultPortal": false,
  "displayType": 1,
  "createByUserID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "keywords": "mot1,mot2,mot3",
  "seoDescription": "une description",
  "googleAnalyticsKey": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "providerFilter": false, 
  "languageFilter": false, 
  "isUsingCustomSupportInfo": true,
  "newAccountUrl": "",
  "isEmailValidatedByCode": true
}

Description des champs

ATTENTION : En modification, les méthodes nécessitent 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.

Nom	Obligatoire	Commentaires/description
id		Identifiant unique du portail (Type string) Ce paramètre doit être vide lorsque la méthode en mode création est utilisée, mais obligatoire pour appeler en mode édition.
title text languageId		Text : Titre du portail tel que vu par les utilisateurs dans le système. (Type string) languageId : Le nom peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
subtitle text languageId		Text : Sous-titre du portail tel que vu par les utilisateurs dans le système. (Type string) languageId : Le nom peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
description text languageId		Text : Description du portail tel que vu par les utilisateurs dans le système. (Type string) languageId : Le nom peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
newAccountButtonLabel text languageId		Text : Libellé sur le bouton de création de compte. (Type string) languageId : Le nom peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
newAccountDescription text languageId		Text : Libellé affiché avant le formulaire de création de compte. (Type string) languageId : Le nom peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
name		Nom du portail tel que vu par l’administration. (Type string) Ce paramètre est obligatoire en mode création.
coverID		Identifiant pour le visuel du portail. (Type number)
allowNewAccount		Autorisation des nouveaux utilisateurs à se créer un compte (Type Boolean)
defaultBranchID		Branche par défaut aux nouveaux comptes créés. (Type string) allowNewAccount doit être à mis à true pour appliquer ce champs.
branchID		Branche du portail. (Type string) Ce paramètre est obligatoire en mode création.
creationDate		Date de création du portail Ne peut être modifié. Disponible sur get et getlist.
url		Url du portail. (Type string) L’Url du site du client sera concaténé à la sauvegarde. Ce paramètre est obligatoire en mode création.
dns		Dns du portail. (Type string) Passer vide pour enlever.
language		Langue d’affichage du portail 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
newUserLanguage		Langue par défaut des nouveaux utilisateurs 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
hasCustomLogo		Indique si un logo personnalisé a été attribué au portail.
lastModificationDate		Date de la dernière modification du portail Ne peut être modifié. Disponible sur get et getlist.
isDefaultPortal		Indique si le portail est celui par défaut. (Type boolean) Ne peut être modifié. Disponible sur get et getlist.
displayType		Type d’affichage dans les catalogues. 1 = Tuile 2 = Calendrier 3 = Liste (Type Number)
createdByUserID		Identifiant de l’utilisateur qui a créé le portail (Type string) Ne peut être modifié. Disponible sur get et getlist. -1 indique une création par l’API.
keywords		Mot-clés pour le référencement (Type string) Les mots doivent être séparés par des virgules. Passer vide pour enlever.
seoDescription		Description pour le référencement (Type string) Passer vide pour enlever.
googleAnalyticsKey		Clé pour Google Analytics (Type string) Passer vide pour enlever.
providerFilter		Désigne si les onglets de fournisseur sont utilisés pour le tri dans les catalogues. (Type boolean)
languageFilter		Désigne si le filtre de langue est utilisé pour le tri dans les catalogues. (Type boolean)
isUsingCustomSupportInfo		Indique si le portail utilise des informations de contact personnalisées pour l’assistance technique (Type boolean)
newAccountUrl		Url du bouton de création de compte pour le portail. (Type string)
isEmailValidatedByCode		Indique si le portail force la validation de courriel par code envoyé au courriel (Type boolean)

Portails : portal /getlist

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

/portal/getlist (request) - Requête de la liste des portails

{}

/portal/getlist (response) - Retourne une liste d'objets portail

{}

Portails : portal /create

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

/portal/create (request) - Requête de création d'un portail

{  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",   "title": {    "texts": [{        "text": "MonPortail",        "languageId": 1      }    ]  },  "branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",  "name": "mon nom de portail",  "url": "monurldeportail"}

/portal/create (response) - Retourne l'identifiant du portail créé

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

Portails : portal/edit

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

/portal/edit (request) - Requête d’édition d'un portail

{  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",   "title": {    "texts": [{        "text": "MonPortail",        "languageId": 1      }    ]  },  "branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"}

/portal/edit (response) - Retourne l’identifiant du portail modifié

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

Description des codes d’erreurs de portail

Numéro	Message	Commentaires/description
1100	Required id	Vous devez fournir un identifiant pour le portail.
1101	Invalid id	L’identifiant fourni pour le portail est invalide.
1102	Required branch id	Vous devez fournir un identifiant pour la branche.
1103	Invalid branch id	L’identifiant fourni pour la branche est invalide.
1104	Required url	Vous devez fournir une url.
1105	Invalid url	L’url fournie est invalide.
1106	Invalid cover id	L’identifiant fourni pour le cover est invalide.
1107	Required name	Vous devez fournir un nom pour le portail.
1108	Invalid name length	La taille du nom fourni pour le portail est invalide.
1109	Required title	Vous devez fournir un titre pour le portail.
1110	Invalid title length	La taille du titre fourni pour le portail est invalide.
1111	Invalid subtitle length	La taille du sous-titre fourni pour le portail est invalide.
1112	Invalid description length	La taille de la description fournie pour le portail est invalide.
1113	Invalid default branch id	L’identifiant fourni pour la branche par défaut est invalide.
1114	Error linking external auth	Une erreur est survenue lors de la création du lien entre le portail et la méthode d’authentification.
1115	Invalid newAccountUrl length	L’url pour le bouton de création de compte est invalide.
1116	Invalid newAccountButtonLabel length	La taille du libellé de bouton de création de compte est invalide.

French