API Documentation

The online documentation describes the STREAM API and allows you to learn about the methods provided by our API. The documentation can be complemented by viewing our Examples page, for a better understanding of how to use our API in your application. If you wish to quickly make use of our API for testing purposes, please check our Quick Start page.

Please use the side menu to browse the diferent sections of the documentation. If you need help or some other form of support, please contact us.

Overview

To be able to use the STREAM API you will need to be registered with TranslateMedia and obtain an API Key. This API Key is needed for you to authenticate yourself when using some of the API methods.

If you are a new user to TranslateMedia, you can register here. If you are already registered, to obtain an API Key, you will need to login and go to the Api Key Management page.

The STREAM API is implemented as a SOAP based Web Service. You can find the live STREAM API endpoint at:



The WSDL is located at:



We also offer a Sandbox endpoint, which serves as a testing environment that you can use for testing your STREAM API integration. The translations jobs that are requested through the Sandbox can latter be seen on the Manage Jobs page.

You can find the STREAM API Sandbox endpoint at:



The WSDL is located at:



Below you will find a description of the STREAM API methods. If you wish to see some examples of how to use these methods, you can see the Quick Start page and the Examples page. If you need help or some other form of support, please contact us.

Authentication


Authentication Overview

Some of the available methods of the STREAM API require a token-based authentication. In order to obtain a token, you most use the
Authenticate method. The Authenticate method must be called using the AuthenticationHeader, providing your username and your Api Key. If the authentication is successful, an Authentication Token is generated and returned. This token should then be used when calling all posterior services that require authentication.

If the authentication fails due to missing or incorrect credentials, the response will include an error code.

Authenticate Method

Use this method to authenticate and retrieve an authentication token. If the authentication is not successful, the m_error member contains the details of the error. If the authentication is successful, an Authentication Token is returned.

The Authentication Token must be used on all posterior service calls that require authentication. The Authentication Token has an activity expiration time of 20 minutes, in a similar way to a session token.

Error codes

1The authentication credentials are incorrect
2Authentication required. Usually means that the call to the service was made without the AuthenticationHeader with the credentials.
3The client is not member of a corporate account. Only corporate account members are allowed to access the TranslateMedia server using the API.
4 System temporarily suspended for maintenance.


SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/Authenticate"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="https://services.translatemedia.com">
      <Username>string</Username>
      <ApiKey>string</ApiKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <Authenticate xmlns="https://services.translatemedia.com" />
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AuthenticateResponse xmlns="https://services.translatemedia.com">
      <AuthenticateResult>
        <TokenValue>string</TokenValue>
        <authenticationSuccessful>boolean</authenticationSuccessful>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
      </AuthenticateResult>
    </AuthenticateResponse>
  </soap:Body>
</soap:Envelope>

Hello World Methods


HelloWorld Method

This function provides a quick and easy way for developers to test the connection between the client application and the STREAM API Web Services without using authentication.

The function does not have any input parameter. When successful, a call to this method returns the following string: "Hello World - You are connected to TranslateMedia."

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/HelloWorld"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <HelloWorld xmlns="https://services.translatemedia.com" />
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="
http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <HelloWorldResponse xmlns="https://services.translatemedia.com">
      <HelloWorldResult>string</HelloWorldResult>
    </HelloWorldResponse>
  </soap:Body>
</soap:Envelope>

HelloWorldWithAuthentication Method

This function provides a quick and easy way for developers to test the connection while using authentication, during an initial phase of the development. When successful, a call to this method returns the following string: "Hello World - You are authenticated and connected to TranslateMedia."

To use this function you must use the Authentication Token that is provided when using the
Authenticate method.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/HelloWorldWithAuthentication"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <HelloWorldWithAuthentication xmlns="https://services.translatemedia.com" />
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <HelloWorldWithAuthenticationResponse xmlns="https://services.translatemedia.com">
      <HelloWorldWithAuthenticationResult>string</HelloWorldWithAuthenticationResult>
    </HelloWorldWithAuthenticationResponse>
  </soap:Body>
</soap:Envelope>

Languages and Specialities Methods


Several functions of the STREAM API use language and specialism in form of an numerical ID, as an input parameter. Therefore, the API contains some functions to obtain the complete list of available languages and their ID's.

GetLanguagesList Method


This function allows you to obtain the full list of supported languages. The function has no input parameter and returns a
SOAPlanguage array with the complete list of supported languages and their respective codes (ID's).

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetLanguagesList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLanguagesList xmlns="https://services.translatemedia.com" />
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLanguagesListResponse xmlns="https://services.translatemedia.com">
      <GetLanguagesListResult>
        <SOAPlanguage>
          <description>string</description>
          <languageID>int</languageID>
        </SOAPlanguage>
        <SOAPlanguage>
          <description>string</description>
          <languageID>int</languageID>
        </SOAPlanguage>
      </GetLanguagesListResult>
    </GetLanguagesListResponse>
  </soap:Body>
</soap:Envelope>

GetLanguageID Method


Some of the methods provided by the API accept languages parameters, in the form of a numeric ID. The language ID must one the possible values of the
Languages code list .

To facilitate this task, we provide the GetLanguageID method, that will allow you to get the language ID by specifying the language name.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetLanguageID"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLanguageID xmlns="https://services.translatemedia.com">
      <text>string</text>
    </GetLanguageID>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLanguageIDResponse xmlns="https://services.translatemedia.com">
      <GetLanguageIDResult>
        <description>string</description>
        <languageID>int</languageID>
        <rfc5646>string</rfc5646>
      </GetLanguageIDResult>
    </GetLanguageIDResponse>
  </soap:Body>
</soap:Envelope>

The method will return a SOAPLanguage object, containing the ID in the languageID member.

GetLanguageIdRfc5646 Method


In complement to the GetLanguageID method, we provide a more formal notation, supporting IETF language tags (RFC 5646/ BCP 47).

The GetLanguageIdRfc5646 method will accept a language code in RFC 5646 format (e.g. "en-US" for English US version) and will return the language ID.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetLanguageIdRfc5646"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLanguageIdRfc5646 xmlns="https://services.translatemedia.com">
      <rfc5646Code>string</rfc5646Code>
    </GetLanguageIdRfc5646>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetLanguageIdRfc5646Response xmlns="https://services.translatemedia.com">
      <GetLanguageIdRfc5646Result>
        <description>string</description>
        <languageID>int</languageID>
        <rfc5646>string</rfc5646>
      </GetLanguageIdRfc5646Result>
    </GetLanguageIdRfc5646Response>
  </soap:Body>
</soap:Envelope>
</soap:Envelope>

The method will return a SOAPLanguage object, containing the ID in the languageID member.

GetSpecialitiesList Method


This function allows you to obtain the full list of supported specialities. The function has no input parameter and returns a
SOAPspeciality array with the complete list of specialities and their respective ID's.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetSpecialitiesList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSpecialitiesList xmlns="https://services.translatemedia.com" />
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSpecialitiesListResponse xmlns="https://services.translatemedia.com">
      <GetSpecialitiesListResult>
        <SOAPspeciality>
          <description>string</description>
          <specialityID>int</specialityID>
        </SOAPspeciality>
        <SOAPspeciality>
          <description>string</description>
          <specialityID>int</specialityID>
        </SOAPspeciality>
      </GetSpecialitiesListResult>
    </GetSpecialitiesListResponse>
  </soap:Body>
</soap:Envelope>

GetAvailableSpecialities Method


This function is used to obtain the available specialities based on a source language.

Parameters

NameTypeDescription
idSourceLngintThe ID of the source language that you whish to translate from. Please refer to the Languages code list.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetAvailableSpecialities"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAvailableSpecialities xmlns="https://services.translatemedia.com">
      <idSourceLng>int</idSourceLng>
    </GetAvailableSpecialities>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAvailableSpecialitiesResponse xmlns="https://services.translatemedia.com">
      <GetAvailableSpecialitiesResult>
        <SOAPspeciality>
          <description>string</description>
          <specialityID>int</specialityID>
        </SOAPspeciality>
        <SOAPspeciality>
          <description>string</description>
          <specialityID>int</specialityID>
        </SOAPspeciality>
      </GetAvailableSpecialitiesResult>
    </GetAvailableSpecialitiesResponse>
  </soap:Body>
</soap:Envelope>

GetAvailableTargetLanguages Method


This function is used to obtain the available target languages based on a source language and speciality.

Parameters

NameTypeDescription
idSourceLngintThe ID of the source language that you whish to translate from. Please refer to the Languages code list.
idSpecialityintThe ID of the speciality. Please refer to the Specialities code list.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetAvailableTargetLanguages"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAvailableTargetLanguages xmlns="https://services.translatemedia.com">
      <idSourceLng>int</idSourceLng>
      <idSpeciality>int</idSpeciality>
    </GetAvailableTargetLanguages>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAvailableTargetLanguagesResponse xmlns="https://services.translatemedia.com">
      <GetAvailableTargetLanguagesResult>
        <SOAPlanguage>
          <description>string</description>
          <languageID>int</languageID>
        </SOAPlanguage>
        <SOAPlanguage>
          <description>string</description>
          <languageID>int</languageID>
        </SOAPlanguage>
      </GetAvailableTargetLanguagesResult>
    </GetAvailableTargetLanguagesResponse>
  </soap:Body>
</soap:Envelope>

Quotes Methods


In order to order a translation using the STREAM API you need to obtain a quote. The STREAM API contains several functions to obtain a quote for the translation service, based on input parameters like: source and target languages, speciality, plain text or several other formats of source document, authenticity certification and some others advanced user settings.

GetQuoteForPlainText Method

This function is used to obtain quotes for a translation service based on: source language, target language, specialism and a plain text to translate. This function requires the use of an Authentication Token.

The function returns a
SOAPresponse object. If no error occurs, the m_quotes member will contain an array with the quotes.

Parameters

NameTypeDescription
idSourceLngintThe ID of the source language that you whish to translate from. Please refer to the Languages code list.
idSpecialityintThe ID of the speciality. Please refer to the Specialities code list.
aidTargetLngint[ ]An array with the IDs of target languages.
sSourceTextstringThe text to translate.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetQuoteForPlainText"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <GetQuoteForPlainText xmlns="https://services.translatemedia.com">
      <idSourceLng>int</idSourceLng>
      <idSpeciality>int</idSpeciality>
      <aidTargetLng>
        <int>int</int>
        <int>int</int>
      </aidTargetLng>
      <sSourceText>string</sSourceText>
    </GetQuoteForPlainText>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetQuoteForPlainTextResponse xmlns="https://services.translatemedia.com">
      <GetQuoteForPlainTextResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </GetQuoteForPlainTextResult>
    </GetQuoteForPlainTextResponse>
  </soap:Body>
</soap:Envelope>

GetQuoteForDocument Method


This function can be used to obtain quotes for a translation service based: source language, target language, specialism and a document.

The function returns a
SOAPresponse object. If no error occurs, the the m_quotes member will contain an array with the quotes. If the system fails to count the number of words on the source document, the returned object will have set the members in the following way:

SOAPresponse memberType/ValueDescription
idintThe ID of the uploaded document. You need to pass this ID to the function GetSimpleQuote or GetAdvancedQuote in order to obtain the quote.
m_errors.errorCode5Error code 5 means that it failed to get the number of words.
m_errors.errorPresenttrueA flag which shows that an error has happened.


Parameters

NameTypeDescription
idSourceLngintThe ID of the source language that you whish to translate from. Please refer to the Languages code list.
idSpecialityintThe ID of the speciality. Please refer to the Specialities code list.
aidTargetLngint[ ]An array with the ID's of the target languages.
sFileNamestringName of the document.
abyBufferbyte[ ]An array of the bytes which composes the file itself.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetQuoteForDocument"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <GetQuoteForDocument xmlns="https://services.translatemedia.com">
      <idSourceLng>int</idSourceLng>
      <idSpeciality>int</idSpeciality>
      <aidTargetLng>
        <int>int</int>
        <int>int</int>
      </aidTargetLng>
      <sFileName>string</sFileName>
      <abyBuffer>base64Binary</abyBuffer>
    </GetQuoteForDocument>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetQuoteForDocumentResponse xmlns="https://services.translatemedia.com">
      <GetQuoteForDocumentResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </GetQuoteForDocumentResult>
    </GetQuoteForDocumentResponse>
  </soap:Body>
</soap:Envelope>

GetAdvancedQuoteForDocument Method

This function can be used to obtain quotes for translation services based on: source language, target languages specialism, source document and some specific advanced settings.

The function returns a SOAPresponse object. If no error occurs, the m_quotes member will contain an array with the quotes. If the system fails to count the number of words on the source document and the bTranslatePartialDoc parameter is false, the returned object will have set the members in the following way:

SOAPresponse memberType/ValueDescription
idintThe ID of the uploaded document. You need to pass this ID to the function GetSimpleQuote or GetAdvancedQuote in order to obtain the quote.
m_errors.errorCode5Error code 5 means that it failed to get the number of words.
m_errors.errorPresenttrueA flag which shows that an error has happened.


Parameters

NameTypeDescription
idSourceLngintThe code of the source language that you whish to translate from. Please refer to the Languages code list.
idSpecialityintThe code of the speciality. Please refer to the Specialities code list.
aidTargetLngint[ ]An array with the ID's of target languages.
sFileNamestringName of the document.
abyBufferbyte[ ]An array of the bytes which composes the file itself.
byAuthenticiyCertificationbyte0 = no authenticity certification; 1 = Letter of authenticity; 2 = Notarisation; 3 = Affidavit.
iWordCountToTranslateintNumber of words to translate in the source document. If the parameter bTranslatePartialDoc is false, then it is ignored.
bTranslatePartialDocbyteSet this parameter to true if you do not need to translate the whole document, only parts of it. If this set to true, then the iWordCountToTranslate must be set.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetAdvancedQuoteForDocument"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <GetAdvancedQuoteForDocument xmlns="https://services.translatemedia.com">
      <idSourceLng>int</idSourceLng>
      <idSpeciality>int</idSpeciality>
      <aidTargetLng>
        <int>int</int>
        <int>int</int>
      </aidTargetLng>
      <sFileName>string</sFileName>
      <abyBuffer>base64Binary</abyBuffer>
      <byAuthenticiyCertification>unsignedByte</byAuthenticiyCertification>
      <iWordCountToTranslate>int</iWordCountToTranslate>
      <bTranslatePartialDoc>boolean</bTranslatePartialDoc>
    </GetAdvancedQuoteForDocument>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAdvancedQuoteForDocumentResponse xmlns="https://services.translatemedia.com">
      <GetAdvancedQuoteForDocumentResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </GetAdvancedQuoteForDocumentResult>
    </GetAdvancedQuoteForDocumentResponse>
  </soap:Body>
</soap:Envelope>

GetSimpleQuote Method


Use this function to get a quote when the system fails to count the number of words when you uploaded the document using the function GetQuoteForDocument or the GetAdvancedQuoteForDocument. This function is used to obtain quotes for translation services based on: source langauge, target languages, specialism, word count and the ID of the document. It can be used only after the document is uploaded. In order to upload the document you have to use either the GetQuoteForDocument function or GetAdvancedQuoteForDocument function.

The function returns a SOAPresponse object. If no error occurs the m_quotes member will contain an array with the quotes.

Parameters

NameTypeDescription
idSourceLngintThe ID of the source language that you whish to translate from. Please refer to the Languages code list.
idSpecialityintThe ID of the speciality. Please refer to the Specialities code list.
aidTargetLngint[ ]An array with the IDs of target languages.
wordCountintNumber of words to translate.
idDocumentintThe ID of the source document.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetSimpleQuote"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <GetSimpleQuote xmlns="https://services.translatemedia.com">
      <idSourceLng>int</idSourceLng>
      <idSpeciality>int</idSpeciality>
      <aidTargetLng>
        <int>int</int>
        <int>int</int>
      </aidTargetLng>
      <wordCount>int</wordCount>
      <idDocument>int</idDocument>
    </GetSimpleQuote>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSimpleQuoteResponse xmlns="https://services.translatemedia.com">
      <GetSimpleQuoteResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </GetSimpleQuoteResult>
    </GetSimpleQuoteResponse>
  </soap:Body>
</soap:Envelope>

GetAdvancedQuote Method


Use this function to get the quote if the system fails to count the number of words when you uploaded the document using the function GetQuoteForDocument or the function GetAdvancedQuoteForDocument.

This function is used to obtain quotes for translation services based on: source language, target language, specialism, word count, ID of document and some specific advanced parameters. It can be used only after the document is uploaded. In order to upload the document you have to use either the GetQuoteForDocument function or the GetAdvancedQuoteForDocument function.

Parameters

NameTypeDescription
idSourceLngintThe ID of the source language that you whish to translate from. Please refer to the Languages code list.
idSpecialityintThe ID of the speciality. Please refer to the Specialities code list.
aidTargetLngint[ ]An array with the IDs of target languages.
wordCountintNumber of words to translate.
idDocumentintThe ID of the source document.
byAuthenticiyCertificationbyte0 = no authenticity certification; 1 = Letter of authenticity; 2 = Notarisation; 3 = Affidavit.
iWordCountToTranslateintNumber of words to translate in the source document. If the parameter bTranslatePartialDoc is false, then it is ignored.
bTranslatePartialDocbyteSet this parameter to true if you do not need to translate the whole document, only parts of it. If this set to true, then the iWordCountToTranslate must be set.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/GetAdvancedQuote"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <GetAdvancedQuote xmlns="https://services.translatemedia.com">
      <idSourceLng>int</idSourceLng>
      <idSpeciality>int</idSpeciality>
      <aidTargetLng>
        <int>int</int>
        <int>int</int>
      </aidTargetLng>
      <iWordCount>int</iWordCount>
      <idDocument>int</idDocument>
      <byAuthenticiyCertification>unsignedByte</byAuthenticiyCertification>
      <bTranslatePartialDoc>boolean</bTranslatePartialDoc>
    </GetAdvancedQuote>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAdvancedQuoteResponse xmlns="https://services.translatemedia.com">
      <GetAdvancedQuoteResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </GetAdvancedQuoteResult>
    </GetAdvancedQuoteResponse>
  </soap:Body>
</soap:Envelope>

Orders Methods


Once you have a quote you can initiate an order. In the simplest scenario you only need to pass the ID of the suitable quote. The STREAM API also provides proper functions for cases when you need to set some advanced setting, like naming conventions or a purchase order. It also allows the attachment of more info documents to the order.

CreateOrder Method


This function allows you to create a new order. Prior to creating an order your application needs to ask for a quote using one of the functions enumerated in section Quote Methods. Those functions will send back an array of quotes from which the user of your application can choose the suitable one. Once the quote is selected, your application can pass the ID of the quote to the CreateOrder function and the translation service will be officially ordered on TranslateMedia system.

The function returns a SOAPresponse object. If an error occurs then the requestSuccesful member of the object is set to false and the m_errors member contains further information about the error (error code and error description). If no error occurs, the requestSuccesful member of the object is set to true and the ID member of the object will contain an order reference. This reference can be used to attach more info documents to the order or to track the status of the order.

Parameters

NameTypeDescription
idQuoteintID of the suitable quote. Please note that the ID must be obtained through the use of one of the Quote methods.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/CreateOrder"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <CreateOrder xmlns="https://services.translatemedia.com">
      <idQuote>int</idQuote>
    </CreateOrder>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateOrderResponse xmlns="https://services.translatemedia.com">
      <CreateOrderResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </CreateOrderResult>
    </CreateOrderResponse>
  </soap:Body>
</soap:Envelope>

CreateOrderAdvanced Method


This function allows you to create a new order with some advanced settings. Prior to creating an order your application needs to ask for a quote using one of the functions enumerated in the Quotes section. Those functions will send back an array of quotes from which the user of your application can choose the suitable one. Once the quote is selected, your application can pass the ID of the quote to the CreateOrderAdvanced function and the translation service will be officially ordered on TranslateMedia system.

The function returns a SOAPresponse object. If an error occurs then the requestSuccesful member of the object is set to false and the m_errors member will contain further information about the error (error code and error description). If no error occurs then the requestSuccesful member of the object is set to true and the ID member of the object will contain an order reference. This reference can be used to attach more info document to the order or to track the status of the order

Parameters

NameTypeDescription
idQuoteintID of the suitable quote
sAdditionalInstructions string Through this parameter you can pass additional instructions to the translators who will be working on your order. Please note that if you asked for quote for a partial document translation you must provide instruction on what to translate, otherwise the function will return an error and no order will be initiated.
byNamingConvention byte 0 = TranslateMedia naming convention, 1 = keep the original filename, 2 = use prefix and suffix, 3 = use prefix/suffix as filename. If the provided value it's an unexpected one, TM naming convention will be used.
sPrefix string This parameter is ignored if the byNamingConvention parameter is not 2 or 3.
sSuffix string This parameter is ignored if the byNamingConvention parameter is not 2 or 3.
sDeliveryEmailCopyTo string The email address specified in this parameter will be sent a copy of the translated document(s). If you need to send a copy to more than one email address, separate the addresses with a semicolon.
bSendForReview bool If you need the translations to be sent to your in-house translators for revising set this parameter to true.
dtReviewerDeadline DateTime Deadline of the special review. It is ignore if the bSendForReview is set to false.
sPO string The client’s reference or purchase order.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/CreateOrderAdvanced"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <CreateOrderAdvanced xmlns="https://services.translatemedia.com">
      <idQuote>int</idQuote>
      <sAdditionalInstructions>string</sAdditionalInstructions>
      <byNamingConvention>unsignedByte</byNamingConvention>
      <sPrefix>string</sPrefix>
      <sSuffix>string</sSuffix>
      <sDeliveryEmailCopyTo>string</sDeliveryEmailCopyTo>
      <bSendForReview>boolean</bSendForReview>
      <dtReviewerDeadline>dateTime</dtReviewerDeadline>
      <sPO>string</sPO>
    </CreateOrderAdvanced>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateOrderAdvancedResponse xmlns="https://services.translatemedia.com">
      <CreateOrderAdvancedResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </CreateOrderAdvancedResult>
    </CreateOrderAdvancedResponse>
  </soap:Body>
</soap:Envelope>

SaveBillingDetails Method


This function allows you to overwrite the billing details attached to an order

Parameters

NameTypeDescription
sOrderRef string An order reference. Please note that the order reference must be obtained by the previously use of the functions CreateOrder or CreateOrderAdvanced.
sBillingName string Billing name.
sBillingContact string Billing contact.
sBillingEmail string Billing email.
sBillingAddress string Billing address.
sBudgetCode string Budget code.
sProjectCode string Project code.
sPO string Client reference or Purchase Order.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/SaveBillingDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <SaveBillingDetails xmlns="https://services.translatemedia.com">
      <sOrderRef>string</sOrderRef>
      <sBillingName>string</sBillingName>
      <sBillingContact>string</sBillingContact>
      <sBillingEmail>string</sBillingEmail>
      <sBillingAddress>string</sBillingAddress>
      <sBudgetCode>string</sBudgetCode>
      <sProjectCode>string</sProjectCode>
      <sPO>string</sPO>
    </SaveBillingDetails>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SaveBillingDetailsResponse xmlns="https://services.translatemedia.com">
      <SaveBillingDetailsResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </SaveBillingDetailsResult>
    </SaveBillingDetailsResponse>
  </soap:Body>
</soap:Envelope>

UploadMoreInfoDocument Method


This function allows you to upload a document with more information for the translators and attach it to an order. The function returns a SOAPresponse object, in which the ID member of the object contains an order reference.

Parameters

NameTypeDescription
sOrderRef string An order reference. Please note that the order reference must be obtained by the previously use of the functions CreateOrder or CreateOrderAdvanced.
sFileName string Name of the file.
abyBuffer byte [ ] An array of the bytes which composes the file itself.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/UploadMoreInfoDocument"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <UploadMoreInfoDocument xmlns="https://services.translatemedia.com">
      <sOrderRef>string</sOrderRef>
      <sFileName>string</sFileName>
      <abyBuffer>base64Binary</abyBuffer>
    </UploadMoreInfoDocument>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UploadMoreInfoDocumentResponse xmlns="https://services.translatemedia.com">
      <UploadMoreInfoDocumentResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </UploadMoreInfoDocumentResult>
    </UploadMoreInfoDocumentResponse>
  </soap:Body>
</soap:Envelope>

Track Jobs Methods


The STREAM API provides functions to obtain several informations regarding the orders, so that you can manage and track your current orders.

TrackOrder Method


This can be used to help you track an order and get real-time information on projected delivery times and where each document is within TranslateMedia's workflow.

The function returns a SOAPresponse object. The member m_jobsStatus will contain an array with the tracking information for each translation in the specified order.

Parameters

NameTypeDescription
sOrderRefstringAn order reference. Please note that the order reference must be obtained by the previously use of the functions CreateOrder or CreateOrderAdvanced.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/TrackOrder"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <TrackOrder xmlns="https://services.translatemedia.com">
      <sOrderRef>string</sOrderRef>
    </TrackOrder>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TrackOrderResponse xmlns="https://services.translatemedia.com">
      <TrackOrderResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </TrackOrderResult>
    </TrackOrderResponse>
  </soap:Body>
</soap:Envelope>

TrackOrders Method


This function can be used to help you track the orders of your account, uploaded in a given period of time, and get real-time information on projected delivery times and where each document is within TranslateMedia's workflow.

The function returns a SOAPresponse object. The member m_jobsStatus will contain an array with the tracking information for each translation uploaded in the specified period.

Parameters

NameTypeDescription
dtTrackFromDateTimeThe beginning of the tracking period.
dtTrackUntilDateTimeThe end of the tracking period.
bThisUserOnlyboolIf this parameter is set to false then the function will return tracking info for each order uploaded by any user of the user companie’s account. It can be used only by users who have the “account administrator” right granted to their account.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/TrackOrders"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <TrackOrders xmlns="https://services.translatemedia.com">
      <dtTrackFrom>dateTime</dtTrackFrom>
      <dtTrackUntil>dateTime</dtTrackUntil>
      <bThisUserOnly>boolean</bThisUserOnly>
    </TrackOrders>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TrackOrdersResponse xmlns="https://services.translatemedia.com">
      <TrackOrdersResult>
        <requestSuccessful>boolean</requestSuccessful>
        <id>string</id>
        <id_description>string</id_description>
        <description>string</description>
        <m_errors>
          <errorPresent>boolean</errorPresent>
          <description>string</description>
          <errorCode>int</errorCode>
        </m_errors>
        <m_quotes>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
          <SOAPquote>
            <idQuote>int</idQuote>
            <dQuotePrice>double</dQuotePrice>
            <byType>unsignedByte</byType>
            <dtTargetCompletion>dateTime</dtTargetCompletion>
            <iMinutesElapsed>int</iMinutesElapsed>
            <sCurrency>string</sCurrency>
          </SOAPquote>
        </m_quotes>
        <m_jobsStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
          <SOAPjobStatus>
            <sJobReference>string</sJobReference>
            <sSourceLng>string</sSourceLng>
            <sTargetLng>string</sTargetLng>
            <sSpecialism>string</sSpecialism>
            <iWOrdCount>int</iWOrdCount>
            <sOriginalFilename>string</sOriginalFilename>
            <dtJobSubmitted>dateTime</dtJobSubmitted>
            <dtJobDeadline>dateTime</dtJobDeadline>
            <sStatus>string</sStatus>
          </SOAPjobStatus>
        </m_jobsStatus>
        <m_UserSettings>
          <sPrefix>string</sPrefix>
          <sPostfix>string</sPostfix>
          <iWordCount>int</iWordCount>
          <sAdditionalDescription>string</sAdditionalDescription>
          <bTranslatePartialDocument>boolean</bTranslatePartialDocument>
          <bSpecailReview>boolean</bSpecailReview>
          <idDefaultLngTranslateFrom>int</idDefaultLngTranslateFrom>
          <idDefaultLngTranslateInto>int</idDefaultLngTranslateInto>
          <idDefaultDocumentType>int</idDefaultDocumentType>
        </m_UserSettings>
      </TrackOrdersResult>
    </TrackOrdersResponse>
  </soap:Body>
</soap:Envelope>

Retrieval Methods


The STREAM API provides a function to retrieve the translated documents from STREAM.

RetrieveTranslatedDocument Method


This method can be used to retrieve a translated document. Before trying to retrieve a translated document, one should use the Track functions to determine if the document was translated and thus ready to be retrieved.

The function returns the document in a binary format.

Parameters

NameTypeDescription
idTranslationintThe translation ID from which you wish to retrieve the translated document.

SOAP

The following is a sample SOAP 1.1 request:
POST /API2.asmx HTTP/1.1
Host: services.translatemedia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.translatemedia.com/RetrieveTranslatedDocument"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationToken xmlns="https://services.translatemedia.com">
      <TokenValue>string</TokenValue>
      <authenticationSuccessful>boolean</authenticationSuccessful>
      <m_errors>
        <errorPresent>boolean</errorPresent>
        <description>string</description>
        <errorCode>int</errorCode>
      </m_errors>
    </AuthenticationToken>
  </soap:Header>
  <soap:Body>
    <RetrieveTranslatedDocument xmlns="https://services.translatemedia.com">
      <idTranslation>int</idTranslation>
    </RetrieveTranslatedDocument>
  </soap:Body>
</soap:Envelope>

The following is a sample SOAP 1.1 response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RetrieveTranslatedDocumentResponse xmlns="https://services.translatemedia.com">
      <RetrieveTranslatedDocumentResult>base64Binary</RetrieveTranslatedDocumentResult>
    </RetrieveTranslatedDocumentResponse>
  </soap:Body>
</soap:Envelope>

Data Types


SOAPerror

The table below describes the SOAPerror data type.


MemberTypeDescription
errorPresentbool Indicates whether there are any errors with the order request.
Descriptionstring A description of the error where one is returned.
errorCodeint A numerical code for the error.

SOAPquote

The table below describes the SOAPquote data type.


MemberTypeDescription
idQuoteintThe quote identification number.
dQuotePricedouble The value of the quotation returned.
byTypebyte 0 = draft, 1 = premium, 2 = draft express, 3 = premium express.
dtTargetCompletionDateTime The quoted deadline for the work.
iMinutesElapsedint The amount of time required for the work.
sCurrencyString Currency.

SOAPjobStatus

The table below describes the SOAPjobStatus data type.


MemberTypeDescription
sJobReference string Reference of the translation job.
sSourceLng string Source language.
sTargetLng string Target language.
sSpecialism string Specialism.
iWOrdCount int Number of words to translate.
sOriginalFilename string File name of the document to be translated.
dtJobSubmitted DateTime Date and time of the job uploading.
dtJobDeadline DateTime Date and time of the job deadline.
sStatus string Status of the job.

SOAPUserSettings

The table below describes the SOAPUserSettings data type.


MemberTypeDescription
idDefaultLngTranslateFrom int Default setting for user: ID of language to translate from.
idDefaultLngTranslateInto int Default setting for user: ID of language to translate into.
idDefaultDocumentType string Default setting for user: ID of specialism.
iWordCount int Default setting for user: wordcount.
sAdditionalDescription string Default setting for user: additional description.
bTranslatePartialDocument bool Default setting for user: translate partial document flag.
sPrefix string Default setting for user: prefix.
sPostfix string Default setting for user: postfix.
bSpecailReview bool Default setting for user: special review.

SOAPresponse

The table below describes the SOAPresponse data type.


MemberTypeDescription
requestSuccesful bool Indicates whether the request to start a new order is successful or not.
id string An ID which can have different meanings, described by the id_description parameter.
id_description string Describes the meaning of the id member.
m_errors SOAPerror If any error occurs, then the error will be detailed in this member.
m_quotes SOAPquote[ ] An array with the quotes.
m_jobsStatus SOAPjobStatus[ ] An array with the job status.
m_UserSettings SOAPUserSettings An object with the user’s default settings. It helps making more user-friendly applications.

SOAPlanguage

The table below describes the SOAPlanguage data type.


MemberTypeDescription
languageID Int ID of the language or specialism.
Description String The name of the language or specialism.

SOAPspeciality

The table below describes the SOAPspeciality data type.


MemberTypeDescription
specialityID Int ID of the speciality.
Description String The name of the speciality.

AuthenticationHeader

The table below describes the AuthenticationHeader data type.


MemberTypeDescription
Username String The username used to access TranslateMedia’s system.
APIKey String The API Key.

AuthenticationToken

The table below describes the AuthenticationToken data type.


MemberTypeDescription
TokenValue String The value of the emitted authentication token.
authenticationSuccessful bool Indicates if the authentication was successful.
m_errors SOAPerror A SOAPerror object containing information regarding possible errors during authentication.

Code lists


Specialities codes list

The table below shows the existing specialities codes. The specialities codes list can be obtained by calling the GetSpecialitiesLists method.


CodeDescription
11Medical
12Legal
13Finance
14Marketing
15Technical
16General

Languages codes list

The table below shows the existing languages codes. The languages codes list can be obtained by calling the GetLanguagesList method.


CodeDescription
91Afrikaans
52Afrikaans.abc
210Akan
78Albanian
104Amharic
31Arabic
199Arabic (Morocco)
191Arabic (Algeria)
192Arabic (Bahrain & Oman)
193Arabic (Egypt)
194Arabic (Iraq)
195Arabic (Jordan)
196Arabic (Kuwait)
197Arabic (Lebanon)
198Arabic (Libya)
200Arabic (Palestine)
201Arabic (Saudi Arabia)
202Arabic (Sudan)
203Arabic (Syria)
204Arabic (Tunisia)
206Arabic (United Arab Emirates)
205Arabic (Yemen)
102Armenian
54Armenian.ZZZ
55Armenian.ZZZ
133Assamese
183Assyrian
103Azerbaijani
139Bahasa (Indonesia)
138Bahasa (Malaysia)
171Bambara
125Basque
122Belarussian
62Bengali
144Bicolano/Bicol
94Bosnian
67Bulgarian
177Burmese
46Catalan
142Cebuano/Bisaya
82Chinese (SIMP)
81Chinese (TRAD Hong Kong)
176Chinese (TRAD Taiwan)
32Chinese.abc
86Croatian
79Czech
33Danish
121Dari
101Duala
34Dutch
51Dutch.yyy
35English
168English (Aus)
105English (US)
57English.bna
68Estonian
212Ewe
211Fante
72Farsi
148Filipino
CodeDescription
36Finnish
98Flemish
37French
109French (BE)
106French (CA)
112French (CH)
213Ga
137Gaelic
124Galician
108Georgian
38German
113German (AT)
114German (CH)
39Greek
66Gujarati
135Haitian Creole
209Hausa
61Hebrew
65Hindi
184Hmong
69Hungarian
88Icelandic
208Igbo
145Ilocano/Iloko
147Ilonggo
73Indonesian
40Italian
152Italian (CH)
53Italian.abc
41Japanese
162Javanese
119Kannada
146Kapampangan/Pampango
128Kashmiri
115Kazakh
117Khmer
185Kinyarwanda
42Korean
118Kurdish
186Kutchi
188Kyrgyz
95Lao
149Latin
70Latvian
99Lingala
71Lithuanian
155Luxembourg
92Macedonian
150Malagasy
90Malay
129Malayalam
87Maltese
120Marathi
156Moldavian
126Mongolian
165Montenegrin
187Navajo
172Ndebele
134Nepalese
84Norwegian
CodeDescription
130Oriya
96Pashto
50Polish
43Portuguese
83Portuguese (BR)
63Punjabi
59Romanian
44Russian
131Sanskrit
85Serbian
157Sesotho
174Shona
178Sinhalese
173Siswati
74Slovak
75Slovenian
77Somali
136Soninké
207Sorani
175Sotho
45Spanish
158Spanish (Arg)
179Spanish (Chile)
163Spanish (Col)
161Spanish (CRica)
80Spanish (LatAm)
159Spanish (Mex)
164Spanish (Peru)
160Spanish (PtRico)
180Spanish (Urug)
123Spanish (US)
181Spanish (Venez)
56Spanish.bna
107Swahili
47Swedish
151Swedish (FI)
97Tagalog
190Tajik
76Tamil
132Telugu
154Tetum
93Thai
167Tibetan
153Tigrinya
169Tshivenda
170Tswana
48Turkish
189Turkmen
110Twi
89Ukrainian
64Urdu
166Uyghur
116Uzbek
127Valencian
58Vietnamese
143Waray
49Welsh
100Wolof
141Xhosa
111Yoruba
140Zulu