Documentation des Web Services de Geoconcept Web  -  Web Services

Le web service de Search Along permet d’identifier les meilleurs candidats pour ajouter une étape à proximité d’un trajet pré-existant.

L’algorithme explore les solutions pour retourner parmi les candidats celui qui à le meilleur score en fonction des critères demandées

Ce web service est disponible en permanence avec Geoconcept Web et un graphe.

En entrée

(*) Au moins l’un des deux paramètres routes, et routeNodes doit être renseigné.

(M18) Disponible à partir de la version M18 des graphes fournis par GEOCONCEPT SAS.

Trajets en entrée (inputRoute)

Coordonnées (geographicPoint)

Trajets en entrée basé sur les noeuds du graphe (inputRouteNode)

Candidats (searchAlongResource)

En sortie

Liste des trajets calculés (searchAlongRouteResult)

Candidats (searchAlongResourceResult)

WSDL

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

Requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://geoconcept.com/gc/schemas">
   <soapenv:Header />
   <soapenv:Body>
      <sch:searchAlongV1>
         <!--Optional:-->
         <request>
            <routes>
               <route>
                  <id>dep</id>
                  <departurePoint>
                     <x>-1.553927</x>
                     <y>47.21858</y>
                  </departurePoint>
                  <arrivalPoint>
                     <x>-1.593927</x>
                     <y>47.18858</y>
                  </arrivalPoint>
               </route>
            </routes>
            <resources>
               <resource>
                  <id>res1</id>
                  <node />
                  <priority1>1</priority1>
                  <priority2>2</priority2>
                  <x>-1.511092</x>
                  <y>47.208355</y>
               </resource>
               <resource>
                  <id>res2</id>
                  <node />
                  <priority1>1</priority1>
                  <priority2>1</priority2>
                  <x>-1.549524</x>
                  <y>47.195484</y>
               </resource>
            </resources>
            <srs>epsg:4326</srs>
            <maxDetourDestinationDistanceMeters>-1</maxDetourDestinationDistanceMeters>
            <maxDetourDestinationDurationSeconds>-1</maxDetourDestinationDurationSeconds>
            <maxDetourDistanceMeters>-1</maxDetourDistanceMeters>
            <maxDetourDurationSeconds>-1</maxDetourDurationSeconds>
            <maxDetourOriginDistanceMeters>-1</maxDetourOriginDistanceMeters>
            <maxDetourOriginDurationSeconds>-1</maxDetourOriginDurationSeconds>
            <method>time</method>
                        <timeOut></timeOut>
         </request>
      </sch:searchAlongV1>
   </soapenv:Body>
</soapenv:Envelope>

Réponse

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:searchAlongV1Response xmlns:ns2="http://geoconcept.com/gc/schemas">
         <SearchAlongResult>
            <status>OK</status>
            <routes>
               <route>
                  <id>dep</id>
                  <directDistanceMeters>6850.71</directDistanceMeters>
                  <directDurationSeconds>973.14</directDurationSeconds>
                  <resources>
                     <id>res2</id>
                     <totalDistanceMeters>7808.36</totalDistanceMeters>
                     <totalDurationSeconds>1197.28</totalDurationSeconds>
                     <detourDistanceMeters>957.65</detourDistanceMeters>
                     <detourDurationSeconds>224.14</detourDurationSeconds>
                     <detourOriginDistanceMeters>3684.98</detourOriginDistanceMeters>
                     <detourOriginDurationSeconds>752.34</detourOriginDurationSeconds>
                     <detourDestinationDistanceMeters>4123.38</detourDestinationDistanceMeters>
                     <detourDestinationDurationSeconds>444.94</detourDestinationDurationSeconds>
                  </resources>
                  <resources>
                     <id>res1</id>
                     <totalDistanceMeters>13714.6</totalDistanceMeters>
                     <totalDurationSeconds>2261.52</totalDurationSeconds>
                     <detourDistanceMeters>6863.89</detourDistanceMeters>
                     <detourDurationSeconds>1288.38</detourDurationSeconds>
                     <detourOriginDistanceMeters>5731.27</detourOriginDistanceMeters>
                     <detourOriginDurationSeconds>1156.94</detourOriginDurationSeconds>
                     <detourDestinationDistanceMeters>7983.33</detourDestinationDistanceMeters>
                     <detourDestinationDurationSeconds>1104.58</detourDestinationDurationSeconds>
                  </resources>
               </route>
            </routes>
            <computationTime>118.72</computationTime>
         </SearchAlongResult>
      </ns2:searchAlongV1Response>
   </soap:Body>
</soap:Envelope>

Requête

Requête 

http://<server>/<webapp>/api/lbs/searchAlong.json

Data (JSON) 

{
   "routes":[
      {
         "id":"dep",
         "departurePoint":{
            "x":-1.553927,
            "y":47.218580
         },
         "arrivalPoint":{
            "x":-1.593927,
            "y":47.188580
         }
      }
   ],
   "resources":[
      {
         "id":"res1",
         "node":"",
         "priority1":1,
         "priority2":2,
         "x":-1.511092,
         "y":47.208354
      }
   ],
   "resources":[
      {
         "id":"res2",
         "node":"",
         "priority1":1,
         "priority2":1,
         "x":-1.549524,
         "y":47.195483
      }
   ],
   "method":"time",
   "srs":"epsg:4326",
   "maxDetourDurationSeconds":-1,
   "maxDetourDistanceMeters":-1,
   "maxDetourOriginDurationSeconds":-1,
   "maxDetourOriginDistanceMeters":-1,
   "maxDetourDestinationDurationSeconds":-1,
   "maxDetourDestinationDistanceMeters":-1
}

Réponse

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

Format JSON 

{
    "message": null,
    "status": "OK",
    "routes": [
        {
            "id": "dep",
            "directDistanceMeters": 6850.71,
            "directDurationSeconds": 973.14,
            "resources": [
                {
                    "id": "res2",
                    "totalDistanceMeters": 7808.36,
                    "totalDurationSeconds": 1197.28,
                    "detourDistanceMeters": 957.65,
                    "detourDurationSeconds": 224.14,
                    "detourOriginDistanceMeters": 3684.98,
                    "detourOriginDurationSeconds": 752.34,
                    "detourDestinationDistanceMeters": 4123.38,
                    "detourDestinationDurationSeconds": 444.94
                }
            ]
        }
    ]
}

Requête

Requête 

http://<server>/<webapp>/api/lbs/searchAlong.xml

Data (XML) 

<?xml version="1.0" encoding="UTF-8"?>
<searchAlongRequest>
   <routes>
      <route>
         <id>dep</id>
         <departurePoint>
            <x>-1.553927</x>
            <y>47.21858</y>
         </departurePoint>
         <arrivalPoint>
            <x>-1.593927</x>
            <y>47.18858</y>
         </arrivalPoint>
      </route>
   </routes>
   <resources>
      <resource>
         <id>res1</id>
         <node />
         <priority1>1</priority1>
         <priority2>2</priority2>
         <x>-1.511092</x>
         <y>47.208355</y>
      </resource>
      <resource>
         <id>res2</id>
         <node />
         <priority1>1</priority1>
         <priority2>1</priority2>
         <x>-1.549524</x>
         <y>47.195484</y>
      </resource>
   </resources>
   <srs>epsg:4326</srs>
   <maxDetourDestinationDistanceMeters>-1</maxDetourDestinationDistanceMeters>
   <maxDetourDestinationDurationSeconds>-1</maxDetourDestinationDurationSeconds>
   <maxDetourDistanceMeters>-1</maxDetourDistanceMeters>
   <maxDetourDurationSeconds>-1</maxDetourDurationSeconds>
   <maxDetourOriginDistanceMeters>-1</maxDetourOriginDistanceMeters>
   <maxDetourOriginDurationSeconds>-1</maxDetourOriginDurationSeconds>
   <method>time</method>
</searchAlongRequest>

Réponse

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

Format XML 

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<searchAlongResult>
    <status>OK</status>
    <routes>
        <route>
            <id>dep</id>
            <directDistanceMeters>6850.71</directDistanceMeters>
            <directDurationSeconds>973.14</directDurationSeconds>
            <resources>
                <id>res2</id>
                <totalDistanceMeters>7808.36</totalDistanceMeters>
                <totalDurationSeconds>1197.28</totalDurationSeconds>
                <detourDistanceMeters>957.65</detourDistanceMeters>
                <detourDurationSeconds>224.14</detourDurationSeconds>
                <detourOriginDistanceMeters>3684.98</detourOriginDistanceMeters>
                <detourOriginDurationSeconds>752.34</detourOriginDurationSeconds>
                <detourDestinationDistanceMeters>4123.38</detourDestinationDistanceMeters>
                <detourDestinationDurationSeconds>444.94</detourDestinationDurationSeconds>
            </resources>
            <resources>
                <id>res1</id>
                <totalDistanceMeters>13714.6</totalDistanceMeters>
                <totalDurationSeconds>2261.52</totalDurationSeconds>
                <detourDistanceMeters>6863.89</detourDistanceMeters>
                <detourDurationSeconds>1288.38</detourDurationSeconds>
                <detourOriginDistanceMeters>5731.27</detourOriginDistanceMeters>
                <detourOriginDurationSeconds>1156.94</detourOriginDurationSeconds>
                <detourDestinationDistanceMeters>7983.33</detourDestinationDistanceMeters>
                <detourDestinationDurationSeconds>1104.58</detourDestinationDurationSeconds>
            </resources>
        </route>
    </routes>
</searchAlongResult>

Cas d’une recherche de proximité trouvée (searchAlongResult/status est OK) 

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<searchAlongResult>
    <status>OK</status>
    <routes>
        <route>
            <id>dep</id>
            <directDistanceMeters>6850.71</directDistanceMeters>
            <directDurationSeconds>973.14</directDurationSeconds>
            <resources>
                <id>res2</id>
                <totalDistanceMeters>7808.36</totalDistanceMeters>
                <totalDurationSeconds>1197.28</totalDurationSeconds>
                <detourDistanceMeters>957.65</detourDistanceMeters>
                <detourDurationSeconds>224.14</detourDurationSeconds>
                <detourOriginDistanceMeters>3684.98</detourOriginDistanceMeters>
                <detourOriginDurationSeconds>752.34</detourOriginDurationSeconds>
                <detourDestinationDistanceMeters>4123.38</detourDestinationDistanceMeters>
                <detourDestinationDurationSeconds>444.94</detourDestinationDurationSeconds>
            </resources>
            <resources>
                <id>res1</id>
                <totalDistanceMeters>13714.6</totalDistanceMeters>
                <totalDurationSeconds>2261.52</totalDurationSeconds>
                <detourDistanceMeters>6863.89</detourDistanceMeters>
                <detourDurationSeconds>1288.38</detourDurationSeconds>
                <detourOriginDistanceMeters>5731.27</detourOriginDistanceMeters>
                <detourOriginDurationSeconds>1156.94</detourOriginDurationSeconds>
                <detourDestinationDistanceMeters>7983.33</detourDestinationDistanceMeters>
                <detourDestinationDurationSeconds>1104.58</detourDestinationDurationSeconds>
            </resources>
        </route>
    </routes>
</searchAlongResult>

Cas d’un SRS incorrect 

{"message":"NullPointerException: null","status":"ERROR"}

Cas d’une absence de ressource (searchAroundResponse/status est OK) 

{"message":"Input resources list must not be null and empty!","status":"ERROR","routes":[]}

Pour les utiliser il faut passer, lors de l’appel au web service, le paramètre computeOptions avec l’option speedPattern et préciser la valeur de la Speed Pattern demandée sans omettre un profil de véhicule
Exemple :

+

&computeOptions=speedPattern:fast-speed&profileId=1