Accès aux méthodes Web Services SOAP/WSDL (xml)¶
Avertissement
Les WS SOAP sont dépréciés, veuillez utiliser les Web Services RESTful (json) qui proposent plus de fonctionnalités et sont plus performants.
Présentation¶
Il est possible d’accéder à iA.Délib via Web Services utilisant le standard SOAP/WSDL.
Pour cela, l’application iA.Délib doit être configurée pour accepter des connexions entrantes (appels aux méthodes publiées) et publier un descriptif WSDL d’accès à ces méthodes. Techniquement, le package imio.pm.ws doit être configuré et installé.
Une fois le package installé, le fichier WSDL (ws4pm.wsdl) est disponible et décrit l’accès aux méthodes suivantes :
test de connexion (testConnection) : permet de tester si le paramètres d’identification renseigné (nom d’utilisateur/mot de passe) sont corrects
obtention d’informations sur la configuration (getConfigInfos) : retourne différentes informations sur la configuration utilisée
obtention d’informations sur un utilisateur (getUserInfos) : retourne des informations concernant l’accès de cet utilisateur
obtention d’informations sur un point (getItemInfos) : retourne des informations pour un point en particulier
recherche de points (searchItems) : effectue une recherche de points
savoir si un élément a déjà été envoyé (checkIsLinked) : permet de savoir si un élément à déjà été créé
obtenir un document généré (getItemTemplate) : permet de déclencher la production d’un document dans iA.Délib
créer un point (createItem): permet de créer un point dans iA.Délib
Toutes ces méthodes ne sont accessibles que si l’appel au Web Service contient les informations de connexion d’un utilisateur iA.Délib. Les différentes actions ne pourront être faites que si l’utilisateur renseigné dans l’authentification en a le droit dans iA.Délib…
Test de connexion (testConnection)¶
Cette méthode permet de vérifier si les données de connexion renseignées pour accéder au Web Services sont correctes.
Paramètres d’entrées :
Aucun
Sortie :
Retourne “1” si la connexion a pu être établie, “0” sinon. Retourne également dans “version”, la version des WS
Obtention d’informations sur la configuration (getConfigInfos)¶
Cette méthode permet d’obtenir des informations concernant la configuration mise en place sur iA.Délib. Ceci permet de connaître notamment les identifiants à utiliser lors du passage de certains paramètres pour les méthodes de création de point, recherche de points, … …
Paramètres d’entrées :
Sortie :
Retourne la liste des Configuration de séances (MeetingConfig), des organisations iA.Délib (organization) et des catégories (categories) si le paramètre “showCategories” était à “1” lors de l’appel et si elles sont effectivement utilisées par la Configuration de séance.
Obtention d’informations sur un utilisateur (getUserInfos)¶
Cette méthode permet d’obtenir des informations sur un utilisateur.
Paramètres d’entrées :
creators : retourne les groupes pour lesquels l’utilisteur est un créateur de points
reviewers : retourne les groupes pour lesquels l’utilisateur est un validateur de points
advisers : retourne les groupes pour lesquels l’utilisateur est un donneur d’avis
D’autres suffixes peuvent exister en fonction de la configuration spécifique de iA.Délib
Sortie :
Retourne les infos sur l’utilisateur : “Nom complet” et “Adresse e-mail”. Si “showGroups” était à “1”, retourne également la liste des groupes iA.Délib (MeetingGroup) adéquats.
Obtention d’informations sur un point (getItemInfos)¶
Cette méthode permet d’obtenir des informations sur un point. A utiliser si on connaît l’UID du point pour lequel on souhaite des informations. On connaît l’UID d’un point si on a créé ce point (Créer un point (createItem)) via des Web Services ou lors d’une recherche de points (Recherche de points (searchItems))
Paramètres d’entrées :
Sortie :
Retourne les infos sur le point (informations principales + étendues si spécifié). Affiche la liste des annexes si spécifié (avec fichier). Affiche la liste des document générables (sans le fichier, passer par l’obtention d’un document généré (Obtenir un document généré (getItemTemplate)) pour obtenir le fichier).
Recherche de points (searchItems)¶
Cette méthode permet d’effectuer une recherche de point sur base de plusieurs critères de recherche.
Paramètres d’entrées :
Critères de recherche : (obligatoire) différents critères peuvent être utilisés :
créateur (Creator)
titre (Title)
description du point (Description)
décision du point (decision)
type de point (Collège, Conseil, …) (portal_type)
état WF du point (review_state)
identifiant de la catégorie (getCategory)
UID de la séance liée (linkedMeetingUID)
identifiant du type de séance (meetingConfigId)
…
Sortie :
Retourne les infos sur le point, désormais les informations reçues sur un point via searchItems sont aussi complètent que via la méthode Obtention d’informations sur un point (getItemInfos)
Savoir si un élément a déjà été envoyé (checkIsLinked)¶
Cette méthode permet de savoir si un élément appelant a déjà été envoyé vers iA.Délib, à condition que lors de la création du point dans iA.Délib, l’élément appelant ai soit passé un “identifiant externe”, soit stocké l’UID du point créé.
Paramètres d’entrées :
Sortie :
Retourne “isLinked” à “1” si un point correspondant a été trouvé, “0” sinon.
Obtenir un document généré (getItemTemplate)¶
Cette méthode permet d’obtenir un document généré pour un point donné.
Paramètres d’entrées :
Sortie :
Retourne le document généré.
Créer un point (createItem)¶
Cette méthode permet de créer un nouveau point dans iA.Délib.
Paramètres d’entrées :
titre (title, obligatoire)
catégorie (category, obligatoire si catégories utilisées par la meetingConfigIf)
description (description)
description détaillée (detailedDescription)
motivation (motivation)
décision (optionnel)
UID de la séance souhaitée (preferredMeeting)
UIDs des groupes associés (associatedGroups)
UIDs des groupes en charge (groupsInCharge)
identifiants des émetteurs d’avis optionnels (optionalAdvisers)
identifiant externe (optionnel)
annexes (optionnel)
Une nouvelle valeur “extraAttrs” est disponible et permet de renseigner des valeurs pour les champs XHTML qui ne sont pas gérés par défaut, donc autres que “description”, “detailedDescription”, “motivation” et “decision”. Ce paramètre doit recevoir une liste de dictionnaire de la forme suivante :
[{'key': 'my_xhtml_field_id', 'value': '<p>My field XHTML value.</p>'}]
Sortie :
Retourne l’UID du point créé. Cette information pourra être stockée par la procédure appelante afin de pouvoir retrouver le point par la suite. Si la procédure appelante ne souhaite pas stocker cet UID, un “identifiant externe” passé dans le creationData ci-dessus à la même utilité mais stocke alors dans iA.Délib un identifiant provenant de la procédure appelante… Une série d’avertissements (warnings) peut également être retournée : HTML utilisé non valide (donc corrigé), annexe passée non valide, …
Liste des séances acceptant des points (meetingsAcceptingItems)¶
Cette méthode permet d’obtenir la liste des séances qui acceptent des points.
Paramètres d’entrées :
Sortie :
Retourne l’UID et la date des séances qui acceptent des points. L’UID pourra être utilisé pour l’attribut “preferredMeeting” lors de l’utilisation de createItem.