Orders

The translation Orders that have been completed, pending, or currently in progress.

APIDescription
GET api/orders

Lists all Orders. This collection supports OData query options and will return maximum of 100 Orders per page.

GET api/orders/idle

Lists all Orders with status "Idle". This collection supports OData query options and will return maximum of 100 Orders per page.

GET api/orders/open

Lists all Orders with status "Open". This collection supports OData query options and will return maximum of 100 Orders per page.

GET api/orders/delivered

Lists all Orders with status "Delivered". This collection supports OData query options and will return maximum of 100 Orders per page.

GET api/orders/completed

Lists all Orders with status "Completed". This collection supports OData query options and will return maximum of 100 Orders per page.

GET api/orders/{id}

Returns a single Order.

PUT api/orders/{id}

Updates an Order. You can submit or cancel the Order by setting its status to Open or Cancelled. Notes: Order ID property must be set to same value as the one used in request URL. Only the properties of Idle Orders can be modified, the data in the PUT request overwrites existing information. Only open Orders can be cancelled, in that case other updates to properties are skipped.

POST api/orders

Creates an new Order. Orders are created with an "Idle" status, this allows you to upload the source documents and modify the Order prior to submitting it for analysis and translation.

DELETE api/orders/{id}

Deletes the specified Order. Only Orders with status "Idle" can be deleted. To cancel an open Order use PUT request and set the status to "Cancelled".

SourceFiles

Source Files are the documents that you wish to translate. We support many popular file types, if your file is not supported please let us know.

APIDescription
GET api/orders/{orderId}/source/files

Lists all Source Files for an Order.

GET api/orders/{orderId}/source/files/{id}

Returns a single Source File.

GET api/orders/{orderId}/source/files/{id}/download

Returns the Source File content for download.

POST api/orders/{orderId}/source/files

Adds a new Source File to the Order. Notes: Content type must be set to multipart/form-data and include a boundary, for example: Content-Type: multipart/form-data; boundary=-------------------------acebdf13572468 Only one file can be uploaded per request. Files can be added to Idle Orders only. Maximum file name length including extension is 255 characters. A file name cannot contain any of the following characters: \ / : * ? " < > |. Maximum file size allowed for upload is 200MB. To update the file, delete it and then POST it again.

DELETE api/orders/{orderId}/source/files/{id}

Deletes the specified Source File from the Order. Files can be removed from Orders in Idle status only.

GlossaryFiles

Glossary Files are used as translation glossary when translating. We support many popular file types, if your file is not supported please let us know.

APIDescription
GET api/orders/{orderId}/glossary/files

Lists all Glossary Files for an Order.

GET api/orders/{orderId}/glossary/files/{id}

Returns a single Glossary File.

GET api/orders/{orderId}/glossary/files/{id}/download

Returns the Glossary File content for download.

POST api/orders/{orderId}/glossary/files

Adds a new Glossary File to the Order. Notes: Content type must be set to multipart/form-data and include a boundary, for example: Content-Type: multipart/form-data; boundary=-------------------------acebdf13572468 Only one file can be uploaded per request. Files can be added to Idle Orders only. Maximum file name length including extension is 255 characters. A file name cannot contain any of the following characters: \ / : * ? " < > |. Maximum file size allowed for upload is 200MB. To update the file, delete it and then POST it again.

DELETE api/orders/{orderId}/glossary/files/{id}

Deletes the specified Glossary File from the Order. Files can be removed from Orders in Idle status only.

TargetFiles

Target Files are translated Source Files, one Target File for each language pair. Target Files become available once translation is finished and file is delivered.

APIDescription
GET api/orders/{orderId}/target/files

Lists all available Target Files for an Order.

GET api/orders/{orderId}/target/files/{id}

Returns a single Target File.

GET api/orders/{orderId}/target/files/{id}/download

Returns the Target File content for download.

Languages

APIDescription
GET api/languages

Lists the source and target languages supported by the API.

GET api/languages/{code}

Returns a single language.

WorkTypes

The context of your documents and what they will be used for, for example "Business and general non-fiction".

APIDescription
GET api/worktypes

Lists all Work Types supported by the API.

GET api/worktypes/{id}

Returns a single Work Type.

Subjects

The subject matter of your documents that would not be understandable to an average reader, for example "Software and programming".

APIDescription
GET api/subjects

Lists all Subjects supported by the API.

GET api/subjects/{id}

Returns a single Subject.

Templates

Templates control certain aspects of the Order like monthly invoicing and XML file processing instructions.

APIDescription
GET api/templates

Lists all available Templates.

GET api/templates/{id}

Returns a single Template.