vehicle_groups/manage_assignments.php
Last modified by YellowFox_RD on 2024/12/19 10:11
Table of Contents
Management of vehicle group assignments.
Assign a single vehicle to a vehicle group or remove it from there.
Description
GET vehicle_groups/manage_assignments.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&group=GROUP_RTIKEY&task=assign
Parameter
| Parameter | Description | Type | Note | Mandatory |
|---|---|---|---|---|
| company | RTI company key | string | yes | |
| vehicle | RTI vehicle key | string | yes | |
| group | RTI group key | string | yes | |
| task | order to assign or remove | string | Possible values:
| yes |
Return
A string will be returned. If the request was successful "OK". If the request failed "ERROR:Description".
Possible error values
| error | description |
|---|---|
| MISSING_COMPANY | company key is missing |
| INVALID_COMPANY | Company not found. Company key or import key might be faulty. |
| ERROR_MAINTENANCE | Your company is under maintenance, no RTI request are possible at the moment. |
| MISSING_GROUP | group key is missing |
| INVALID_GROUP_KEY | group key does not match any group |
| MISSING_TASK | no task given |
| MISSING_VEHICLE | vehicle key is missing |
| INVALID_KEY(VEHICLE|GROUP|IMPORT) | vehicle key does not match structure of a rti key |
| INVALID_VEHICLE_KEY | vehicle key does not match any vehicle |
| CAR_ALREADY_IN_GROUP | vehicle is already in given group |
| CAR_IS_NOT_IN_GROUP | vehicle is not in given group |
| UNKNOWN_TASK([TASK]) | task has an invalid value |
| ERROR_WHILE_[TASK] | error while saving assignment |
Example calls
Assign 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