ThirdPartyInterface

Click here for a complete list of operations.

Depots

Test

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 /api/ThirdPartyInterface.asmx HTTP/1.1
Host: app.tfn.co.za
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/Depots"

<?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>
    <Depots xmlns="http://tempuri.org/">
      <userName>string</userName>
      <password>string</password>
      <customerNumber>string</customerNumber>
    </Depots>
  </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>
    <DepotsResponse xmlns="http://tempuri.org/">
      <DepotsResult>
        <DepotSerializable>
          <DepotID>guid</DepotID>
          <Number>int</Number>
          <Title>string</Title>
          <GPSLatitude>decimal</GPSLatitude>
          <GPSLongitude>decimal</GPSLongitude>
          <MarketingCategory>Refuel2Save or Standard or CrossBorder</MarketingCategory>
          <Products>
            <DepotProductSerializable xsi:nil="true" />
            <DepotProductSerializable xsi:nil="true" />
          </Products>
        </DepotSerializable>
        <DepotSerializable>
          <DepotID>guid</DepotID>
          <Number>int</Number>
          <Title>string</Title>
          <GPSLatitude>decimal</GPSLatitude>
          <GPSLongitude>decimal</GPSLongitude>
          <MarketingCategory>Refuel2Save or Standard or CrossBorder</MarketingCategory>
          <Products>
            <DepotProductSerializable xsi:nil="true" />
            <DepotProductSerializable xsi:nil="true" />
          </Products>
        </DepotSerializable>
      </DepotsResult>
    </DepotsResponse>
  </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 /api/ThirdPartyInterface.asmx HTTP/1.1
Host: app.tfn.co.za
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>
    <Depots xmlns="http://tempuri.org/">
      <userName>string</userName>
      <password>string</password>
      <customerNumber>string</customerNumber>
    </Depots>
  </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>
    <DepotsResponse xmlns="http://tempuri.org/">
      <DepotsResult>
        <DepotSerializable>
          <DepotID>guid</DepotID>
          <Number>int</Number>
          <Title>string</Title>
          <GPSLatitude>decimal</GPSLatitude>
          <GPSLongitude>decimal</GPSLongitude>
          <MarketingCategory>Refuel2Save or Standard or CrossBorder</MarketingCategory>
          <Products>
            <DepotProductSerializable xsi:nil="true" />
            <DepotProductSerializable xsi:nil="true" />
          </Products>
        </DepotSerializable>
        <DepotSerializable>
          <DepotID>guid</DepotID>
          <Number>int</Number>
          <Title>string</Title>
          <GPSLatitude>decimal</GPSLatitude>
          <GPSLongitude>decimal</GPSLongitude>
          <MarketingCategory>Refuel2Save or Standard or CrossBorder</MarketingCategory>
          <Products>
            <DepotProductSerializable xsi:nil="true" />
            <DepotProductSerializable xsi:nil="true" />
          </Products>
        </DepotSerializable>
      </DepotsResult>
    </DepotsResponse>
  </soap12:Body>
</soap12:Envelope>