Get Order

Response
The order with an array of order items including their current status and the binary if already available.

{
    "ordernumber": 4009874433,
    "orderitems": [
        {
            "company": "Ascom (Schweiz) AG",
            "reference": 123456,
            "name": "Credit Report online",
            "language": "DE",
            "filesize": 42047,
            "format": "PDF",
            "binary": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhkZS1DSCkgL1N0cnVjdFRyZWVSb290IDIxIDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4+Pg0KZW5kb2J...",
            "productcode": "DLF150",
            "itemnumber": "1409B0083",
            "comment": "some comment"
        },
        {
            "company": "Ascom (Schweiz) AG",
            "reference": 123456,
            "name": "Financial Report online",
            "language": "DE",
            "filesize": 33967,
            "format": "PDF",
            "binary": "JVBERi0xLjUNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhkZS1DSCkgL1N0cnVjdFRyZWVSb290IDE5IDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4+Pg0KZW5...",
            "statuscode": 6,
            "status": "available",
            "productcode": "DLF110",
            "itemnumber": "1409B0084",
            "comment": "some comment"
        }
    ],
    "date": "2014-09-05T12:24:21Z"
}

The "orderitem.binary" contains the report as base64 encoded JSON-string. Please decode it to a real binary with your preferred programming language.

The attributes filesize and datecreated are only available if the binary is included.

Example:

$.get('https://api.worldbox.ch/v1/order/6225223617?binary=false', function(data) {
    console.log(data);
});

Negative Reports & Cancellation Code

When we have certainty that the request cannot be completed we call it a “Negative Report” (a report indicating that no companies have been found for the provided criteria).

The status returned will be "canceled" with the "statuscode" 9 and a field "comment" and "cancellationcode" will be added to the response structure containing further information.

{
  "ordernumber": "7115443784",
  "orderitems": [
    {
      "company": "Sonangol - Sociedade Nacional de Combustíveis de Angola E.P",
      "name": "Credit/Investigation report normal (offline)",
      "language": "EN",
      "productcode": "REO110",
      "estimated production time": "",
      "charge": "0.00",
      "productid": "650",
      "reference": "1234",
      "format": "XML",
      "statuscode": 9,
      "status": "canceled",
      "comment": "NEGATIVE REPORT. We could not find the company you requested",
      "cancellationcode" : "001",
      "datecreated": "",
      "itemnumber": "1601B0114"
    }
  ],
  "date": "2016-01-27T14:10:26Z",
  "charge": "0.00"
}

Check the appendix page Status Codes for a full list of the cancellation codes