Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageen

Management of vehicle group assignments.

Assign a single vehicle to a vehicle group or remove it from there.

Description

Status
colourGreen
titleGET
vehicle_groups/manage_assignments.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&group=GROUP_RTIKEY&task=assign

Parameter

ParameterDescriptionTypeNoteMandatory
companyRTI company keystring

yes

vehicleRTI vehicle keystring
yes
groupRTI group keystring
yes
taskorder to assign or removestring

Possible values:

  • assign
  • remove
yes

Return

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


Possible error values

errordescription
MISSING_COMPANY company key is missing
INVALID_COMPANYCompany not found. Company key or import key might be faulty.
ERROR_MAINTENANCEYour company is under maintenance, no RTI request are possible at the moment.
MISSING_GROUPgroup key is missing
INVALID_GROUP_KEYgroup key does not match any group
MISSING_TASKno task given
MISSING_VEHICLEvehicle key is missing
INVALID_KEY(VEHICLE|GROUP|IMPORT)vehicle key does not match structure of a rti key
INVALID_VEHICLE_KEYvehicle key does not match any vehicle
CAR_ALREADY_IN_GROUPvehicle is already in given group
CAR_IS_NOT_IN_GROUPvehicle is not in given group
UNKNOWN_TASK([TASK])task has an invalid value
ERROR_WHILE_[TASK]error while saving assignment


Example calls

Code Block
titleAssign a vehicle to a group
https://map.yellowfox.de/rti/vehicle_groups/manage_assignments.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&group=GROUP_RTIKEY&task=assign

https://map.yellowfox.de/rti/vehicle_groups/manage_assignments.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&group=GROUP_RTIKEY&task=assign