Introduction
The eTIR internation system is based on web services that are exchanged between the different stakeholders. The messages exchanged using these web services are specified and used according to the rules detailed in the eTIR Specifications. When the eTIR internation system receives and processes a message, it performs a series of validation on the message itself, on the context of related guarantee, holder or transport and issues a response to the system which has sent the message in the first place. If anything goes wrong during these validation and processing steps, an error is sent back in the reponse. This error is presented as an Error code with a Pointer which can be used to point towards a specific field of the message. The list of all error codes is available in the Code List 99 and is also reproduced on this page for ease of reference, and as a living document, representing the latest version of these codes.
Specifications of the Error Codes
- This list of error codes is specific to eTIR as it allows IT teams to better understand errors while implementing the interconnection to the eTIR international system. This should result in a faster implementation overall and more accurate responses to errors from the system sending messages to the eTIR international system.
- Furthermore, a detailed error code system will also greatly simplify the communication between the stakeholders and the Help Desk of the TIR Secretariat, in case of issue, to identify and correct the underlying problem.
- The list of error codes is based on best practices from the IT industry. Like the list of HTTP status codes, all error codes have three digits, and the first digit of the status code defines the class of response:
- 1XX - Validation: validation of the message and if its parameters
- 2XX - Workflow: workflow related problems
- 3XX - Functional: other functional problems
- 4XX - Internal: eTIR international system internal problems
- Each class of response has a default error code which indicates at least the class of the error if it cannot be more precise.
List of error codes
1XX - Validation
| Error code | Error name | Description | Pointer is set to | Observations |
|---|---|---|---|---|
| Invalid Message | The message is invalid and no additional details are available for this error | Root of the message | This is the default error code for this class | |
| Missing Parameter | A required parameter is missing in the message | The pointer is set to the missing parameter | All requests | |
| Invalid Domain Value Parameter | A parameter value is out of a defined list of acceptable values | The pointer is set to the invalid parameter | All requests | |
| Malformed Date | A parameter containing a date information cannot be properly converted | The pointer is set to the invalid parameter | I7/I8, I9/I10, I11/I12, I13/I14, E1/E2, E9/E10 | |
| Not an integer | A numeric field is containing data that is not numeric | The pointer is set to the invalid parameter | I7/I8, E9/E10 | |
| Parameter length exceeded | A String field contains too many characters | The pointer is set to the invalid parameter | All requests | |
| Condition C001 failure | The condition C001 is not satisfied | The pointer is set to the invalid parameter | I7/I8, E9/E10 | |
| Condition C002 failure | The condition C002 is not satisfied | The pointer is set to the invalid parameter | I7/I8, E9/E10 | |
| Condition C003 failure | The condition C003 is not satisfied | The pointer is set to the invalid parameter | I7/I8, E9/E10 | |
| Condition C004 failure | The condition C004 is not satisfied | The pointer is set to the invalid parameter | I7/I8, E9/E10 | |
| Condition C005 failure | The condition C005 is not satisfied | The pointer is set to the invalid parameter | I7/I8, E9/E10 | |
| Condition C008 failure | The condition C008 is not satisfied | The pointer is set to the invalid parameter | I7/I8, E9/E10, E11/E12 | |
| Rule R008 failure | The rule R008 is not satisfied | The pointer is set to the invalid parameter | I7/I8 |
2XX - Workflow
| Error code | Error name | Description | Pointer is set to | Observations |
|---|---|---|---|---|
| Invalid State | The state of an internal object is invalid and no additional details are available for this error | Root of the message | This is the default error code for this class | |
| Guarantee not acceptable | The guarantee is not in a state that allow to accept it | Root of the message | I1/I2, I9/I10 | |
| Guarantee not cancellable | The guarantee is not in a state that allow to cancel it | Root of the message | E3/E4 | |
| Guarantee already registered | The guarantee has already been registered | Root of the message | E1/E2 | |
| Guarantee already cancelled | The guarantee is already cancelled or the request to cancel it has already been sent | Root of the message | E3/E4 | |
| Operation already started | The operation is already started | Root of the message | I9/I10 | |
| Operation already terminated | The operation has already been completed | Root of the message | I11/I12 | |
| Operation already discharged | The operation is already discharged | Root of the message | I13/I14 | |
| Operation not yet started | The operation is not yet started | Root of the message | I11/I12, I13/I14 | |
| Declaration not yet received | The operation cannot be started because the declaration was not received | Root of the message | I9/I10 | |
| Duplicate message | The same message was already received from the same source | Root of the message | I9/I10, I11/I12, I13/I14 |
3XX - Technical errors
| Error code | Error name | Description | Pointer is set to | Observations |
|---|---|---|---|---|
| Invalid Operation | An invalid operation was performed and no additional details are available for this error | Root of the message | This is the default error code for this class | |
| Guarantee not found | The guarantee was not found in the database | To the guarantee reference (if applicable) | All requests | |
| Guarantee chain not found | The guarantee chain was not found in the database | Root of the message | All requests | |
| Guarantee type not found | The guarantee type was not found in the database | Root of the message | All requests | |
| Customs Office not found | The customs office was not found in the database | Root of the message | E9/E10, I7/I8, I9/I10, I11/I12, I13/I14 | |
| Country not found | The country was not found in the database | Root of the message | E9/E10, I7/I8, I9/I10, I11/I12, I13/I14 | |
| Control type not found | The control type was not found in the database | To the control type element, if applicable | I9/I10, I11/I12, I13/I14 | |
| Holder/Guarantee mismatch | The holder id parameter and the guarantee reference parameter do not match what is recorded in the database | Root of the message | I1/I2, I7/I8, E3/E4, E9/E10 | |
| Holder not authorized | The holder is not authorized in the International TIR Data Bank (ITDB) | Root of the message | E1/E2, I9/I10, I11/I12, I13/I14 | |
| Holder not found | The holder is not found in the International TIR Data Bank (ITDB) | The holder/Principal ID | E1/E2, I9/I10, I11/I12, I13/I14 | |
| Guarantee chain not authorized | The guarantee chain is not authorized in the database | Root of the message | I1/I2, E1/E2 | |
| Guarantee chain/Guarantee mismatch | The guarantee chain code parameter and the guarantee reference parameter do not match what is recorded in the database | Root of the message | I1/I2, E3/E4 | |
| Guarantee type/Guarantee mismatch | The guarantee type parameter and the guarantee reference parameter do not match what is recorded in the database | Root of the message | I1/I2, E3/E4 | |
| Multiple operations found | This code is used when operations are duplicated in the database | Root of the message | I9/I10, I11/I12, I13/I14 |