version 2004
FIXER OPTION WEB SERVICE (option; valeur)
Paramètre | Type | Description | |
option | Entier long | Code de l'option à fixer | |
valeur | Entier long | Texte | Valeur de l'option |
Note préliminaire : Cette commande est destinée aux utilisateurs avancés des Web Services. Son emploi est facultatif.
Description
La commande FIXER OPTION WEB SERVICE permet de définir différentes options qui seront utilisées lors de la prochaine requête SOAP déclenchée par la commande APPELER WEB SERVICE.
Vous pouvez appeler cette commande autant de fois qu'il y a d'options à fixer.
Passez dans le paramètre option le numéro de l'option à définir et dans le paramètre valeur la nouvelle valeur de l'option. Vous pouvez utiliser pour ces deux paramètres une des constantes prédéfinies suivantes, situées dans le thème "Web Services (Client)" :
Constante (param option) | Type | Valeur |
Web Service timeout HTTP | Entier long | 1 |
Web Service header SOAP | Entier long | 2 |
Web Service version SOAP | Entier long | 3 |
Constante (param valeur) | Type | Valeur |
Web Service SOAP_1_1 | Entier long | 0 |
Web Service SOAP_1_2 | Entier long | 1 |
Voici la description des options et des valeurs possibles :
option = Web Service timeout HTTP
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.).
option = Web Service header SOAP
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 APPELER WEB SERVICE. 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.
option = Web Service version SOAP
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.
L'ordre d'appel des options n'a pas d'importance. Si une même option est définie plusieurs fois, seule la valeur du dernier appel est prise en compte.
Exemples
(1) Insertion d'un en-tête personnalisé dans la requête SOAP :
` Création d'une référence XML C_ALPHA(16;vRefRacine;vRefElement) vRefRacine:=DOM Creer ref XML("RootElement") vxPath:="/RootElement/Elem1/Elem2/Elem3" vRefElement:=DOM Creer element XML(vRefRacine;vxPath) `Modification de l'en-tête SOAP avec la référence FIXER OPTION WEB SERVICE(Web Service header SOAP;vRefElement)
(2) Utilisation de la version 1.2 du protocole SOAP :
FIXER OPTION WEB SERVICE(Web Service version SOAP;Web Service SOAP_1_2)
Référence