TraceGains SOAP API: BusinessRules

The TraceGains V7 SOAP Business Rules API.

Click here for a complete list of operations.

ListRuleColors

Returns the list of Business Rule foreground and background color options.


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/BusinessRules.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/ListRuleColors"

<?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>
    <ListRuleColors xmlns="https://api.tracegains.net/v7/soap">
      <appKey>guid</appKey>
      <sessionId>guid</sessionId>
    </ListRuleColors>
  </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>
    <ListRuleColorsResponse xmlns="https://api.tracegains.net/v7/soap">
      <ListRuleColorsResult>
        <Values>
          <string>string</string>
          <string>string</string>
        </Values>
      </ListRuleColorsResult>
    </ListRuleColorsResponse>
  </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/BusinessRules.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>
    <ListRuleColors xmlns="https://api.tracegains.net/v7/soap">
      <appKey>guid</appKey>
      <sessionId>guid</sessionId>
    </ListRuleColors>
  </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>
    <ListRuleColorsResponse xmlns="https://api.tracegains.net/v7/soap">
      <ListRuleColorsResult>
        <Values>
          <string>string</string>
          <string>string</string>
        </Values>
      </ListRuleColorsResult>
    </ListRuleColorsResponse>
  </soap12:Body>
</soap12:Envelope>