The TraceGains V7 SOAP Business Rules API.
Click here for a complete list of operations.
AddRule
Adds a new rule to an existing Business Rule Header.
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/AddRule" <?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> <AddRule xmlns="https://api.tracegains.net/v7/soap"> <appKey>guid</appKey> <sessionId>guid</sessionId> <businessRuleHeaderId>int</businessRuleHeaderId> <rule> <ID>int</ID> <Status>None or OutSpec or Warning</Status> <Action>None or Accept or Ask or Hold or Reject</Action> <Notification>string</Notification> <ForegroundColor>string</ForegroundColor> <BackgroundColor>string</BackgroundColor> <IsElseRule>boolean</IsElseRule> <Min>string</Min> <Max>string</Max> <Value>string</Value> </rule> </AddRule> </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> <AddRuleResponse xmlns="https://api.tracegains.net/v7/soap"> <AddRuleResult /> </AddRuleResponse> </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> <AddRule xmlns="https://api.tracegains.net/v7/soap"> <appKey>guid</appKey> <sessionId>guid</sessionId> <businessRuleHeaderId>int</businessRuleHeaderId> <rule> <ID>int</ID> <Status>None or OutSpec or Warning</Status> <Action>None or Accept or Ask or Hold or Reject</Action> <Notification>string</Notification> <ForegroundColor>string</ForegroundColor> <BackgroundColor>string</BackgroundColor> <IsElseRule>boolean</IsElseRule> <Min>string</Min> <Max>string</Max> <Value>string</Value> </rule> </AddRule> </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> <AddRuleResponse xmlns="https://api.tracegains.net/v7/soap"> <AddRuleResult /> </AddRuleResponse> </soap12:Body> </soap12:Envelope>