Result Codes
There are three (3) types of Result Codes for the Drive Thru Director Reporting API:
Codes: Unexpected Enter
An Unexpected Enter occurs when a payment window or pickup window vehicle detection occurs without a valid menu board vehicle detection.
Code | Description |
|---|---|
2 | An Unexpected Enter occured at the pickup window |
3 | An Unexpected Enter occured at menu board 01 |
4 | An Unexpected Enter occured at menu board 02 |
5 | An Unexpected Enter occured at the payment window |
101 | Occurs when a vehicle detection is considered invalid because the detection's minimum length of time was not reached. Code 101 specifically designates lane 01 of the drive thru. |
102 | Occurs when a vehicle detection is considered invalid because the detection's minimum length of time was not reached. Code 102 specifically designates lane 01 of the drive thru. |
Codes: Unexpected Quit
An Unexpected Quit occurs when a vehicle detection is received at the menu board, but is not paired with a vehicle detection at the pickup window. When this occurs, the vehicle icon is removed from the Drive Thru Director display.
Code | Description |
|---|---|
1 | A Slowpoke vehicle was removed from drive thru lane 01. For more information, see Slowpoke Vehicles. |
2 | A Slowpoke vehicle was removed from drive thru lane 02. For more information, see Slowpoke Vehicles. |
32 | Occurs when an Unexpected Quit occurs after a valid vehicle detection was received at the menu board. If this code is paired with an unexpected_enter code > 0, the value indicates which drive thru segment did not receive a corresponding vehicle detection. For example, if the unexpected_enter error code = 2, the missed vehicle detection occurred at the pickup window. An unexpected_enter error code = 5 means the missed vehicle detection occured at the payment window. |
34 | Occurs when more vehicles than expected are detected in the drive thru. Drive Thru Director sets the configuration for expected vehicles at 7. |
35 | Occurs when more vehicles than expected are detected in the drive thru between the pay window and pickup window (if pay window is configured). |
100 | Occurs when a vehicle's total-time spent in the drive thru is less than the minimum allowed time. Drive Thru Director sets the configuration for minimum total-time at 15-seconds. |
200 | May occur in two ways:
When either of these instances occur, a new vehicle icon is displayed on the screen and an unexpected_enter error code = 2 is generated. |
300 | Occurs when the Drive Thru Director's configured time-zone was changed while a vehicle was active in the drive thru. |
400 | Occurs when a vehicle's total-time spent in the drive thru exceeds the maximum allowed time. This vehicle is considered "stuck" and was removed from the screen. Drive Thru Director sets the configuration for maximum total-time at 1200-seconds (20-minutes). |
402 | Occurs when a vehicle is considered stuck at the pickup window and was removed from the screen. Drive Thru Director sets the configuration for maximum pickup window time at 900-seconds (15-minutes). |
403 | Occurs when a vehicle is considered stuck at the menu board 01 and was removed from the screen. Drive Thru Director sets the configuration for maximum menu board time at 900-seconds (15-minutes). |
404 | Occurs when a vehicle is considered stuck at the menu board 02 and was removed from the screen. Drive Thru Director sets the configuration for maximum menu board time at 900-seconds (15-minutes). |
405 | Occurs when a vehicle is considered stuck at the payment window and was removed from the screen. Drive Thru Director sets the configuration for maximum payment window time at 900-seconds (15-minutes). |
410 | Occurs when a vehicle was removed from the drive thru with an error code of 400 while another vehicle was active in the drive thru. |
412 | Occurs when a vehicle was removed from the drive thru with an error code of 402 while another vehicle was active in the drive thru. |
413 | Occurs when a vehicle was removed from the drive thru with an error code of 403 while another vehicle was active in the drive thru. |
414 | Occurs when a vehicle was removed from the drive thru with an error code of 404 while another vehicle was active in the drive thru. |
415 | Occurs when a vehicle was removed from the drive thru with an error code of 405 while another vehicle was active in the drive thru. |
Codes for Errors
Errors have an associated "error_num" and an “error_message” description.
Category | Code | Description |
|---|---|---|
General | -10062 | Access denied |
-10071 | Invalid Car API version: $version | |
Business Date | -10086 | Missing "business_date" parameter |
Calendar Date | -10061 | Missing "date" parameter |
Both Date Methods | -10058 | Invalid date: $date |
-10087 | Invalid secondary date: $secondary_date | |
-10088 | The "secondary_date" ($secondary_date) must be greater than $date | |
Set Username and Password | -10094 | Missing "api_user" parameter |
-10095 | "api_user" parameter is empty | |
-10096 | Decoded "api_user" parameter is empty | |
-10097 | Missing "api_password" parameter | |
-10098 | "api_password" parameter is empty | |
-10099 | Decoded "api_password" parameter is empty |