The TraceGains V7 SOAP QM Controls API.
Click here for a complete list of operations.
List
Returns a list of QM Control records using basic request parameters.
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/QmControls.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/List"
<?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>
<List xmlns="https://api.tracegains.net/v7/soap">
<appKey>guid</appKey>
<sessionId>guid</sessionId>
<fromModifiedDate>dateTime</fromModifiedDate>
<toModifiedDate>dateTime</toModifiedDate>
<pageCriteria>
<FirstResultIndex>int</FirstResultIndex>
<LastResultIndex>int</LastResultIndex>
</pageCriteria>
<attributeType>All or ValuesOnly or EmptyOnly or None</attributeType>
<attributeIds>
<string>string</string>
<string>string</string>
</attributeIds>
</List>
</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>
<ListResponse xmlns="https://api.tracegains.net/v7/soap">
<ListResult>
<Data>
<Control>
<ID>long</ID>
<ControlID>string</ControlID>
<ControlName>string</ControlName>
<PreshipSignoffID>long</PreshipSignoffID>
<VerifyValidateID>long</VerifyValidateID>
<Action>None or Accept or Ask or Hold or Reject</Action>
<Status>None or OutSpec or Warning</Status>
<Attributes>
<AttributeValue>
<ID>string</ID>
<Value>string</Value>
</AttributeValue>
<AttributeValue>
<ID>string</ID>
<Value>string</Value>
</AttributeValue>
</Attributes>
</Control>
<Control>
<ID>long</ID>
<ControlID>string</ControlID>
<ControlName>string</ControlName>
<PreshipSignoffID>long</PreshipSignoffID>
<VerifyValidateID>long</VerifyValidateID>
<Action>None or Accept or Ask or Hold or Reject</Action>
<Status>None or OutSpec or Warning</Status>
<Attributes>
<AttributeValue>
<ID>string</ID>
<Value>string</Value>
</AttributeValue>
<AttributeValue>
<ID>string</ID>
<Value>string</Value>
</AttributeValue>
</Attributes>
</Control>
</Data>
<PagingResponse>
<FirstResultIndex>int</FirstResultIndex>
<LastResultIndex>int</LastResultIndex>
<TotalResultCount>int</TotalResultCount>
</PagingResponse>
</ListResult>
</ListResponse>
</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/QmControls.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>
<List xmlns="https://api.tracegains.net/v7/soap">
<appKey>guid</appKey>
<sessionId>guid</sessionId>
<fromModifiedDate>dateTime</fromModifiedDate>
<toModifiedDate>dateTime</toModifiedDate>
<pageCriteria>
<FirstResultIndex>int</FirstResultIndex>
<LastResultIndex>int</LastResultIndex>
</pageCriteria>
<attributeType>All or ValuesOnly or EmptyOnly or None</attributeType>
<attributeIds>
<string>string</string>
<string>string</string>
</attributeIds>
</List>
</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>
<ListResponse xmlns="https://api.tracegains.net/v7/soap">
<ListResult>
<Data>
<Control>
<ID>long</ID>
<ControlID>string</ControlID>
<ControlName>string</ControlName>
<PreshipSignoffID>long</PreshipSignoffID>
<VerifyValidateID>long</VerifyValidateID>
<Action>None or Accept or Ask or Hold or Reject</Action>
<Status>None or OutSpec or Warning</Status>
<Attributes>
<AttributeValue>
<ID>string</ID>
<Value>string</Value>
</AttributeValue>
<AttributeValue>
<ID>string</ID>
<Value>string</Value>
</AttributeValue>
</Attributes>
</Control>
<Control>
<ID>long</ID>
<ControlID>string</ControlID>
<ControlName>string</ControlName>
<PreshipSignoffID>long</PreshipSignoffID>
<VerifyValidateID>long</VerifyValidateID>
<Action>None or Accept or Ask or Hold or Reject</Action>
<Status>None or OutSpec or Warning</Status>
<Attributes>
<AttributeValue>
<ID>string</ID>
<Value>string</Value>
</AttributeValue>
<AttributeValue>
<ID>string</ID>
<Value>string</Value>
</AttributeValue>
</Attributes>
</Control>
</Data>
<PagingResponse>
<FirstResultIndex>int</FirstResultIndex>
<LastResultIndex>int</LastResultIndex>
<TotalResultCount>int</TotalResultCount>
</PagingResponse>
</ListResult>
</ListResponse>
</soap12:Body>
</soap12:Envelope>