Versions Compared

Old Version 20

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version 21

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Funktion zur Wegoptimierung (nur für Kunden mit PTV als Kartenanbieter bzw. Kunden welche die Multi Karten Option gebucht haben)

Beschreibung

Status
colourBlue
titlePOST
 plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=points_json_array

Parameters

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring
ja
vehicleRTI Fahrzeugschlüsselstring

Es muss immer einer der Parameter vehicle, group oder import angegeben werden!

(ja)
groupRTI GruppenschlüsselstringEs muss immer einer der Parameter vehicle, group oder import angegeben werden!(ja)
import

RTI Importschlüssel (alle Fahrzeuge)

stringEs muss immer einer der Parameter vehicle, group oder import angegeben werden!(ja)
profile
  • truck
  • car
string

Standard ist "car"

nein
pointsDie Aufträge/ Anfahrtsziele welche optimiert werden sollenjson-array

Beschreibung siehe points_json_array

ja

points_json_array

ParameterBeschreibungTypHinweisPflicht

id


int
ja
latLatitude des punktesdouble

ja

lonLongitude des punktesdouble
ja
meta
string
nein
type
  • start
  • end
stringdamit kann man den Start und/oder das Ende festlegennein

Rückgabe

Es wird ein String zurückgegeben. Bei Erfolg wird als Antwort "OK" zurückgegeben. Ansonsten wird ein "ERROR:Beschreibung" zurückgegeben

JSON Format

ParameterBeschreibungTyp

id

übergebene id
int

type

"start", "end" oder ""

string

lat

Latitudefloat
lonLongitudefloat
meta
übergeben Meta Beschreibungstring


Code Block
languagejs
titleBeispiel
linenumberstrue
{
	[
	{
		"id": 1,
		"type": "start",
		"lat": 51.0311742,
		"lon": 13.6034718,
		"meta": "YF"
	},
	{
		"id": 3,
		"type": "",
		"lat": 51.042972,
		"lon": 13.794998,
		"meta": "Dresden"
	},
	{
		"id": 2,
		"type": "",
		"lat": 51.268333,
		"lon": 14.326741,
		"meta": "Neschwitz"
	},
	{
		"id": 4,
		"type": "",
		"lat": 51.305518,
		"lon": 13.295992,
		"meta": "Riesa"
	},
	{
		"id": 5,
		"type": "end",
		"lat": 51.0311742,
		"lon": 13.6034718,
		"meta": "YF"
	}
	]
}

Beispiele

Code Block
titleMit festem Start und Ende
https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"start"},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"end"}]
Code Block
titleOhne feste Punkte


https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY{"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.60347186034718,"type":"start"},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"end"}]


Code Block
titleOhne feste Punkte
https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718}]

https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718}]


Code Block
titleMit festem Startpunkt
https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"start"},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718}]

https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"start"},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718}]


Code Block
titleMit festem StartpunktEndpunkt
https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"start"},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718}]
Code Block
titleMit festem Endpunkt
,"type":"end"}]

https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY{"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"end"}]

Fehler

FehlerBeschreibung
ERROR:PTV_OR_MULTI_MAP_IS_REQUIREDSie brauchen PTV als Kartenanbieter bzw. die kostenpflichtige Option "Mulit Karte", bitte wenden Sie sich an unseren Vertrieb
ERROR:NO_CAR_IN_MIN_BUSINESS_TARIFFEs muss mind. 1 Fahrzeug einen Business Tarif oder höher haben
ERROR:NOT_POINTS_GIVENKeine Punkte übergeben
ERROR:INVALID_POINTSEs ist kein Array an Punkten



Sv translation
languageen

Route optimization function (only for customers with PTV as map provider or customers who have booked the Multi Map Option)

Beschreibung

Status
colourBlue
titlePOST
 plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=points_json_array

Parameters

ParameterDescription TypeNotesMandatory
companyRTI Company keystring
Yes
vehicleRTI Vehicle keystring

One of the parameters vehicle, group or import must always be given!

(Yes)
groupRTI Group keystringOne of the parameters vehicle, group or import must always be given!(Yes)
import

RTI Import key (All vehicles)

stringOne of the parameters vehicle, group or import must always be given!(Yes)
profile
  • truck
  • car
string

Standard is "car"

No
pointsThe orders / destinations which should be optimizedjson-array

See description "points_json_array"

Yes

points_json_array


ParameterDescription TypeNotesMandatory

id


int
Yes
latLatitude of the pointdouble

Yes

lonLongitude of the pointdouble
Yes
meta
string
No
type
  • start
  • end
stringwith this you can set the start and/or the end of the tourNo


Return 

A string is returned. If successful, "OK" is returned as response. Otherwise an "ERROR:Description" is returned.

JSON Format

ParameterDescription Type

id

passed id
int

type

"start", "end" oder ""

string

lat

Latitudefloat
lonLongitudefloat
meta
passed Meta Description string


Code Block
languagejs
titleexample
linenumberstrue
{
	[
	{
		"id": 1,
		"type": "start",
		"lat": 51.0311742,
		"lon": 13.6034718,
		"meta": "YF"
	},
	{
		"id": 3,
		"type": "",
		"lat": 51.042972,
		"lon": 13.794998,
		"meta": "Dresden"
	},
	{
		"id": 2,
		"type": "",
		"lat": 51.268333,
		"lon": 14.326741,
		"meta": "Neschwitz"
	},
	{
		"id": 4,
		"type": "",
		"lat": 51.305518,
		"lon": 13.295992,
		"meta": "Riesa"
	},
	{
		"id": 5,
		"type": "end",
		"lat": 51.0311742,
		"lon": 13.6034718,
		"meta": "YF"
	}
	]
}



Example

Code Block
titlewith fixed start and end
https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"start"},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"end"}]


Code Block
titlewithout fixed points
https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718}]


Code Block
titlewith fixed starting point
https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"start"},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718}]


Code Block
titlewith fixed ending point
https://map.yellowfox.de/rti/plan_sequence.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&profile=truck&points=[{"id":1,"meta":"YF","lat":51.0311742,"lon":13.6034718},{"id":2,"meta":"Neschwitz","lat":51.268333,"lon":14.326741},{"id":3,"meta":"Dresden","lat":51.042972,"lon":13.794998},{"id":4,"meta":"Riesa","lat":51.305518,"lon":13.295992},{"id":5,"meta":"YF","lat":51.0311742,"lon":13.6034718,"type":"end"}]

Error

ErrorDescription 
ERROR:PTV_OR_MULTI_MAP_IS_REQUIREDYou need PTV as a card provider or the paid option "multi card", please contact our sales department
ERROR:NO_CAR_IN_MIN_BUSINESS_TARIFFAt least 1 vehicle must have a business tariff or higher
ERROR:NOT_POINTS_GIVENNo points passed
ERROR:INVALID_POINTSIt is not an array of points