4D Doc Center : Web Services (Client)

4D v14.3

Web Services (Client)

Constante	Type	Valeur	Commentaire
Web Service afficher dial auth	Entier long	4	valeur = 0 (ne pas afficher le dialogue) ou 1 (afficher le dialogue) Cette option gère l’affichage de boîte de dialogue d’authentification lors de l’exécution de la commande WEB SERVICE APPELER. Par défaut, cette commande ne provoque jamais l'affichage de la boîte de dialogue, vous devez en principe utiliser la commande WEB SERVICE AUTHENTIFIER. Toutefois, si vous souhaitez qu’une boîte de dialogue d’authentification apparaisse pour que l’utilisateur saisisse ses identifiants, vous devez utiliser cette option : passez 1 dans valeur pour afficher la boîte de dialogue, et 0 sinon. La boîte de dialogue n’apparaît que si le service Web requiert une authentification.
Web Service code erreur	Entier long	0	Code d’erreur principal (défini par 4D). Ce code est également retourné dans la variable système Error. Voici la liste des codes pouvant être retournés : 9910 : Erreur Web Service (voir aussi Web Service origine erreur) 9911 : Erreur de l’analyseur xml 9912 : Erreur HTTP (voir aussi Web Service code erreur HTTP) 9913 : Erreur réseau 9914 : Erreur interne
Web Service code statut HTTP	Entier long	2	Code de statut HTTP (à utiliser en cas d’erreur principale 9912).
Web Service compression	Entier long	1
Web Service compression HTTP	Entier long	6	valeur = Web Service compression Cette option permet d’activer un mécanisme interne de compression des requêtes SOAP afin d’accélérer les échanges inter-applications 4D. Lorsque vous exécutez l'instruction WEB SERVICE FIXER OPTION(Web Service compression HTTP; Web Service compression) sur le client 4D du Web Service, les données de la prochaine requête SOAP envoyée par le client seront compressées en utilisant un mécanisme standard HTTP ("gzip" ou "deflate" en fonction du contenu de la requête) avant leur envoi au serveur SOAP 4D. Le serveur décompressera et analysera la requête puis répondra en utilisant automatiquement le même mécanisme. Seule la requête suivant l’appel de la commande WEB SERVICE FIXER OPTION est affectée. Vous devez donc appeler cette commande chaque fois que vous voulez utiliser la compression. Par défaut, 4D ne compresse pas les requêtes HTTP des Web Services. Note : Ce mécanisme ne peut pas être utilisé pour des requêtes adressées à un serveur SOAP 4D d’une version antérieure à la 11.3. Afin de vous permettre d’optimiser encore ce fonctionnement, des options supplémentaires configurent le seuil et le taux de compression des requêtes. Ces options sont accessibles via la commande FIXER PARAMETRE BASE.
Web Service dynamique	Entier long	0
Web Service effacer infos auth	Entier long	5	valeur = 0 (ne pas effacer les informations) ou 1 (les effacer) Cette option permet d’indiquer à 4D de mémoriser les informations d'authentification de l’utilisateur (nom d'utilisateur, mot de passe, méthode, etc.), dans le but de les réutiliser par la suite. Par défaut, ces informations sont effacées après chaque exécution de la commande WEB SERVICE APPELER. Passez 0 dans valeur pour les mémoriser et 1 pour les effacer. A noter que lorsque vous passez 0, les informations sont conservées pendant la session mais ne sont pas stockées.
Web Service entrée manuel	Entier long	1
Web Service header SOAP	Entier long	2	valeur = référence d’élément xml racine à insérer en tant que header (en-tête) de la requête SOAP. Cette option permet d’insérer un header dans la requête SOAP générée par la commande WEB SERVICE APPELER. Par défaut, les requêtes SOAP ne comportent pas d’en-tête spécifique. Cependant, certains Web Services requièrent la présence de cet en-tête, par exemple pour la gestion de paramètres d’identification.
Web Service manuel	Entier long	3
Web Service message	Entier long	1	Message détaillé décrivant l’erreur. Le type de message diffère suivant le type d’erreur principale. - Si erreur principale = 9910 (Erreur Web Service) : la cause de l’erreur SOAP est retournée (ex : “méthode appelée inexistante”). - Si erreur principale = 9911 (Erreur de l’analyseur xml) : l’emplacement de l’erreur dans le document xml est retourné. - Si erreur principale = 9912 (Erreur HTTP) : - si l’erreur HTTP est située dans l’intervalle [300-400] (problèmes lié à l’emplacement du document demandé), le nouvel emplacement de l’URL demandé est retourné. - pour tout autre code d’erreur HTTP, le <body> est renvoyé. - Si erreur principale = 9913 (Erreur réseau) : la cause de l’erreur réseau est retournée (ex : “AdresseServeur : erreur DNS”) - Si erreur principale = 9914 (Erreur interne) : la cause de l’erreur interne est retournée
Web Service origine erreur	Entier long	3	Cause de l’erreur (retournée par le protocole SOAP — à utiliser en cas d’erreur principale 9910). - Version Mismatch (les versions ne correspondent pas). - Must Understand (un paramètre défini comme obligatoire n’a pas pu être interprété par le serveur) - Sender Fault - Receiver Fault - Encoding Unknown (encodage inconnu)
Web Service SOAP_1_1	Entier long	0
Web Service SOAP_1_2	Entier long	1
Web Service sortie manuel	Entier long	2
Web Service timeout HTTP	Entier long	1	valeur = “timeout” de la partie cliente exprimé en secondes. Le timeout de la partie cliente est le délai d’attente du client Web Service en cas de non-réponse du serveur. A l’issue de ce délai, le client referme la session, la requête est perdue. Par défaut, ce délai est de 180 secondes. Il peut être modifié en raison de caractéristiques particulières (état du réseau, spécificités du Web Service, etc.).
Web Service version SOAP	Entier long	3	valeur = Web Service SOAP_1_1 ou Web Service SOAP_1_2 Cette option permet de préciser la version du protocole SOAP utilisée dans la requête. Passez dans valeur la constante Web Service SOAP_1_1 pour indiquer la version 1.1 et la constante Web Service SOAP_1_2 pour indiquer la version 1.2.