Welche Parameter kann ich übergeben?
Die Übergabe der Parameter an Remote Control erfolgt über die URL:
https://mginter.mapandguide.com/v7.10/remote/remote_control.html?<Parametername1>=<Wert>&<Parametername2>=<Wert> usw.
Wichtige Hinweise
-
Alle Werte die übergeben werden, müssen URL-codiert sein. Beispielsweise muss ein Leerzeichen durch %20 ersetzt werden. Funktionen zur URL-Codierung sind in allen gängigen Programmiersprachen vorhanden.
-
Die URL darf maximal 32.768 Zeichen lang sein.
-
Alle Werte, die über URL übergeben werden, können auch in einem HTML-Formular übergeben werden.
-
Wenn PTV Map&Guide internet über Remote Control aufgerufen wird, öffnet sich das Programm in einem eigenen Fenster. In den Einstellungen des Browsers muss daher der Popup-Blocker für PTV Map&Guide internet deaktiviert sein.
-
Der aufrufende Webserver muss auf https eingestellt sein.
Tipp: Übergabe testen
Sie können die Übergabe der Parameter über ein HTML-Formular testen.
Die Testseite rufen Sie über folgende URL auf: https://mginter.mapandguide.com/v7.10/remote/remote_test.html
Hinweis: Aus technischen Gründen können Sie sich nicht mit der E-Mail-Adresse des Super-Administrators anmelden . Für die Anmeldung werden die Zugangsdaten eines im Administrationstool angelegten Benutzers benötigt, beispielsweise "Company123.User".
Folgende Parameter können an Remote Control übergeben werden:
Anmeldedaten
|
Parametername |
Beschreibung / Werte |
Beispiel
|
|---|---|---|
|
login |
Benutzername (Pflichtangabe) |
login=user |
| password |
Passwort (Pflichtangabe) |
password=secret |
| language |
Sprache (Pflichtangabe) Hier wird das Länderkürzel der Sprache übergeben, mit der die Anmeldung erfolgen soll. |
language=EN |
Routingparameter
|
Parametername |
Beschreibung / Werte |
Beispiel |
|---|---|---|
|
remotetype=routing |
Pflichtangabe Wichtig: Der Parameter remotetype muss mit dem Wert routing übergeben werden. Fehlt der Parameter, schlägt die Übergabe fehl! |
remotetype=routing |
|
action |
Pflichtangabe Dieser Parameter legt fest, welche ob nur Stationen eingefügt werden oder ob zusätzlich die Route berechnet wird.
in_stationlist = Stationen einfügen
routing = Stationen einfügen und Route berechnen |
action=in_stationlist |
|
vehicle |
Fahrzeugname (optional) Über diesen Parameter kann ein Fahrzeugname übergeben werden. Bitte beachten Sie, dass der Fahrzeugname in der Sprache übergeben werden muss, in der die Anmeldung erfolgt. Bei Referenzfahrzeugen im Englischen beispielsweise RF%20truck%2040t, im Spanischen beispielsweise Camión%20RF%2040%20t. Hinweis: Alternativ zum Fahrzeugnamen können Sie die Fahrzeug ID übergeben. Dies ist beispielsweise nützlich, wenn der Fahrzeugname Sonderzeichen oder Leerzeichen enthält, die Probleme bei der URL-Übergabe bereiten. Bei Verwendung der Fahrzeug ID ist keine URL-Codierung notwendig. Die Fahrzeug ID wird im Anwendungsfall Fahrzeugverwaltung angezeigt, indem Sie die entsprechende Spalte in der Liste der Fahrzeuge einblenden. |
vehicle=RF%20truck%2040t |
| timestamp | Legt die Abfahrtszeit fest (Unix Timestamp Format). | timestamp=1628150657 |
| clearlist |
Stationsliste löschen (optional) 1: Vor dem Einfügen von Stationen wird eine vorhandene Stationsliste gelöscht. 0 oder nicht vorhanden: Die übergebenen Adressen werden an eine bestehende Stationsliste angehängt. |
clearlist=0
|
Stationen
Hinweise: Mindestens eine Station muss immer übergeben werden, eine Routenberechnung ist ab zwei Stationen möglich. Stationen werden beim Import automatisch geokodiert (siehe Hinweis zur Geokodierung).
Wie viele Stationen Sie übergeben können, ist abhängig von der Länge der URL, die der Browser verarbeiten kann. .
Stationen werden über den Parameter s<index> übergeben. <index> gibt an, in welcher Reihenfolge die Stationen in die Stationsliste eingefügt werden, s1=1. Station, s2=2.Station, usw.
|
Parametername |
Beschreibung / Werte |
Beispiel |
|---|---|---|
| num_stations |
Anzahl der Stationen Legt die Anzahl der Stationen (s1 bis s<n>) fest, die per URL übergeben werden. |
num_stations=4 |
|
s<index>
|
Übergabe einer Station (siehe Aufbau einer Station)
|
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 |
Aufbau einer Station
Die Felder einer Station müssen in folgender Reihenfolge übergeben werden:
<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>
Hinweis: Wenn Sie beim Import Koordinaten verwenden, werden diese vorrangig zur Geokodierung verwendet. Ein Abgleich zwischen den Koordinaten und einer angegebenen Adresse findet nicht statt. Achten Sie daher darauf, dass die Koordinaten korrekt sind.
|
Stelle |
Feld |
Beschreibung |
|---|---|---|
|
0 |
external layer name |
Angabe ist aus Gründen der Abwärtskompatibilität erforderlich, der Wert wird derzeit nicht ausgewertet. |
|
1 |
internal layer name |
Angabe ist aus Gründen der Abwärtskompatibilität erforderlich, der Wert wird derzeit nicht ausgewertet. |
|
2 |
country |
Angabe Länderkürzel |
|
3 |
zipCode |
Postleitzahl |
|
4 |
town |
Ort |
|
5 |
district |
Teilort |
|
6 |
street |
Straße |
|
7 |
housenumber |
Hausnummer |
|
8 |
id |
Die Übergabe des Parameters id ist aus programminternen Gründen erforderlich. Tipp: Wenn im Programm eine Kennung zu der Station angezeigt werden soll, können Sie diesen Wert über den Parameter comment übergeben. |
|
9 |
comment |
Kommentar |
|
10 |
x-coordinate |
Koordinate im PTV Mercator Format oder WGS84 (Dezimal) |
|
11 |
y-coordinate |
Koordinate im PTV Mercator Format oder WGS84 (Dezimal) |
|
12 |
timewindow start |
Zeitfenster Start |
|
13 |
timewindow end |
Zeitfenster Ende |
|
14 |
stay days |
Aufenthaltszeit in Tagen |
|
15 |
stay hours 00:00 |
Aufenthaltszeit in Stunden |
|
16 |
station fuzzy radius |
Angabe des Umkreises bei einer Viastation |
| 17 | name | Angabe eines Namens, beispielsweise Kunden- oder Firmenname |
Exportparameter
Die Ergebnisse der Routenberechnung und die einzelnen Stationen werden an das aufrufende System über einen POST an eine lokale URL auf dem Clientrechner zurückgegeben.
|
Parametername |
Beschreibung / Werte |
Beispiel |
|---|---|---|
|
ticketid |
Eindeutige Benennung des Routingergebnisses (Pflichtangabe) Die Ticketid ist eine eindeutige Zeichenkette, über welche das aufrufende Fremdsystem die Antwort eindeutig der Anfrage zuordnen kann. In der Praxis könnte dies beispielsweise die Auftragsnummer eines Tourenmanagementsystems sein. |
ticketid=ticket0815
|
| exportmode |
Exportmodus (Pflichtangabe) 0=Export über einen HTTPS POST an eine URL Die URL können Sie über den Parameter exporturl angeben. |
exportmode=0
|
|
exporturl
|
URL der Rückgabe Pflichtangabe Damit die Rückgabe funktioniert, muss der aufrufende Webserver auf https eingestellt sein und in der Lage sein, auf diesem Port eine Antwort entgegennehmen zu können. Die Antwort besteht aus zwei POST-Parametern: data und ticketid. data beinhaltet das Routingergebnis als Zeichenkette im ausgewählten Format JSON oder XML. ticketid beinhaltet die eindeutige Kennung, die von dem aufrufenden System bei der Anfrage übergeben wurde. |
exporturl=https://localhost:8888 |
|
exportformat |
Die Ergebnisse der Routenberechnung können im JSON-Format oder XML-Format ausgegeben werden.
Beispiel für die Rückgabe im XML-Format (exportformat=xml)
<ExportedRoute> <totalDistance>972291</totalDistance> <totalCosts>114.39</totalCosts> <cO2e>1149.75</cO2e> <totalTime>350089</totalTime> </ExportedRoute>
Beispiel für die Rückgabe im JSON-Format (exportformat=json) { "totalDistance": 972291, "totalCosts": 114.39, "cO2e": 1149.75, "totalTime": 350089 }
|
exportformat=json |