TraceGains SOAP API: Authentication

The TraceGains V7 SOAP Authentication API.

Click here for a complete list of operations.

Login

Returns a session ID from a registered Application and API key.


The test form is only available for requests from the local machine.

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 /v7/soap/Authentication.asmx HTTP/1.1
Host: api.tracegains.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.tracegains.net/v7/soap/Login"

<?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>
    <Login xmlns="https://api.tracegains.net/v7/soap">
      <appName>string</appName>
      <appKey>guid</appKey>
    </Login>
  </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>
    <LoginResponse xmlns="https://api.tracegains.net/v7/soap">
      <LoginResult>
        <Authenticated>boolean</Authenticated>
        <CustomerId>guid</CustomerId>
        <SessionId>guid</SessionId>
        <SessionExpires>dateTime</SessionExpires>
      </LoginResult>
    </LoginResponse>
  </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 /v7/soap/Authentication.asmx HTTP/1.1
Host: api.tracegains.net
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>
    <Login xmlns="https://api.tracegains.net/v7/soap">
      <appName>string</appName>
      <appKey>guid</appKey>
    </Login>
  </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>
    <LoginResponse xmlns="https://api.tracegains.net/v7/soap">
      <LoginResult>
        <Authenticated>boolean</Authenticated>
        <CustomerId>guid</CustomerId>
        <SessionId>guid</SessionId>
        <SessionExpires>dateTime</SessionExpires>
      </LoginResult>
    </LoginResponse>
  </soap12:Body>
</soap12:Envelope>