Page tree
Skip to end of metadata
Go to start of metadata

Ceates a order and sends it to the vehicle.

Description

POST do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR123XYZ&ordertext=Auftragstext&lat=51.0374&lon=13.587813

Parameter

ParameterDescriptionTypeNoteMandatory
companyRTI company keystring
yes
customorderidown order numberstringmax. 20 chars (will not be checked for duplicates)

yes

ordertextorder textstring

max. 500 chars (CE Display, Tablet)

max. 200 chars (all other displays)

yes
vehicleRTI vehicle keystring
yes
latLatitude of navigation targetfloat-90 to +90 in WGS84 format yes for Garmin displays
lonLongitude of navigation targetfloat-180 to +180 in WGS84 format yes for Garmin displays
streetstreet name of navigation targetstringmax. 100 chars (reduces the max char count of order text for garmin displays)no
hnrhouse number of navigation targetstringmax. 10 chars (reduces the max char count of order text for garmin displays)no
zipcodezipcode of navigation targetstringmax. 10 chars (reduces the max char count of order text for garmin displays)no
citycity of navigation targetstringmax. 100 chars (reduces the max char count of order text for garmin displays)no
countrycountry code of navigation targetstringmax. 3 chars (reduces the max char count of order text for garmin displays)no
customername1Customer Name 1stringmax. 100 chars (will be displayed only on Fleet V3)no
customername2Customer Name 2stringmax. 100 chars (will be displayed only on Fleet V3)no
target_timetarget arrival timedatestring

Format: YYYYMMDDHHMM

reduces maximum char count of order text down by 18 chars

no
sortnumbersort numberint

Will be written in front of the order text in brackets. Reduces the max char count of order text + 2 chars.

no
formname

name of customer formular which will be opened after conclusion of the order

string

max. 20 chars (available for CE Displays at Version 1.1.67 and Tablets)

Attention

Form must be configured!

no
textlayout

layout of order text at display

(only available for Garmin FMI displays)

int
  • 0 = [sort number][addresstext][target time]order text (default)
  • 1 = [sort number]order text[addresstext][target time ] (only for Garmin FMI displays)
  • 2 = [sort number][target time][addresstext]order text(only for Garmin FMI displays)

Attention

sort number, order text and target time must be given if these values should be transmitted

no
save_in_poolSaves the order only in the order pool and does not send it to a vehicle.int

0 = is not stored in the order pool and requires a vehicle

1 = is stored in the order pool, vehicle key is not required, but the import key is

no
metameta infostringThis info will be returned on accessing the order via get_orders.php to be able to track this order.no
attachmentsfile attachmentsstring

UUIDs of desired file attachments, comma-separated

You get these UUIDs while uploading a file via file_storage/upload_file.php or you can access them via file_storage/get_overview.php

no

Return

A string string will be returned. If the request was successful "OK". If the request failed "ERROR:Description".

Example calls

Simple order
https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR1234&ordertext=Auftragstext

https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=NR1234&ordertext=Auftragstext
Example with navigation target and target time
https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR1234&ordertext=Auftragstext&lat=51.0374&lon=13.587813&street=Hauptstr&hnr=3&zipcode=01723&city=Kesselsdorf&country=D&target_time=201411310800

https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=NR1234&ordertext=Auftragstext&lat=51.0374&lon=13.587813&street=Hauptstr&hnr=3&zipcode=01723&city=Kesselsdorf&country=D&target_time=201411310800
Example with navigation target + form + sort number + textlayout
https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=NR1234&ordertext=Auftragstext&lat=51.0374&lon=13.587813&street=Hauptstr&hnr=3&zipcode=01723&city=Kesselsdorf&country=D&sortnumber=1&formname=Abholung&textlayout=2

https://map.yellowfox.de/rti/do_order.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=NR1234&ordertext=Auftragstext&lat=51.0374&lon=13.587813&street=Hauptstr&hnr=3&zipcode=01723&city=Kesselsdorf&country=D&sortnumber=1&formname=Abholung&textlayout=2
  • No labels