Welke parameters kan ik overdragen?

 

De parameters worden via de URL aan Remote Control overgedragen:

https://inter.tlnplanner.nl/V9.3/remote/remote_control.html?<Parameternaam1>=<Waarde>&<Parameternaam2>=<Waarde>, enz.

 

Belangrijke opmerkingen

  • Alle waarden die worden overgedragen, moeten een URL-code hebben. Zo moet bijvoorbeeld een spatie worden vervangen door %20. Functies voor URL-codering zijn in alle gangbare programmeertalen beschikbaar.

  • De URL mag maximaal 32.768 tekens lang zijn.

  • Alle waarden die via de URL worden overgedragen, kunnen ook met behulp van een HTML-formulier worden overgedragen.

  • Als TLNplanner internet via Remote Control wordt opgeroepen, wordt het programma in een afzonderlijk venster geopend. De pop-upblokkering voor TLNplanner internet moet daarom in de browserinstellingen worden uitgeschakeld.

Tip: Overdracht testen

U kunt de overdracht van parameters met behulp van een HTML-formulier testen.

U kunt de testpagina via de volgende URL oproepen: https://inter.tlnplanner.nl/V9.3/remote/remote_test.html

 

Opmerking: Om technische redenen kunt u zich niet aanmelden met de super administrator account (emailadres) . Voor het inloggen zijn de toegangsgegevens nodig van een gebruiker die in de administratietool is aangemaakt, bijvoorbeeld "Company123.User".

 

De volgende parameters kunnen aan Remote Control worden overgedragen:

Logingegevens

Parameternaam

Beschrijving / Waarden

Voorbeeld

 

login

Gebruikersnaam (verplicht veld) login=user
password

Wachtwoord (verplicht veld)

password=secret

language

Taal (verplicht veld)

Hier wordt de afkorting voor een land weergegeven om aan te geven met welke taal het inloggen moet plaatsvinden. Toegestane waarden zijn: CS, DE, EN, ES, FR, IT, NL, PL, TR.

 language=EN

Routingparameters

Parameternaam

Beschrijving / Waarden

Voorbeeld

remotetype=routing

verplicht veld

Belangrijk: De parameter remotetype moet met de waarde routing worden overgedragen. Als de parameter ontbreekt, mislukt de overdracht!

remotetype=routing

action

verplicht veld

Deze parameter bepaalt of alleen routepunten worden toegevoegd of dat de route extra wordt berekend.

in_stationlist = routepunten invoegen

routing = routepunten invoegen en route berekenen

action=in_stationlist

vehicle

Voertuignaam (optioneel)

Deze parameter kan worden gebruikt om een voertuignaam over te dragen. Houd er rekening mee dat de voertuignaam moet worden overgedragen in de taal waarin de login is gedaan.

Voor referentievoertuigen in het Engels bijvoorbeeld 12T%20city%20distribution, in het Spaans bijvoorbeeld 12T%20Distribución%20urbana.

Opmerking: Als alternatief voor de voertuignaam kunt u de voertuig-ID overdragen. Dit is bijvoorbeeld handig als de voertuignaam speciale tekens of spaties bevat die problemen veroorzaken bij het overdragen van URL's. Als de voertuig-ID wordt gebruikt, is er geen URL-codering vereist. De voertuig-ID wordt in de toepassing Voertuigbeheer weergegeven door de betreffende kolom in de lijst met voertuigen weer te geven.

vehicle=12T%20city%20distribution

timestamp Stelt de vertrektijd in (Unix Timestamp Format). timestamp=1628150657
clearlist

Routepuntlijst wissen (optioneel)

1: Voorafgaand aan het toevoegen van routepunten wordt een bestaande routepuntlijst verwijderd.

0 of niet beschikbaar: De overgedragen adressen worden aan een bestaande routepuntlijst toegevoegd.

 clearlist=0

 

Routepunten

Opmerkingen: Er moet altijd minimaal één routepunt worden overgedragen. Vanaf twee routepunten is een routeberekening mogelijk. Tijdens de import worden automatisch routepunten gegeocodeerd (zie Aanwijzing over geocodering).

Via de parameter s<index> worden routepunten overgedragen. <index> geeft de volgorde aan waarin de routepunten in de routepuntlijst zijn opgenomen., s1=1e routepunt, s2=2e routepunt enz.

Parameternaam

Beschrijving / Waarden

Voorbeeld
num_stations

Aantal routepunten

Definieert het aantal routepunten (s1 t/m s<n>) die via de URL worden overgedragen.

 num_stations=4

s<index>

 

Overdracht van een routepunt

(zie Opbouw van een routepunt)

 

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

Opbouw van een routepunt

De velden van een routepunt moeten in de volgende volgorde worden overgedragen:

<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>

Opmerking: Als u bij het importeren coördinaten gebruikt, worden deze met voorrang gebruikt voor de geocodering. De coördinaten en een aangegeven adres worden niet op elkaar afgestemd. Let erop dat de coördinaten correct zijn.

 

Cijfer

Veld

Beschrijving

0

external layer name

Vermelding is vanwege neerwaartse compatibiliteit nodig; de waarde wordt momenteel niet geanalyseerd.

1

internal layer name

Vermelding is vanwege neerwaartse compatibiliteit nodig; de waarde wordt momenteel niet geanalyseerd.

2

country

Weergave van afkortingen voor landen

3

zipCode

Postcode

4

town

Plaats

5

district

Stadsdeel

6

street

Straat

7

housenumber

Huisnummer

8

id

De overdracht van de parameter id is noodzakelijk om interne programmatechnische redenen.

Een waarde die via de id wordt doorgegeven, wordt niet geëvalueerd en ook niet in het programma weergegeven; de inhoud van de parameter kan dus leeg zijn.

Tip: Indien een aanduiding voor de routepunt in het programma moet worden weergegeven, kunt u deze waarde doorgeven via de parameter comment.

9

comment

Opmerking

10

x-coordinate

Coördinaten in PTV Mercator-formaat of WGS84 (decimaal)

11

y-coordinate

Coördinaten in PTV Mercator-formaat of WGS84 (decimaal)

12

timewindow start

Start tijdvenster

13

timewindow end

Einde tijdvenster

14

stay days

Verblijfstijd in dagen

15

stay hours 00:00

Verblijfstijd in uren

16

station fuzzy radius

Weergave van de omtrek bij een viapunt
17 name Weergave van een naam, bijvoorbeeld klant- of bedrijfsnaam

Exportparameter

De resultaten van de routeberekening en de afzonderlijke routepunten worden via een POST aan een lokale URL op de clientcomputer teruggegeven.

 

 

Parameternaam

Beschrijving / Waarden

Voorbeeld

ticketid

Eenduidige naam van de routingresultaten (verplicht veld)

De Ticketid is een eenduidige reeks tekens aan de hand waarvan het oproepende externe systeem het antwoord eenduidig aan de aanvraag kan toewijzen.

In de praktijk zou dit bijvoorbeeld het opdrachtnummer van een rittenmanagementsysteem kunnen zijn.

ticketid=ticket0815

 
exportmode

Exportmodus (verplicht veld)

0=export via een HTTPS-POST naar een URL

U kunt de URL via de parameter exporturl specificeren.

exportmode=0

 

exporturl

 

URL van de teruggave (verplicht veld)

Om te zorgen dat de teruggave werkt, moet de oproepende webserver zijn ingesteld op https en in staat zijn op deze poort een antwoord te ontvangen. Het antwoord bestaat uit twee POST-parameters: data en ticketid.

data bevat het routingresultaat als tekenreeks in het geselecteerde formaat JSON of XML.

ticketid bevat het eenduidige kenmerk dat door het oproepende systeem bij de aanvraag is overgedragen.

exporturl=https://localhost:8888

exportformat

De resultaten van de routeberekening kunnen in JSON-formaat of XML-formaat worden uitgevoerd.

 

Voorbeeld van de teruggave in XML-formaat (exportformat=xml)

 

<ExportedRoute>

<totalDistance>972291</totalDistance>

<totalCosts>114.39</totalCosts>

<cO2e>1149.75</cO2e>

<totalTime>350089</totalTime>

</ExportedRoute>

 

Voorbeeld van de teruggave in JSON-formaat (exportformat=json)

{

"totalDistance": 972291,

"totalCosts": 114.39,

"cO2e": 1149.75,

"totalTime": 350089

}

 

exportformat=json