Writing an application on Worldbox is easy as pie. But here are a few tips we've found helpful. You cannot check the API directly from your browser since authentication is needed. For debugging we strongly recommend to use a REST client like Postman.
Check the Response Body
The REST API will return a Worldbox REST Exception JSON block which contains the HTML error code, Worldbox-specific error code, error message, and a link to the Error Code Reference.
{
"code": 1010,
"type": "Bad request",
"message": "Validation Failed",
"details": [
"The query parameter q is mandatory for a search request.",
"The query parameter should have a min.length of three characters ",
"You must provide a ISO - 3361 countrycode for a search request."
],
"more info ": "https://worldbox-api.readme.io/docs/debugging"
}
All Worldbox-specific errors are listed in the Error Code Reference below.
Error and Warning Dictionary
| Code | Message | Type |
|---|---|---|
| 1000 | To access the API resources, you must specify the apikey and apisecret in the request header. see Authentication | Authentication Failure |
| 1001 | There is no company record with this WIN-number in the worldbox database. Most probably the WIN-number is wrong or the company has been deleted. | Not Found |
| 1002 | Allowed languages for reports and legal documents are English (EN) , Italian (IT) and German (DE). | Bad Request |
| 1003 | Allowed currencies for reports and legal documents are USD, GBP, EUR, CHF. | Bad Request |
| 1004 | The WIN number in the resource is mandatory to retrieve the reports or legal documents. | Bad Request |
| 1005 | The binary of your report seems to be corrupted please contact worlddbox and included your order information. | System Failure |
| 1006 | Your request is not a valid JSON data representation. | Bad Request |
| 1007 | The price of the product could not be elicited. Please contact the Worldbox administration. | System Failure |
| 1008 | An error occured while processing your order. Please contact the Worldbox administration and include your order details. | System Failure |
| 1009 | Your date parameters must be constructed according to the following pattern: "YYYYMMDD" | Bad Request |
| 1010 | The company search got invalids parameter for searchstring Q and/or the countrycode. The searchstring Q must be at least 3 characters and countrycode should be a valid ISO-3361 countrycode | Bad Request |
| 1011 | Please enter a "Worldbox Identification Number" (WIN) to retrieve company information. | Bad Request |
| 1012 | The company request got invalid parameters. Please check if all mandatory parameters are included in the request. | Bad Request |
| 1013 | To obtain information about an order, you must specify an existing order number. | Bad Request |
| 1014 | To obtain information about an ordered item, you must specify an existing item number. | Bad Request |
| 1015 | The validation of your order failed. Make sure that your productcode is valid and correspond to an existing product. Provided all mandatory parameters --> Commit Order. | Bad Request |
| 1016 | You must provide a type for the requested product. Valid types are "online" or "offline" | Bad Request |
| 1017 | Your provided type is not valid. Valid types are "online" or "offline" | Bad Request |
| 1018 | This is not a valid resource. Available products are or | Bad Request |
| 1019 | This product is not avilable for this company | Bad Request |
| 1020 | The committed JSON data structure in POST or UPDATE method is wrong. Please check the documentation for the correct data structure | Bad Request |
| 1023 | The subscription could not be found. Either the provided item number is wrong or the subscription was deleted | Resource Error |
| 1024 | The company with WIN number is not included in your subscription with the corresponding product code | Bad Request |
| 1025 | Your subscription has expired. Please renew the subscription with a new order. | Bad Request |
Allowed Companies on the Test Server
The access to the Worldbox index for company data is restricted on the testserver. Only reports for the following companies will be produced on the test server:
Online reports: AT0000050699 / BE0000039875 / CH0000435037 / NL0000077679 / DE0000140227 / GR0000026463 / IE0000034327 / PL0000034509 / PT0000030144 / ES0000046468
Offline reports: CH0000435037 / IE0000036365 / PT0000027184 / AT0000049528