Documents Web Service

The TraceGains V7 SOAP Documents API.

Click here for a complete list of operations.

Create

Creates a new Document.

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/Documents.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/Create"

<?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>
    <Create xmlns="https://api.tracegains.net/v7/soap">
      <appKey>guid</appKey>
      <sessionId>guid</sessionId>
      <document>
        <ID>long</ID>
        <SupplierID>string</SupplierID>
        <ItemID>string</ItemID>
        <Type>string</Type>
        <Status>string</Status>
        <Workflow>string</Workflow>
        <EffectiveDate>dateTime</EffectiveDate>
        <ExpirationDate>dateTime</ExpirationDate>
        <DownloadLink>string</DownloadLink>
        <Description>string</Description>
        <FileName>string</FileName>
        <ByteArray>base64Binary</ByteArray>
        <CreationDate>dateTime</CreationDate>
        <CreatedBy>string</CreatedBy>
        <UpdatedDate>dateTime</UpdatedDate>
        <UpdatedBy>string</UpdatedBy>
      </document>
    </Create>
  </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>
    <CreateResponse xmlns="https://api.tracegains.net/v7/soap">
      <CreateResult />
    </CreateResponse>
  </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/Documents.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>
    <Create xmlns="https://api.tracegains.net/v7/soap">
      <appKey>guid</appKey>
      <sessionId>guid</sessionId>
      <document>
        <ID>long</ID>
        <SupplierID>string</SupplierID>
        <ItemID>string</ItemID>
        <Type>string</Type>
        <Status>string</Status>
        <Workflow>string</Workflow>
        <EffectiveDate>dateTime</EffectiveDate>
        <ExpirationDate>dateTime</ExpirationDate>
        <DownloadLink>string</DownloadLink>
        <Description>string</Description>
        <FileName>string</FileName>
        <ByteArray>base64Binary</ByteArray>
        <CreationDate>dateTime</CreationDate>
        <CreatedBy>string</CreatedBy>
        <UpdatedDate>dateTime</UpdatedDate>
        <UpdatedBy>string</UpdatedBy>
      </document>
    </Create>
  </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>
    <CreateResponse xmlns="https://api.tracegains.net/v7/soap">
      <CreateResult />
    </CreateResponse>
  </soap12:Body>
</soap12:Envelope>