get_cars.php

Last modified by YellowFox_RD on 2025/04/22 11:13

Table of Contents

Shows a list of cars which are affected by a RTI request.

Description

GET get_cars.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY

Parameter

ParameterDescriptionTypNoteMandatory
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)
formatOutput formatstringcsv or json, default: csvno

Return

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

CSV

Meta informations

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

Columns

ColumnDescriptionNote
CARNAMEname of the vehicle 
IDENTRTI Ident Is a key, that is defined by the user in the portal and can change.
COSTCENTERcost center of the vehicle 
VEHICLEGROUPSgroup of vehicles 
KMCORRECTIONFACTORkm correction factor 
VEHICLEVINchassis number (VIN) 
VEHICLEIDENTvehicle identIs a unique key defined by YellowFox which will never change. You can use to identify the vehicle.
VEHICLEDESCRIPTIONvehicle description 

Example

Return in CSV
"CARNAME";"IDENT";"COSTCENTER";"VEHICLEGROUPS";"KMCORRECTIONFACTOR";"VEHICLEVIN";"VEHICLEIDENT";"VEHICLEDESCRIPTION"
"CAR1";"IDENT1";"COSTCENTER1";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"1DB69T687HT";"35fdebee00dfa3278fa88c54cd7f8c2f";"Transporter"
"CAR2";"IDENT2";"COSTCENTER2";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3DB69T687HT";"45fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 2"
"CAR3";"IDENT3";"COSTCENTER3";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"5DB69T687HT";"49fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 3"
"CAR4";"IDENT4";"COSTCENTER4";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3UO69T687HT";"98fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 4"
"CAR5";"IDENT5";"COSTCENTER5";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3DB697487HT";"4ff7debee00dfa3278fa88c54cd7f8c2f";"Transporter 5"
"CAR6";"IDENT6";"COSTCENTER6";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"";"526debee00dfa3278fa88c54cd7f8c2f";"Kranwagen"

JSON

[
  {
     "vehicle_sign": "FTL YF 123",
     "rti_ident": null,
     "tracking_mode": "IntelligentLocating",
     "tracking_interval": 0,
     "supported_modes": [
        "CourseChange",
        "IntelligentLocating",
        "DistanceInterval",
        "MinuteInterval"
       ],
       "vehicle_groups": [
           {
               "name": "gruppe1"
           },
           {
               "name": "gruppe2"
           }
     ],
     "km_correction":1,
     "vehicle_vin": "1DB69T6847HT",
     "vehicle_ident": "35fdebee00dfa3278fa88c54cd7f8c2f",
     "vehicle_description": "Transporter"
  }
]

Example Calls

Name of one vehicle
https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY

https:
//map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_RTIIDENT"}

Returns all cars of a group
https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY

All cars, which are requestable over the RTI
https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY