SWS_ListeVariablesASaisir
- 01 Feb 2023
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
SWS_ListeVariablesASaisir
- Mis à jour le 01 Feb 2023
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
Fonction API
SWS_ListeVariablesASaisir
Description
Permet de récupérer la liste des variables à saisir
Note : La liste est également alimentée par les primes que l'on peut retrouver dans les profils utilisateur.
Ces dernières seront reconnaissables par leur champ "Options" renseigné par "#PPU#".
Groupe de fonctions API
Code API : F10 / ELV001
Paramètres de la requête
| Paramètre | Type | Description |
|---|---|---|
| Token | string | Token d'authentification renvoyé en réponse à l'authentification via SWS_SiteLogin |
| NumeroDossier | string | Numéro du dossier concerné par la requête |
Paramètres de la réponse
| Paramètre | Type | Description |
|---|---|---|
| SWS_ListeVariablesASaisirResult | SWS_ListeVariablesASaisirResult | Élément structuré contenant la réponse à la requête (Détail ci-dessous) |
SWS_ListeVariablesASaisirResult
| Paramètre | Type | Description |
|---|---|---|
| Error | string | Vide s'il n'y a pas d'erreur, sinon contient la description de l'erreur rencontrée |
| ListeVariablesASaisir | CPAISWSVariableASaisir[] | Liste d'éléments structurés contenant les informations des variables à saisir (cf. détail ci-dessous) |
CPAISWSVariableASaisir
| Paramètre | Type | Description |
|---|---|---|
| Nom | string | Nom |
| Famille | string | Famille |
| Libelle_Long | string | Libellé Long |
| Libelle_Court | string | Libellé court |
| Type_Variable | unsignedByte | Indique s'il s'agit d'une variable alphanumérique (1) ou numérique (2) |
| Format | string | Format du champ : X,Y où X est le nombre d'entiers, et Y le nombre de décimales |
| Ordre | string | Ordre de l'élément variable |
| IndiceCouleur | int | Indice de la couleur utilisée pour l'affichage dans Silae |
| Masquee | boolean | indique si la variable est masquée (true) ou non (false) |
| Options | string | Permet d'indiquer si une prime est issue d'un profil utilisateur (ce champ vaut alors "#PPU#) |
Requête
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SWS_ListeVariablesASaisir xmlns="http://www.silae.fr/">
<Token>string</Token>
<NumeroDossier>string</NumeroDossier>
</SWS_ListeVariablesASaisir>
</soap12:Body>
</soap12:Envelope>
Réponse
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SWS_ListeVariablesASaisirResponse xmlns="http://www.silae.fr/">
<SWS_ListeVariablesASaisirResult>
<Error>string</Error>
<ListeVariablesASaisir>
<CPAISWSVariableASaisir>
<Nom>string</Nom>
<Famille>string</Famille>
<Libelle_Long>string</Libelle_Long>
<Libelle_Court>string</Libelle_Court>
<Type_Variable>unsignedByte</Type_Variable>
<Format>string</Format>
<Ordre>string</Ordre>
<IndiceCouleur>int</IndiceCouleur>
<Masquee>boolean</Masquee>
<Options>string</Options>
</CPAISWSVariableASaisir>
<CPAISWSVariableASaisir>
<Nom>string</Nom>
<Famille>string</Famille>
<Libelle_Long>string</Libelle_Long>
<Libelle_Court>string</Libelle_Court>
<Type_Variable>unsignedByte</Type_Variable>
<Format>string</Format>
<Ordre>string</Ordre>
<IndiceCouleur>int</IndiceCouleur>
<Masquee>boolean</Masquee>
<Options>string</Options>
</CPAISWSVariableASaisir>
</ListeVariablesASaisir>
</SWS_ListeVariablesASaisirResult>
</SWS_ListeVariablesASaisirResponse>
</soap12:Body>
</soap12:Envelope>
Cet article vous a-t-il été utile ?