order/{orderid}/files/all/zip

This method lets you download all the files of an order. This includes both the original files as well as any translations or reference material.

All files will are added to a single ZIP archive.

The method supports up to 2000 files. If an order contains more than that amount of files, an error message will be returned.

URL

(POST) /api/orders/{orderid}/files/all/zip

PARAMETERS

The URL parameters are:

orderid

The order ID.

Tip:

See orders/list for enumerating or finding orders and getting an order’s numeric ID.

To find orders with reference starting with “abc”, use this BODY in orders/list:

{ "query": "{reference}.Matches(\"abc\", \"prefix\")" }

int, Mandatory

The (optional) body is a JSON object with these properties:

callbackurl

Optional URL which will be called upon success or failure of operation. This makes polling for results (see below) unnecessary.

URL is called as POST request with operation result included in the body, see "RESULTS" chapter below for the JSON format.

Suggestion: Include your own references in the URL, example: http://callmeback.mycompany.com?operationid=22222&mydata=abcde

string?, Optional

RESULTS

The API method returns an Asynchronous operation result:

{
  "trm": {
    "requestid":32230,
    "status":"Waiting",
    "statusText":"Waiting..."
  }
}

You can poll the status or use the callback parameter. When the operation is complete, the results are in the custom property:

{
    "trm": {
        "requestid": 32230,
        "isbatch": false,
        "status": "Finished",
        "statusText": "Finished!"
    },
    "custom": {
       "filetoken": "178eee3996bd4898b31da69a4fe5b206",
       "count": 6
    }
}

The custom property is a JSON object:

filetoken

The token to download the ZIP file.

Usemedia/get/{token} or media/get/{token}/stream

string

count

Total files in ZIP archive.

int

If the operation fails then status is “Failed” and statusText contains the error description.

ACCESS RIGHTS

An order can only be accessed by an authorized user:

The person (client) who submitted the order.
A manager at the client and who can access any order submitted by a client user.
An internal manager.
The administrator.