Quels paramètres puis-je passer ?

 

Le passage des paramètres au remote Control se fait par l’URL :

https://mginter.mapandguide.com/v7.10/remote/remote_control.html?<Nomparamètre1>=<valeur>&<Nomparamètre2>=<valeur> etc.

 

Remarques importantes

  • Toutes les valeurs à transférer doivent être codées sous forme d’URL. Par exemple, une espace doit être remplacée par %20. Des fonctions de codage d’URL sont disponibles dans tous les langages de programmation courants.

  • L'URL peut comporter un maximum de 32 768 caractères.

  • Toutes les valeurs à transférer par URL peuvent également être transférées dans un formulaire HTML.

  • Lorsque PTV Map&Guide internet est appelé par Remote Control, le programme s’ouvre dans sa propre fenêtre. Le blocage de pop-up doit de ce fait être désactivé dans le navigateur pour PTV Map&Guide internet.

Astuce : Tester la transmission

Vous pouvez tester la transmission des paramètres à l’aide d’un formulaire HTML.

Vous pouvez appeler la page de test à l'adresse URL suivante : https://mginter.mapandguide.com/v7.10/remote/remote_test.html

 

Remarque : Pour des raisons techniques, vous ne pouvez pas vous connecter avec le compte du super administrateur (adresse électronique) . Pour la connexion, les données d'accès d'un utilisateur créé dans l'outil d'administration sont nécessaires, par exemple "Company123.User".

 

Les paramètres suivants peuvent être transmis à Remote Control :

Données de connexion

Nom paramètre

Description/valeur

Exemple

 

login

Nom d’utilisateur (champ obligatoire) login=user
password

Mot de passe (champ obligatoire)

password=secret

language

Langue (champ obligatoire)

Ici sont transférées les dénominations de pays et de langues à utiliser lors de la connexion. Les valeurs autorisées sont les suivantes : CS, DE, EN, ES, FR, IT, NL, PL, RO, TR.

 language=EN

Paramètres de calcul d’itinéraires

Nom paramètre

Description/valeur

Exemple

remotetype=routing

Saisie obligatoire

Important : le paramètre remotetype doit être transmis avec la valeur routing. Si le paramètre manque, la transmission échoue !

remotetype=routing

action

Saisie obligatoire

Ce paramètre détermine s'il faut seulement ajouter des étapes ou s'il faut également calculer l’itinéraire.

in_stationlist = ajouter étapes

routing = ajouter étapes et calculer itinéraire

action=in_stationlist

vehicle

Nom du véhicule (facultatif)

Le nom du véhicule peut être transmis à l’aide de ce paramètre. Veuillez noter que le nom du véhicule doit être donné dans la langue dans laquelle la connexion a lieu.

Pour les véhicules de référence, par exemple en anglais RF%20truck%2040t, en espagnol Camión%20RF%2040%20t.

Remarque : En alternative au nom du véhicule, vous pouvez donner l’ ID du véhicule. C’est par exemple utile lorsque le nom du véhicule comporte des caractères spéciaux ou des espaces qui pourraient poser des problèmes avec une transmission par URL. Avec un ID de véhicule, un codage d’URL n’est pas nécessaire. L’ID du véhicule est affiché dans le cas d’application Gestion des véhicules à condition de sélectionner la colonne correspondante dans la liste des véhicules.

vehicle=RF%20truck%2040t

timestamp Définit l'heure de départ (Unix Timestamp Format). timestamp=1628150657
clearlist

Supprimer la liste des étapes (facultatif)

1: Avant d’ajouter des étapes, une liste existante d’étapes est supprimée.

0 ou non disponible : Les adresses transférées sont ajoutées à une liste d’étapes existante.

 clearlist=0

 

Étapes

Nota : Au moins une étape doit toujours être transférée ; un calcul d'itinéraires est possible à partir de deux étapes. Les étapes sont automatiquement géocodées à l’importation (voir Remarque sur le géocodage).

Les étapes sont transmises via le paramètre s<index>. <index> indique dans quel ordre les étapes vont être ajoutées à la liste des étapes, s1=1e étape, s2=2e étape, etc.

Nom paramètre

Description/valeur

Exemple
num_stations

Nombre d’étapes

Fixe le nombre d’étapes (s1 à s<n>) qui peuvent être transmises par URL.

 num_stations=4

s<index>

 

Transmission d’une étape

(voir Architecture d’une étape)

 

s1=places|town|DE|76131|Karlsruhe|Oststadt|Haid-und-Neu-Strasse|15|1|PTV%20Planung%20Transport%20Verkehr%20GmbH|937141|6270078|00:00|00:00|0|00:00|0|Snyder

Architecture d’une étape

Les champs d’une étape doivent être transmis dans l’ordre suivant :

<external layer name>|<internal layer name>|<country>|<zipCode>|<town>|<district>|<street>|<housenumber>|<id>|<comment>|<x-coordinate>|<y-coordinate>|<timewindow start>|<timewindow end>|<stay days>|<stay hours>|<station fuzzy radius>|<name>

Remarque : Si vous utilisez des coordonnées pour l'importation, elles sont utilisées en priorité pour le géocodage. Il n'y a pas de comparaison entre les coordonnées et une adresse donnée. Veillez donc à ce que les coordonnées soient correctes.

Emplacement

Champ

Description

0

external layer name

Pour des raisons de rétrocompatibilité, ces données sont nécessaires mais la valeur n'est actuellement pas exploitée.

1

internal layer name

Pour des raisons de rétrocompatibilité, ces données sont nécessaires mais la valeur n'est actuellement pas exploitée.

2

country

Saisie de l’abréviation du pays

3

zipCode

Code Postal

4

town

Localité

5

district

Sous-localité

6

street

Rue n

7

housenumber

Numéro de rue

8

id

Le transfert du paramètre id est nécessaire pour des raisons internes au programme. Une valeur transférée via id n'est pas évaluée et n'est pas non plus affichée dans le programme, le contenu du paramètre peut donc être vide.

Astuce : Si un identifiant pour l’étape doit être affiché dans le programme, vous pouvez transmettre cette valeur via le paramètre commentaire.

9

comment

Commentaire

10

x-coordinate

Coordonnées PTV Mercator

11

y-coordinate

Coordonnées PTV Mercator

12

timewindow start

Début plages horaires

13

timewindow end

Fin plages horaires

14

stay days

Temps d’arrêt en jours

15

stay hours 00:00

Temps d’arrêt en heures

16

station fuzzy radius

Saisie du rayon d’une via
17 name Indication d'un nom, par exemple le nom du client ou de l'entreprise

Paramètres d’exportation

Les résultats du calcul d'itinéraires et les étapes individuelles sont restitués au système appelant par l'intermédiaire d'un POST à une adresse URL locale, sur l'ordinateur du client.

 

 

Nom paramètre

Description/valeur

Exemple

ticketid

Dénomination unique des résultats du calcul d'itinéraires (saisie obligatoire)

Le ticketid est une chaîne de caractères unique qui permet au système externe d'attribuer de manière univoque la réponse à la requête.

En pratique, il peut s'agir du numéro d'ordre d'un système de gestion des tournées, par exemple.

ticketid=ticket0815

 
exportmode

Mode d’export (saisie obligatoire)

0= Exportation vers une URL locale sur l'ordinateur du client via un POST HTTPS

Vous pouvez saisir l’URL locale avec le paramètre exporturl.

exportmode=0

exporturl

 

URL de la restitution (saisie obligatoire)

Pour que la restitution réussisse, le système externe doit être en mesure de récupérer une réponse sur ce port. Cette réponse se compose de deux paramètres de POST : data et ticketid.

data contient le résultat du calcul d'itinéraire sous la forme d'une chaîne de caractères au format choisi, JSON ou XML.

ticketid contient quant à lui l'identifiant unique transmis par le système appelant lors de la requête.

exporturl=https://localhost:8888

exportformat

Les résultats du calcul d'itinéraires peuvent être indiqués dans les formats JSON ou XML.

 

Exemple de restitution au format XML (exportformat=xml)

 

<ExportedRoute>

<totalDistance>972291</totalDistance>

<totalCosts>114.39</totalCosts>

<cO2e>1149.75</cO2e>

<totalTime>350089</totalTime>

</ExportedRoute>

 

Exemple de restitution au format JSON (exportformat=json)

{

"totalDistance": 972291,

"totalCosts": 114.39,

"cO2e": 1149.75,

"totalTime": 350089

}

 

exportformat=json