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

Returns a list of all orders, created during the given timerange.

Description

GET get_orders.php?company=COMPANY_RTIKEY&vehicleVEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&format=json

Parameters

ParameterDescriptionTypeNoteMandatory
companyRTI company keystring
yes
vehicleRTI vehicle keystringeither vehicle, group or import parameter(yes)
groupRTI group keystringeither vehicle, group or import parameter(yes)
importRTI import keystringeither vehicle, group or import parameter(yes)
startstart of requested timerangedatestring

format: YYYYMMDDHHMMSS

  • the timerange between "start" and "end" is limited to 31 days
yes
endend of requested timerangedatestring

format: YYYYMMDDHHMMSS

  • the timerange between "start" and "end" is limited to 31 days

yes

only_ondisplay_created only return orders, created on a displayint 

order creation at display is limited to specific Display types and has to be activated seperately

  • not set or value "0": Returns all created orders
  • value "1": Returns only orders created on a display 
no 
formatoutput formatstring'csv' (default) or 'json'no

Return

Returns a string. In case of error it returns "ERROR:Description".

CSV Format

The result of a correct request will be a csv (comma seperated values) formatted file containing always a head with column names as first line. The following lines containing the single entries.

Meta informations

SeparatorSemicolon ( ; )
DelimiterDouble quote ( " )
Line break0x0D 0x0A (CarriageReturn LineFeed)
HeaderLine 1
EncodingUTF-8

Columns

Column
Description

DATE

date when order was created

Format: YYYY-MM-DD HH:MM:SS

CUSTORDERself defined order number
TEXTorder text
VEHICLEassigned vehicle
DELETED_IN_VEHICLE 

indicate, if order deleted on vehicle display

  • 0 = no
  • 1 = yes
ACTIVE 

indicate, if order is currently active

  • 0 = no
  • 1 = yes
LAST_STATE_DATE 

date of latest state change

Format: YYYY-MM-DD HH:MM:SS
LAST_STATE_TEXT state description
LAST_STATE_IDENTcustom ident (if set)
LAST_STATE_LANGcountry code, if status was selected in another language on the display 
LAST_STATE_TRANStranslation of status text, if status was selected in another language on the display 
NAV_CUSTOMER 

customer name


NAV_TEXT target adress
NAV_LAT geocoordinate for target adress (Latitude)
NAV_LON geocoordinate for target adress (Longitude) 
FORM_NAME assigned user defined form
METAmeta info
RTI_IDENTRTI Ident

JSON Format

JSON Format

[
    {
        "create_date": "2022-03-15 09:43:30",
        "custom_order_number": "ExampleNr",
        "text": "Beispieltext",
        "vehicle": {
            "name": "YT 120",
            "rtiIdent": "YT 120 Ident"
        },
        "is_deleted": false,
        "is_active": true,
        "last_state": {
            "date": "2022-03-15 09:45:44",
            "text": "start",
            "custom_id": "",
            "language": "",
            "translations": ""
        },
        "target_information": {
            "customer": "Nico@home",
            "address": "Am Wuesteberg 3, 01723 Kesselsdorf, D",
            "lat": 51.0096,
            "lon": 13.8376,
            "arrival_time_planned": "2022-03-15 16:00:00"
        },
        "form": {
            "name": "Fotos"
        },
        "meta": ""
    }
]


Example

return in csv
"DATE";"CUSTORDER";"TEXT";"VEHICLE";"DELETED_IN_VEHICLE";"ACTIVE";"LAST_STATE_DATE";"LAST_STATE_TEXT";"NAV_CUSTOMER";"NAV_TEXT";"NAV_LAT";"NAV_LON";"META";"RTI_IDENT"
"2012-12-27 14:39:00";"ORDER1";"TEXT1";"FZG1";"1";"0";"2012-12-27 13:44:44";"Auftrag im Display gelöscht";"";"";"";"";"";"Ident 1"
"2012-12-27 13:42:00";"ORDER2";"TEXT2";"FZG1";"0";"1";"2012-12-27 13:28:29";"Start";"";"";"";"";"";"Ident 1"
"2012-12-27 12:03:34";"ORDER3";"TEXT3";"FZG2";"1";"0";"2013-01-11 15:57:50";"Erledigt";"YellowFox";"D-01723 Kesselsdorf Am Wüstberg 3";"51.036307";"13.598907";"";"Ident 1"
"2012-12-27 12:03:15";"ORDER4";"TEXT4";"FZG2";"0";"1";"2012-12-27 12:04:03";"Angenommen";"YellowFox";"D-01723 Kesselsdorf Am Wüstberg 3";"51.036307";"13.598907";"";"Ident 1"

Example calls

All orders sent by or to a vehicle
https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&VEHICLE=VEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS

https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&VEHICLE={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS
All orders created on any vehicle
https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&only_ondisplay_created=1
All orders sent or created on any vehicle of the vehicle group
https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&group=IMPORT_GROUPKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS



  • No labels