order_management/get_orderstate.php
Last modified by YellowFox_RD on 2024/12/19 10:11
Table of Contents
Returns the status messages of orders.
Description
GET order_management/get_orderstate.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS
Parameters
| parameter | description | type | hint | mandatory |
|---|---|---|---|---|
| company | RTI company key | string | yes | |
| vehicle | RTI vehicle key | string | either vehicle, group or import parameter | (yes) |
| group | RTI vehicle group key (all vehicles of a group) | string | either vehicle, group or import parameter | (yes) |
| import | RTI import key (all vehicles) | string | either vehicle, group or import parameter | (yes) |
| customorderid | user-defined order number | string | either set this field or start and end | (yes)*1 |
| start | date from which to return order states | string | Format: YYYYMMDDHHMMSS | (yes)*1 |
| end | date to which to return order states | string | Format: YYYYMMDDHHMMSS The maximum time span is 7 days. | (yes)*1 |
| datetype | type of date to be used for date restriction | string | Possible values:
| no |
| format | output format | string | Possible values:
| no |
*1 mandatory is either customorderid or ( start and end )
Return value
A string will be returned. On error you will receive "ERROR:description".
CSV format
First line is the header with field names. We use a double quote as text delimiter.
Meta information
| separator | comma ( , ) |
|---|---|
| text delimiter | double quote ( " ) |
| line end | 0x0D 0x0A (CarriageReturn LineFeed) |
| header | line 1 |
Column description
| column | description | |
|---|---|---|
| CUSTORDERID | user-defined order number | |
| DATE | date of pressed state | DD.MM.YYYY HH:MM:SS |
| STATE | state text which was pressed | |
| SOURCETYPE | type of source | PND (if vehicle or RTI) or PORTAL |
| SOURCE | who triggered this action | person/system name |
| STATE_IDENT | user-defined ident of state if given | |
| STATE_LANG | country code, if the state was pressed in another language than german | |
| STATE_TRANS | translated state text, if the state was pressed in another language than german | |
| META | meta info | |
| REQUESTDATE | request date | |
| RTI_IDENT | RTI ident of vehicle |
Example
"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","STATE_IDENT","STATE_LANG","STATE_TRANS","META","REQUESTDATE","RTI_IDENT"
"Auftrag 123","18.07.2022 09:43:42","Zustellungsversuch","PORTAL","FTL YF 123","","","","","21.07.2022 06:38:50","rti123"
"Auftrag 123","18.07.2022 09:43:42","Zustellungsversuch","PORTAL","FTL YF 123","","","","","21.07.2022 06:38:50","rti123"
JSON format
Example
[
{
"gpsdate": "18.07.2022 09:43:42",
"requestdate": "21.07.2022 06:43:45",
"custom_order_id": "Auftrag 123",
"state": "Zustellungsversuch",
"state_trans": null,
"state_lang": null,
"state_ident": null,
"meta": null,
"source_type": "PORTAL",
"source": "FTL YF 123",
"rti_ident": "rti123"
}
]
{
"gpsdate": "18.07.2022 09:43:42",
"requestdate": "21.07.2022 06:43:45",
"custom_order_id": "Auftrag 123",
"state": "Zustellungsversuch",
"state_trans": null,
"state_lang": null,
"state_ident": null,
"meta": null,
"source_type": "PORTAL",
"source": "FTL YF 123",
"rti_ident": "rti123"
}
]
Possible error values
| error | description |
|---|---|
| MISSING_COMPANY | company key is missing |
| INVALID_COMPANY | Company not found. Migth be due to faulty company or import key. |
| ERROR_MAINTENANCE | Your company is under maintenance, at the moment no requests are possible. |
| INVALID_KEY(VEHICLE|GROUP|IMPORT) | The given RTI key does not match the expected structure. |
| NO_KEY_GIVEN(VEHICLE|GROUP|IMPORT) | No RTI key to identify any vehicles was given. |
| INVALID_VEHICLE_KEY / INVALID_GROUP_KEY | No vehicles which match the RTI keys were found. |
| ERROR_MISSING_CUSTORDERID|DATEFROM|DATETO | You have to set either a custom order id or start and end for a valid request, |
| ERROR_INVALID_DATEFROM | You have entered a start date, which does not match the needed format. |
| ERROR_INVALID_DATETO | You have entered an end date, which does not match the needed format. |
| ERROR_INVALID_DATERANGE | Your start and end date are either more than 7 days apart or your end date is before your start date. |
| ERROR_INVALID_FORMAT | You have entered an unknown output format. |
| ERROR_INVALID_DATE_TYPE | You have entered an unknown date type. |
| ERROR_ORDER_NOT_FOUND | Search via custom order id: No order with given order number was found. |
| ERROR_DUPLICATE_CUSTOMORDERID | Search via custom order id: Multiple orders with given order number were found. This function can only be used to gather states for orders which unique identifiers. |
Example call
JSON
https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&customorderid=Auftrag 123&format=json
https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=Auftrag 123&format=json
https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=Auftrag 123&format=json
CSV
https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&start=20220501000000&end=20220508000000&format=csv
https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20220501000000&end=20220508000000&format=csv