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.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Order
NameDescriptionTypeAdditional information
id

The ID of the Order.

integer

None.

status

The status of an Order. Setting this property to Open will submit the Order for translation. Typical Order status progress: Idle > Open > Delivered > Completed.

string

Matching regular expression pattern: (\bIdle\b|\bOpen\b|\bCancelled\b)

jobRef

The Elanex job reference associated with the Order.

string

Max length: 20

orderTitle

The title of the Order. Use it to give your Order an easy to remember name.

string

Max length: 255

firstName

The first name of the customer to contact if there are questions about the Order.

string

Max length: 50

lastName

The last name of the customer to contact if there are questions about the Order.

string

Max length: 50

email

The email address of the customer to contact if there are questions about the Order.

string

Required

Max length: 255

sourceLanguage

The original language of the documents to translate.

Language

Required

targetLanguages

The target langauges to translate into. All source files will be translated into the languages you select.

Collection of Language

Required

workType

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

WorkType

None.

subject

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

Subject

None.

serviceLevel

The Service Level of an Order: Ultra, Fast, Standard. Service Level controls turn around time of translation with Ultra being the fastest. Default: Standard.

string

Matching regular expression pattern: (\bUltra\b|\bFast\b|\bStandard\b)

price

The total price of the Order.

decimal number

Range: inclusive between 0 and 1000000

currency

The currency in which the price is specified.

string

Max length: 3

deadlineUtc

The expected Order delivery date and time. UTC time zone.

date

None.

template

The template that controls certain aspects of the Order like monthly invoicing and XML file processing instructions.

Template

None.

instructions

Enter any information that will help our translation team understand the context for this content and any other translation requirements.

string

Max length: 8000

dateCreatedUtc

The date and time when the Order was created. UTC time zone.

date

None.

dateModifiedUtc

The date and time when the Order was last modified. UTC time zone.

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "status": "sample string 3",
    "jobRef": "sample string 4",
    "orderTitle": "sample string 5",
    "firstName": "sample string 6",
    "lastName": "sample string 7",
    "email": "sample string 8",
    "sourceLanguage": {
      "code": "sample string 2",
      "name": "sample string 3"
    },
    "targetLanguages": [
      {
        "code": "sample string 2",
        "name": "sample string 3"
      },
      {
        "code": "sample string 2",
        "name": "sample string 3"
      }
    ],
    "workType": {
      "id": 1,
      "name": "sample string 2"
    },
    "subject": {
      "id": 1,
      "name": "sample string 2"
    },
    "serviceLevel": "sample string 9",
    "price": 1.1,
    "currency": "USD",
    "deadlineUtc": "2018-08-19T12:59:47.2071983Z",
    "template": {
      "id": 1,
      "name": "sample string 3",
      "startDate": "2018-08-19T12:59:46.9337575Z",
      "endDate": "2018-08-19T12:59:46.9337575Z"
    },
    "instructions": "sample string 10",
    "dateCreatedUtc": "2018-08-19T12:59:47.2071983Z",
    "dateModifiedUtc": "2018-08-19T12:59:47.2071983Z"
  },
  {
    "id": 1,
    "status": "sample string 3",
    "jobRef": "sample string 4",
    "orderTitle": "sample string 5",
    "firstName": "sample string 6",
    "lastName": "sample string 7",
    "email": "sample string 8",
    "sourceLanguage": {
      "code": "sample string 2",
      "name": "sample string 3"
    },
    "targetLanguages": [
      {
        "code": "sample string 2",
        "name": "sample string 3"
      },
      {
        "code": "sample string 2",
        "name": "sample string 3"
      }
    ],
    "workType": {
      "id": 1,
      "name": "sample string 2"
    },
    "subject": {
      "id": 1,
      "name": "sample string 2"
    },
    "serviceLevel": "sample string 9",
    "price": 1.1,
    "currency": "USD",
    "deadlineUtc": "2018-08-19T12:59:47.2071983Z",
    "template": {
      "id": 1,
      "name": "sample string 3",
      "startDate": "2018-08-19T12:59:46.9337575Z",
      "endDate": "2018-08-19T12:59:46.9337575Z"
    },
    "instructions": "sample string 10",
    "dateCreatedUtc": "2018-08-19T12:59:47.2071983Z",
    "dateModifiedUtc": "2018-08-19T12:59:47.2071983Z"
  }
]