Contraction d’adresse

	Avertissement
Cette page n’est plus maintenue depuis la version 2022 de Geoconcept Web. Pour accéder à la documentation à jour de ce web service, veuillez suivre ce lien.

Principe

La requête prend en entrée une adresse (décomposée en ligne adresse, code postal, commune) et la taille de contraction normalisée souhaitée (32 ou 38).

Le service retourne en sortie une contraction de la partie ligne adresse selon les règles exprimées dans les normes AFNOR correspondantes (norme 32 caractères et norme 38 caractères).

Concernant la fonction de restitution de la ligne adresse à 38 caractères, seule la norme AFNOR NF Z10-011 de janvier 2013 (en 38 caractères) sera applicable.

Concernant la fonction de restitution de la ligne adresse à 32 caractères ;

En premier lieu la norme AFNOR NF Z10-011 de janvier 2013 (en 38 caractères) sera applicable :
- vis-à-vis des règles de réduction, mais jusqu’à l’objectif de 32 caractères,
- vis-à-vis des abréviations de mots, y compris celles qui ne sont pas définies en annexe B de la norme NF Z10-011 d’août 1989 (en 32 caractères).
En dernier ressort, à l’issue de l’application de la norme AFNOR NF Z10-011 de janvier 2013, la norme NF Z10-011 d’août 1989 (en 32 caractères) sera applicable vis-à-vis des abréviations de mots, mais uniquement si la longueur maximale demandée est de 32 et si la longueur résultante demeure supérieure à 32 caractères. Dans ce cas, elle se limitera à l’application des abréviations de l’annexe B de la norme NF Z10-011 d’août 1989 (en 32 caractères) pour lesquelles la norme AFNOR NF Z10-011 de janvier 2013 dans ses différentes annexes ne propose pas d’abréviation.

Ce service interroge des fichiers d’abréviations, reprenant en standard les annexes des normes AFNOR citées.

Disponibilité

Ce web service est disponible en permanence avec Geoconcept Web.

V1

Paramètres / propriétés

En entrée

paramètre	description	optionnel	défaut
maxLength	maxLength définit, sous forme de nombre entier, la taille de référence à atteindre pour la contraction de la ligne adresse. Les valeurs acceptées sont exclusivement 32 ou 38.	oui	38
addressLine	Ligne d’adresse recevant, soit la VOIE sous la forme numéro, indice de répétition, type de voie et libellé de voie, soit le LIEU-DIT. La justesse de la contraction d’adresse en sortie du WS ne pourra être assurée que sous réserve d’une fourniture d’un paramètre addressLine résultant d’une adresse validée à l’aide d’un référentiel Adresses.	non
city	Commune correspondant à la ligne adresse renseignée. Aucun traitement ne sera effectué sur ce paramètre.	oui
postCode	Code postal correspondant à la ligne adresse renseignée. Aucun traitement ne sera effectué sur ce paramètre.	oui

En sortie

paramètre	type	min/max	description
id	long	1/1	Incrément automatique d’identifiant de réponse.
status	string	0/1	Indique la réussite ou l’échec du processus de contraction « OK » ou « ERROR ».
statusDetails	string	0/1	Vide, en cas de réussite du processus de contraction. Avec le message d’erreur correspondant, en cas d’échec. "Invalid maxLength parameter. It needs to be either 32 or 38". "The address contraction can’t reach the expected maxLength". "The supplied addressline was above 100 characters".
maxLength	int	1/1	Reprend la valeur fournie en entrée « 32 » ou « 38 ».
address	array (normalizedAddress)	0/1	Adresse normalisée.
normedAddressLineLength	int	1/1	Longueur de la ligne adresse obtenue, après les opérations de contraction effectuées par le service.

Adresse normalisée (normalizedAddress)

paramètre	type	min/max	description
normedAddressLine	string	0/1	Résultat final de la contraction de la ligne adresse effectuée par le service.
city	string	0/1	Retourne la commune fournie en entrée, sans modification, (vide sinon).
postCode	string	0/1	Retourne le code postal fourni en entrée, sans modification, (vide sinon).

SOAP

WSDL

http://<server>/<webapp>/api/ws/addressNormalizerService?wsdl

Requête

L’exemple de requête prend en compte la ligne adresse suivante : ``123 Bis, Boulevard du MARÉCHAL Jean de-Lattre-de-Tassigny Inférieur".

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://geoconcept.com/gc/schemas">
  <soapenv:Header/>
  <soapenv:Body>
     <sch:normalize>
        <maxLength>38</maxLength>
        <addressLine>123 Bis, Boulevard du MARÉCHAL Jean de-Lattre-de-Tassigny Inférieur</addressLine>
        <!--Optional:-->
        <city></city>
        <!--Optional:-->
        <postCode></postCode>
     </sch:normalize>
  </soapenv:Body>
</soapenv:Envelope>

Réponse

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
     <ns2:normalizeResponse xmlns:ns2="http://geoconcept.com/gc/schemas">
        <NormalizerResponse>
           <id>2</id>
           <status>OK</status>
           <statusDetails/>
           <maxLength>38</maxLength>
           <address>
              <normedAddressLine>123 B BD MAL J LATTRE TASSIGNY INF</normedAddressLine>
              <city/>
              <postCode/>
           </address>
           <normedAddressLineLength>34</normedAddressLineLength>
        </NormalizerResponse>
     </ns2:normalizeResponse>
  </soap:Body>
</soap:Envelope>

REST

Requête

L’exemple de requête prend en compte la ligne adresse suivante : ``123 Bis, Boulevard du MARÉCHAL Jean de-Lattre-de-Tassigny Inférieur".

Requête JSON

http://<server>/<webapp>/api/lbs/normalizer.json?addressLine=123%20Bis,%20Boulevard%20du%20MAR%C3%89CHAL%20Jean%20de-Lattre-de-Tassigny%20Inf%C3%A9rieur

Requête JSON-P

http://<server>/<webapp>/api/lbs/normalizer.json?addressLine=123%20Bis,%20Boulevard%20du%20MAR%C3%89CHAL%20Jean%20de-Lattre-de-Tassigny%20Inf%C3%A9rieur&callback=myCallback

Requête XML

http://<server>/<webapp>/api/lbs/normalizer.xml?addressLine=123%20Bis,%20Boulevard%20du%20MAR%C3%89CHAL%20Jean%20de-Lattre-de-Tassigny%20Inf%C3%A9rieur

Réponse

La réponse est toujours encodée en UTF-8.

Format JSON

{
   "id": 3,
   "status": "OK",
   "statusDetails": "",
   "maxLength": 38,
   "address":    {
      "normedAddressLine": "123 B BD MAL J LATTRE TASSIGNY INF",
      "city": "",
      "postCode": ""
   },
   "normedAddressLineLength": 34
}

Format JSON-P

myCallback({
           "id": 3,
           "status": "OK",
           "statusDetails": "",
           "maxLength": 38,
           "address":    {
                  "normedAddressLine": "123 B BD MAL J LATTRE TASSIGNY INF",
                  "city": "",
                  "postCode": ""
           },
           "normedAddressLineLength": 34
});

Format XML

<normalizerResponse>
   <id>4</id>
   <status>OK</status>
   <statusDetails/>
   <maxLength>38</maxLength>
   <address>
      <normedAddressLine>123 B BD MAL J LATTRE TASSIGNY INF</normedAddressLine>
      <city/>
      <postCode/>
   </address>
   <normedAddressLineLength>34</normedAddressLineLength>
</normalizerResponse>

Retours possibles

Cas d’une adresse normalisée (NormalizerResponse/NormalizerResponse/status est OK)

<ns2:normalizeResponse xmlns:ns2="http://geoconcept.com/gc/schemas">
 <NormalizerResponse>
        <id>2</id>
        <status>OK</status>
        <statusDetails/>
        <maxLength>38</maxLength>
        <address>
           <normedAddressLine>123 B BD MAL J LATTRE TASSIGNY INF</normedAddressLine>
           <city>Paris</city>
           <postCode/>
        </address>
        <normedAddressLineLength>34</normedAddressLineLength>
 </NormalizerResponse>
</ns2:normalizeResponse>

Cas d’un positionnement de la taille de réduction à une valeur autre que « 32 » ou « 38 » (NormalizerResponse/NormalizerResponse/status est ERROR)

<ns2:normalizeResponse xmlns:ns2="http://geoconcept.com/gc/schemas">
 <NormalizerResponse>
        <id>5</id>
        <status>ERROR</status>
        <statusDetails>Invalid maxLength parameter. It needs to be either 32 or 38</statusDetails>
        <maxLength>0</maxLength>
        <address>
           <normedAddressLine/>
           <city/>
           <postCode/>
        </address>
        <normedAddressLineLength>0</normedAddressLineLength>
 </NormalizerResponse>
</ns2:normalizeResponse>

Cas d’une adresse de plus de 100 caractères (NormalizerResponse/NormalizerResponse/status est ERROR)

<ns2:normalizeResponse xmlns:ns2="http://geoconcept.com/gc/schemas">
 <NormalizerResponse>
        <id>6</id>
        <status>ERROR</status>
        <statusDetails>The supplied addressline was above 100 characters</statusDetails>
        <maxLength>0</maxLength>
        <address>
           <normedAddressLine/>
           <city/>
           <postCode/>
        </address>
        <normedAddressLineLength>0</normedAddressLineLength>
 </NormalizerResponse>
</ns2:normalizeResponse>

Cas d’un échec de la contraction de la ligne adresse à hauteur de la taille attendue (NormalizerResponse/NormalizerResponse/status est ERROR)

<ns2:normalizeResponse xmlns:ns2="http://geoconcept.com/gc/schemas">
 <NormalizerResponse>
        <id>7</id>
        <status>ERROR</status>
        <statusDetails>The address contraction can't reach the expected maxLength</statusDetails>
        <maxLength>0</maxLength>
        <address>
           <normedAddressLine>123 B BD A F ZQ S E MAL J L TASSIGNY INF</normedAddressLine>
           <city>Paris</city>
           <postCode/>
        </address>
        <normedAddressLineLength>40</normedAddressLineLength>
 </NormalizerResponse>
</ns2:normalizeResponse>

FAQ

1. Est-il possible de modifier, d’ajouter ou de supprimer les chaines utilisées pour les abréviations ?

1.

Est-il possible de modifier, d’ajouter ou de supprimer les chaines utilisées pour les abréviations ?

Oui, ces informations sont éditables. Dans le dossier « <TOMCAT_HOME> »\webapps\geoconcept-web\WEB-INF\lib\, ouvrir le fichier geoweb-ws-(version).jar, suivre le chemin com\geoconcept\lbs\webservices à l’intérieur se trouve le fichier Substitutions.xml. Ce fichier contient le vocabulaire utilisé pour la normalisation (primary way types, secondary way types, way type extensions, articles, indicateur de répétitions, prénoms et autres abréviations. Ainsi qu’une liste, à la fin, pour définir les mots utilisés seulement pour la norme AFNOR de 32 caractères.

Précédent	Niveau supérieur	Suivant
	Sommaire

Documentation des Web Services de Geoconcept Web - Web Services