API - IT - Post Edit Download

For the time being you would display the URL where a user can download the results:

  1. Get the request details (API - IT - List Requests)
  2. Check property pe_ready. If it is true then the post edit is complete and you can use the present method to download the file.
  3. Display pe_url as soon as this property is set. It is the hyperlink to track the post edit online.

Please carefully read the error section at the end of this page: In fact in some cases the post edit result must be retrieved by the user from within Wordbee Translator.

URL

(GET) /api/it/requests/postedit/file?token=&id=

 

PARAMETERS

Parameters are:

token

The session token.

id

The ID of the translation request.

RESULTS

The method returns the file as a GZIP compressed binary stream (see Wikipedia). In C#, use the DeflateStream class to decompress the web response stream.


Errors

An HTTP status of 200 indicates success. Other HTTP status values indicate an error. You may get errors if: 

  1. No post edit was ever requested for the file or it is not finished, see the request's pe_ready property. 
  2. The post edited file can only be downloaded manually from within Wordbee Translator, see below. The error ID will be PE_FILE_ONLINE_ONLY.

 

Files requiring online download

Direct download is possible only if the Wordbee Translator manager delivers the file like this:

  • The post-edited file must have the exact same name as the original file.
  • The file must be placed inside a sub-folder of the online order. The folder name must be the exact target language code (and not the language name).

The case when a user needs to download the final file online is indicated by a specific HTTP 400 error code: PE_FILE_ONLINE_ONLY. Display the error message in the JSON and make sure to show the hyperlik to access the order online (use the pe_url property of the request, see: API - IT - List Requests).

 

 

 

 

Copyright Wordbee - Buzzin' Outside the Box since 2008