Fonctions communes:API - CONSULT - CLI : Différence entre versions

De Logilys
Aller à : navigation, rechercher
(→‎Afficher les données d'un client)
(→‎Informations retournées)
Ligne 248 : Ligne 248 :
 
       "CommDetRefNoActive":"1",
 
       "CommDetRefNoActive":"1",
 
       "AdrDetRefNoActive":"1"
 
       "AdrDetRefNoActive":"1"
 +
    }
 +
  ],
 +
  "Dos":[
 +
    {
 +
      "DosUID":"1",
 +
      "DosLabel:"Client",
 +
      "DosSysteme":"1"
 +
    },
 +
    {
 +
      "DosUID":"2",
 +
      "DosLabel:"Client : Facture",
 +
      "DosSysteme":"0"
 
     }
 
     }
 
   ]
 
   ]
Ligne 359 : Ligne 371 :
 
* AdrDetRefNoActive : À 0, il ne faut pas voir le champ AdrDetRefNo.
 
* AdrDetRefNoActive : À 0, il ne faut pas voir le champ AdrDetRefNo.
 
* CedexActif : À 0, il ne faut pas voir le champ AdrCedex.
 
* CedexActif : À 0, il ne faut pas voir le champ AdrCedex.
 +
'''Dos''' : Liste des dossiers
 +
* DosUID : ID du dossier
 +
* DosLabel : Libellé identifiant le dossier
 +
* DosSysteme : À 1 pour le dossier système (dossier obligatoire et non modifiable) sinon à 0.
 
{{BasPage_Fonctions_communes}}
 
{{BasPage_Fonctions_communes}}

Version du 21 mars 2019 à 14:16

API - CONSULT - CLI

Afficher les données d'un client

Permet d'afficher la fiche d'un client afin de le modifier ou d'en ajouter un.

DemAction : CONSULT
DemCat : CLI
DemOptions :

  • NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON.
  • CliNo : Numéro du client

Informations retournées

{  
  "Cli":[  
    {  
      "CliNo":"1",
      "CliRefNo":"",
      "AppelDetUID":"45",
      "CliGenre":"0",
      "CliPrenom":"Sapin",
      "CliNom":"Noël",
      "CliCie":"0",
      "Cli2ePrenom":"",
      "CliSurnom":"",
      "CliParticule":"",
      "CliSuffixe":"",
      "CliLangue":"1",
      "CliDateNais":"1891-06-11 00:00:00",
      "zAge":"126 ans, 5 mois",
      "SecUID":"19",
      "CliCom":""
    }
  ],
  "Adresse":[  
    {  
      "AdrDetUID":"1113",
      "AdrStd":"41, rue des Sapins",
      "AdrVille":"Pôle Nord",
      "AdrProvince":"Québec",
      "AdrCodeP":"H0H 0H0",
      "PaysUID":"1",
      "AdrCedex":"",
      "RegDesc1":"",
      "RegDesc2":"",
      "RegDesc3":"",
      "RegDesc4":"",
      "AdrValide":"1",
      "AdrValideUsrFullName":"SUPERVISEUR",
      "AdrValideDate":"2016-09-14 09:00:51",
      "AdrDetIdentIndividu":"Mister Sapin Noël",
      "AdrDetIdentTitre":"",
      "AdrDetIdentCompagnie":"",
      "AdrDetIdentService":""
    }
  ],
  "Prenom":[  
    {  
      "QEdValue":"Agathe"
    },
    {  
      "QEdValue":"Alain"
    },
    {  
      "QEdValue":"Alain-Denis"
    }
  ],
  "Particule":[  
    {  
      "QEdValue":"de"
    },
    {  
      "QEdValue":"de la"
    },
    {  
      "QEdValue":"du"
    },
    {  
      "QEdValue":"la"
    },
    {  
      "QEdValue":"le"
    },
    {  
      "QEdValue":"Van"
    }
  ],
  "Nom":[  
    {  
      "QEdValue":"Abrantes"
    },
    {  
      "QEdValue":"Algonquin"
    },
    {  
      "QEdValue":"Aniston"
    }
  ],
  "Suffixe":[  
    {  
      "QEdValue":"dr."
    },
    {  
      "QEdValue":"Ing."
    }
  ],
  "Ville":[  
    {  
      "QEdValue":"Asbestos"
    },
    {  
      "QEdValue":"Blainville"
    }
    {  
      "QEdValue":"Victoriaville"
    }
  ],
  "Province":[  
    {  
      "QEdValue":"Alberta"
    },
    {  
      "QEdValue":"Colombie-Britanique"
    },
    {  
      "QEdValue":"Québec"
    }
  ],
  "Pays":[  
    {  
      "PaysDesc":"Canada",
      "PaysCode2":"CA",
      "PaysCode3":"CAN",
      "PaysUID":"1"
    },
    {  
      "PaysDesc":"France",
      "PaysCode2":"FR",
      "PaysCode3":"FRA",
      "PaysUID":"3"
    },
    {  
      "PaysDesc":"United States",
      "PaysCode2":"US",
      "PaysCode3":"USA",
      "PaysUID":"2"
    }
  ],
  "Appellation":[  
    {  
      "AppelDetLongue":"Madame",
      "AppelDetCourte":"Mme",
      "AppelGenreDesc":"Féminin",
      "AppelGenre":"1",
      "AppelDetLngCode":"Fr",
      "AppelDetLngUID":"0",
      "AppelNombreDesc":"Singulier",
      "AppelNombre":"0",
      "AppelDetUID":"22"
    },
    {  
      "AppelDetLongue":"Mademoiselle",
      "AppelDetCourte":"Mlle",
      "AppelGenreDesc":"Féminin",
      "AppelGenre":"1",
      "AppelDetLngCode":"Fr",
      "AppelDetLngUID":"0",
      "AppelNombreDesc":"Singulier",
      "AppelNombre":"0",
      "AppelDetUID":"23"
    }
    {  
      "AppelDetLongue":"Mister",
      "AppelDetCourte":"Mr.",
      "AppelGenreDesc":"Masculin",
      "AppelGenre":"0",
      "AppelDetLngCode":"An",
      "AppelDetLngUID":"1",
      "AppelNombreDesc":"Singulier",
      "AppelNombre":"0",
      "AppelDetUID":"45"
    }
  ],
  "Langue":[  
    {  
      "LngDesc":"Français",
      "LngUID":"0"
    },
    {  
      "LngDesc":"Anglais",
      "LngUID":"1"
    },
    {  
      "LngDesc":"Espagnol",
      "LngUID":"2"
    }
  ],
  "Secteur":[  
    {  
      "SecDesc":"Agriculture",
      "SecUID":"16",
      "GrpSecUID":"6"
    },
    {  
      "SecDesc":"Commerce de détail",
      "SecUID":"3",
      "GrpSecUID":"6"
    },
    {  
      "SecDesc":"Enseignement",
      "SecUID":"14",
      "GrpSecUID":"5"
    }
  ],
  "Division":[  
    {  
      "GrpSecDesc":"Travail Intellectuel",
      "GrpSecUID":"5"
    },
    {  
      "GrpSecDesc":"Travail Manuel",
      "GrpSecUID":"6"
    }
  ],
  "Options":[  
    {  
      "LabelCliRefNoFr":"No Réf.",
      "LabelCliRefNoEn":"No Réf.",
      "QuickEditPrenomNom":"1",
      "Cli2ePrenomActif":"1",
      "SurnomActif":"1",
      "ParticuleActive":"1",
      "AfficherIdentAdrPrinc":"0",
      "AffAdrReg1":"1",
      "AffAdrReg2":"0",
      "AffAdrReg3":"0",
      "AffAdrReg4":"0",
      "ActiveDivision":"1",
      "LabelCliComFr":"Commentaire",
      "LabelCliComEn":"Commentaire",
      "OrdreRowAdrStd":"2",
      "OrdreRowAdrVille":"3",
      "OrdreRowAdrProvince":"3",
      "OrdreRowAdrCodeP":"1",
      "OrdreRowAdrCedex":"1",
      "OrdreRowAdrPays":"1",
      "OrdreColAdrVille":"1",
      "OrdreColAdrProvince":"2",
      "OrdreColAdrCodeP":"2",
      "OrdreColAdrCedex":"3",
      "OrdreColAdrPays":"1",
      "ValidateMeansOfComm":"1",
      "ValidateAddresses":"1",
      "CommDetRefNoActive":"1",
      "AdrDetRefNoActive":"1"
    }
  ],
  "Dos":[
    {
      "DosUID":"1",
      "DosLabel:"Client",
      "DosSysteme":"1"
    },
    {
      "DosUID":"2",
      "DosLabel:"Client : Facture",
      "DosSysteme":"0"
    }
  ]
}

Cli : Onglet « Info. générales » de la fiche client

  • CliNo : Numéro du client
  • ClRefNo : Numéro de référence. Si l'utilisateur n'a pas l'accès « C » (Consultation) pour la sécurité « Fiche client : Numéro de référence » (CLIREFNO), ce champ ne sera pas retourné.
  • AppelDetUID : ID de l'appellation
  • CliGenre : Genre (0 = Masculin, 1 = Féminin)
  • CliPrenom : Prénom ou Service
  • CliNom : Nom ou Compagnie
  • CliCie : 0 = Individu, 1 = Compagnie
  • Cli2ePrenom : 2e prénom. Si l'option « Cli2ePrenomActif » est à 0, ce champ ne sera pas retourné.
  • CliSurnom : Surnom. Si l'option « SurnomActif » est à 0, ce champ ne sera pas retourné.
  • CliParticule : Particule. Si l'option « ParticuleActive » est à 0, ce champ ne sera pas retourné.
  • CliSuffixe : Suffixe
  • CliLangue : ID de la langue
  • CliDateNais : « Date de naissance » pour un individu et « Fondée le » pour une compagnie. Si l'utilisateur n'a pas l'accès « C » (Consultation) pour la sécurité « Fiche client : Date de naissance/Age » (CLIDATENAIS), ce champ ne sera pas retourné.
  • zAge : Age du client. Si l'utilisateur n'a pas l'accès « C » (Consultation) pour la sécurité « Fiche client : Date de naissance/Age » (CLIDATENAIS), ce champ ne sera pas retourné.
  • SecUID : ID de secteur d'activité
  • CliCom : Commentaire

Adresse : Adresse par défaut

  • AdrDetUID : ID de l'adresse
  • AdrStd : Adresse
  • AdrVille : Ville
  • AdrProvince : Province
  • AdrCodeP : Code postal
  • PaysUID : ID du pays
  • AdrCedex : CEDEX. Si l'option « CedexActif » est à 0, ce champ ne sera pas retourné.
  • RegDesc1 : Nom de la région #1. Si l'option « AffAdrReg1 » est à 0, ce champ ne sera pas retourné.
  • RegDesc2 : Nom de la région #2. Si l'option « AffAdrReg2 » est à 0, ce champ ne sera pas retourné.
  • RegDesc3 : Nom de la région #3. Si l'option « AffAdrReg3 » est à 0, ce champ ne sera pas retourné.
  • RegDesc4 : Nom de la région #4. Si l'option « AffAdrReg4 » est à 0, ce champ ne sera pas retourné.
  • AdrValide : À 1 si l'adresse a été validée. Si l'option « ValidateAddresses » est à 0, ce champ ne sera pas retourné.
  • AdrValideUsrFullName : Nom de l'utilisateur ayant validé l'adresse. Si l'option « ValidateAddresses » est à 0, ce champ ne sera pas retourné.
  • AdrValideDate : Date à laquelle l'adresse a été validée. Si l'option « ValidateAddresses » est à 0, ce champ ne sera pas retourné.
  • AdrDetIdentIndividu : Identification de l'individu. Si l'option « AfficherIdentAdrPrinc » est à 0, ce champ ne sera pas retourné.
  • AdrDetIdentTitre : Identification du titre de l'individu. Si l'option « AfficherIdentAdrPrinc » est à 0, ce champ ne sera pas retourné.
  • AdrDetIdentCompagnie : Identification de la compagnie. Si l'option « AfficherIdentAdrPrinc » est à 0, ce champ ne sera pas retourné.
  • AdrDetIdentService : Identification du service. Si l'option « AfficherIdentAdrPrinc » est à 0, ce champ ne sera pas retourné.

Prenom : Liste des prénoms si le prénom est affiché sous forme de liste déroulante dynamique

  • QEdValue : Prénom

Particule : Liste des particules

  • QEdValue : Particule

Nom : Liste des noms si le nom est affiché sous forme de liste déroulante dynamique

  • QEdValue : Nom
  • Suffixe : Liste des suffixes
  • QEdValue : Suffixe

Ville : Liste des villes

  • QEdValue : Ville

Province : Liste des provinces

  • QEdValue : Province

Pays : Liste des pays

  • PaysDesc : Nom du pays
  • PaysCode2 : Code à 2 lettres du pays
  • PaysCode3 : Code à 3 lettres du pays
  • PaysUID : ID du pays

Appellation : Liste des appellations

  • AppelDetLongue : Appellation longue
  • AppelDetCourte : Appellation courte
  • AppelGenreDesc : Description du genre
  • AppelGenre : ID du genre (0 = Masculin, 1 = Féminin)
  • AppelDetLngCode : Code de la langue
  • AppelDetLngUID : ID de la langue
  • AppelNombreDesc : Description du nombre
  • AppelNombre : ID du nombre (0 = Singulier, 1 = Pluriel)
  • AppelDetUID : ID de l'appellation

Langue : Liste des langues

  • LngDesc : Description de la langue
  • LngCode : Code de la langue
  • LngUID : ID de la langue

Secteur : Liste des secteurs d'activité

  • SecDesc : Description du secteur
  • SecCode : Code du secteur
  • SecUID : ID du secteur
  • GrpSecUID : ID de la division

Division : Liste des divisions. Si l'option « ActiveDivision » est à 0, cette liste ne retournera rien.

  • GrpSecDesc : Description de la division
  • GrpSecCode : Code de la division
  • GrpSecUID : ID de la division

Options : Préférences utilisateur/système

  • LabelCliRefNoFr : Libellé français pour le champ du numéro de référence (CliRefNo)
  • LabelCliRefNoEn : Libellé anglais pour le champ du numéro de référence (CliRefNo)
  • QuickEditPrenomNom : À 1, les champs du prénom (CliPrenom) et du nom (CliNom) doivent être affichés sous forme de liste déroulante dynamique. Cette option s'applique uniquement pour les individus. (CliCie = 0)
  • Cli2ePrenomActif : À 0, le champ du 2e prénom (Cli2ePrenom) ne doit pas être affiché.
  • SurnomActif : À 0, le champ du surnom (CliSurnom) ne doit pas être affiché.
  • ParticuleActive : À 0, le champ de la particule (CliParticule) ne doit pas être affiché.
  • AfficherIdentAdrPrinc : À 0, les champs AdrDetIdentIndividu, AdrDetIdentTitre, AdrDetIdentCompagnie et AdrDetIdentService ne doivent pas être affichés.
  • AffAdrReg1 : À 0, la description de la région #1 ne doit pas être affichée.
  • AffAdrReg2 : À 0, la description de la région #2 ne doit pas être affichée.
  • AffAdrReg3 : À 0, la description de la région #3 ne doit pas être affichée.
  • AffAdrReg4 : À 0, la description de la région #4 ne doit pas être affichée.
  • ActiveDivision : À 0, la division ne doit pas être affichée.
  • LabelCliComFr : Libellé français pour le champ du commentaire
  • LabelCliComEn : Libellé anglais pour le champ du commentaire
  • OrdreRowAdrStd : Positionnement des champs de l'adresse. Indique la ligne pour le champ de l'adresse.
  • OrdreRowAdrVille : Positionnement des champs de l'adresse. Indique la ligne pour le champ de la ville.
  • OrdreRowAdrProvince : Positionnement des champs de l'adresse. Indique la ligne pour le champ de la province.
  • OrdreRowAdrCodeP : Positionnement des champs de l'adresse. Indique la ligne pour le champ du code postal.
  • OrdreRowAdrCedex : Positionnement des champs de l'adresse. Indique la ligne pour le champ du CEDEX.
  • OrdreRowAdrPays : Positionnement des champs de l'adresse. Indique la ligne pour le champ du pays.
  • OrdreColAdrVille : Positionnement des champs de l'adresse. Indique la colonne pour le champ de la ville.
  • OrdreColAdrProvince : Positionnement des champs de l'adresse. Indique la colonne pour le champ de la province.
  • OrdreColAdrCodeP : Positionnement des champs de l'adresse. Indique la colonne pour le champ de la code postal.
  • OrdreColAdrCedex : Positionnement des champs de l'adresse. Indique la colonne pour le champ du CEDEX.
  • OrdreColAdrPays : Positionnement des champs de l'adresse. Indique la colonne pour le champ du pays.
  • ValidateMeansOfComm : À 0, il ne faut pas voir les champs CommValide, yUsrFullNameValide et CommValideDate.
  • ValidateAddresses : À 0, il ne faut pas voir les champs AdrValide, AdrValideUsrFullName et AdrValideDate.
  • CommDetRefNoActive : À 0, il ne faut pas voir le champ CommDetRefNo.
  • AdrDetRefNoActive : À 0, il ne faut pas voir le champ AdrDetRefNo.
  • CedexActif : À 0, il ne faut pas voir le champ AdrCedex.

Dos : Liste des dossiers

  • DosUID : ID du dossier
  • DosLabel : Libellé identifiant le dossier
  • DosSysteme : À 1 pour le dossier système (dossier obligatoire et non modifiable) sinon à 0.

Nom du document : Fonctions communes:API - CONSULT - CLI

Récupérée de « http://wikifr.logilys.com/index.php?title=Fonctions_communes:API_-_CONSULT_-_CLI&oldid=20363 »