API2


Click here for a complete list of operations.

Authenticate

Authenticates an user and returns the authentication token

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /API2.asmx HTTP/1.1
Host: test.tm-stream.com
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>
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>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /API2.asmx HTTP/1.1
Host: test.tm-stream.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthenticationHeader xmlns="https://services.translatemedia.com">
      <Username>string</Username>
      <ApiKey>string</ApiKey>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <Authenticate xmlns="https://services.translatemedia.com" />
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12: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>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /API2.asmx/Authenticate? HTTP/1.1
Host: test.tm-stream.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<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>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /API2.asmx/Authenticate HTTP/1.1
Host: test.tm-stream.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length


HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<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>