ThirdPartyInterface Web Service

ThirdPartyInterface

Click here for a complete list of operations.

CreateOrUpdateOrder

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/CreateOrUpdateOrder"

<?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>
    <CreateOrUpdateOrder xmlns="http://tempuri.org/">
      <userName>string</userName>
      <password>string</password>
      <order>
        <IsDeleted>boolean</IsDeleted>
        <Planned>boolean</Planned>
        <PlannedReasons>string</PlannedReasons>
        <OrderNumber>string</OrderNumber>
        <CustomerNumber>string</CustomerNumber>
        <SubContractorCustomerNumber>string</SubContractorCustomerNumber>
        <CustomerReference>string</CustomerReference>
        <EntriesCompleteAfterFirstUse>boolean</EntriesCompleteAfterFirstUse>
        <MaxAllocation>decimal</MaxAllocation>
        <SubContractorAccepted>boolean</SubContractorAccepted>
        <SubContractorDeclined>boolean</SubContractorDeclined>
        <StatusTitle>string</StatusTitle>
        <Entries>
          <OrderEntrySerializable>
            <IsDeleted>boolean</IsDeleted>
            <Position>int</Position>
            <SupplierNumber>int</SupplierNumber>
            <ProductCode>string</ProductCode>
            <VehicleRegistration>string</VehicleRegistration>
            <CardNumber>string</CardNumber>
            <DriverCellNumber>string</DriverCellNumber>
            <CurrentVirtualCardNumber>string</CurrentVirtualCardNumber>
            <MaxAllocation>decimal</MaxAllocation>
            <ValidDateStart>dateTime</ValidDateStart>
            <ValidDateEnd>dateTime</ValidDateEnd>
            <CustomerReference>string</CustomerReference>
            <LinkedTransactions xsi:nil="true" />
          </OrderEntrySerializable>
          <OrderEntrySerializable>
            <IsDeleted>boolean</IsDeleted>
            <Position>int</Position>
            <SupplierNumber>int</SupplierNumber>
            <ProductCode>string</ProductCode>
            <VehicleRegistration>string</VehicleRegistration>
            <CardNumber>string</CardNumber>
            <DriverCellNumber>string</DriverCellNumber>
            <CurrentVirtualCardNumber>string</CurrentVirtualCardNumber>
            <MaxAllocation>decimal</MaxAllocation>
            <ValidDateStart>dateTime</ValidDateStart>
            <ValidDateEnd>dateTime</ValidDateEnd>
            <CustomerReference>string</CustomerReference>
            <LinkedTransactions xsi:nil="true" />
          </OrderEntrySerializable>
        </Entries>
      </order>
      <newRecordIdentifier>guid</newRecordIdentifier>
    </CreateOrUpdateOrder>
  </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>
    <CreateOrUpdateOrderResponse xmlns="http://tempuri.org/">
      <CreateOrUpdateOrderResult>
        <ValidationResult>Successful or InvalidVehicle or InvalidDriver or InvalidCustomer or InvalidSubContractor or InvalidProduct or InvalidDepot or InvalidOrderNumber or InvalidOrderID or InvalidOrderEntryID or InvalidOrderEntry or MixedCardAndVirtualCardEntries or InvalidSubContractorAccepted or NoEntries or OrderEntryWithActivityRemoved or InvalidMaxAllocation or InvalidDates or RequireUniqueOrderReference or OrdersNotEnabled or UnspecifiedError or DormantDepot or OrderLimitViolation or OrderComplete or OrderEntryComplete</ValidationResult>
        <Order>
          <IsDeleted>boolean</IsDeleted>
          <Planned>boolean</Planned>
          <PlannedReasons>string</PlannedReasons>
          <OrderNumber>string</OrderNumber>
          <CustomerNumber>string</CustomerNumber>
          <SubContractorCustomerNumber>string</SubContractorCustomerNumber>
          <CustomerReference>string</CustomerReference>
          <EntriesCompleteAfterFirstUse>boolean</EntriesCompleteAfterFirstUse>
          <MaxAllocation>decimal</MaxAllocation>
          <SubContractorAccepted>boolean</SubContractorAccepted>
          <SubContractorDeclined>boolean</SubContractorDeclined>
          <StatusTitle>string</StatusTitle>
          <Entries>
            <OrderEntrySerializable xsi:nil="true" />
            <OrderEntrySerializable xsi:nil="true" />
          </Entries>
        </Order>
        <Message>string</Message>
      </CreateOrUpdateOrderResult>
    </CreateOrUpdateOrderResponse>
  </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>
    <CreateOrUpdateOrder xmlns="http://tempuri.org/">
      <userName>string</userName>
      <password>string</password>
      <order>
        <IsDeleted>boolean</IsDeleted>
        <Planned>boolean</Planned>
        <PlannedReasons>string</PlannedReasons>
        <OrderNumber>string</OrderNumber>
        <CustomerNumber>string</CustomerNumber>
        <SubContractorCustomerNumber>string</SubContractorCustomerNumber>
        <CustomerReference>string</CustomerReference>
        <EntriesCompleteAfterFirstUse>boolean</EntriesCompleteAfterFirstUse>
        <MaxAllocation>decimal</MaxAllocation>
        <SubContractorAccepted>boolean</SubContractorAccepted>
        <SubContractorDeclined>boolean</SubContractorDeclined>
        <StatusTitle>string</StatusTitle>
        <Entries>
          <OrderEntrySerializable>
            <IsDeleted>boolean</IsDeleted>
            <Position>int</Position>
            <SupplierNumber>int</SupplierNumber>
            <ProductCode>string</ProductCode>
            <VehicleRegistration>string</VehicleRegistration>
            <CardNumber>string</CardNumber>
            <DriverCellNumber>string</DriverCellNumber>
            <CurrentVirtualCardNumber>string</CurrentVirtualCardNumber>
            <MaxAllocation>decimal</MaxAllocation>
            <ValidDateStart>dateTime</ValidDateStart>
            <ValidDateEnd>dateTime</ValidDateEnd>
            <CustomerReference>string</CustomerReference>
            <LinkedTransactions xsi:nil="true" />
          </OrderEntrySerializable>
          <OrderEntrySerializable>
            <IsDeleted>boolean</IsDeleted>
            <Position>int</Position>
            <SupplierNumber>int</SupplierNumber>
            <ProductCode>string</ProductCode>
            <VehicleRegistration>string</VehicleRegistration>
            <CardNumber>string</CardNumber>
            <DriverCellNumber>string</DriverCellNumber>
            <CurrentVirtualCardNumber>string</CurrentVirtualCardNumber>
            <MaxAllocation>decimal</MaxAllocation>
            <ValidDateStart>dateTime</ValidDateStart>
            <ValidDateEnd>dateTime</ValidDateEnd>
            <CustomerReference>string</CustomerReference>
            <LinkedTransactions xsi:nil="true" />
          </OrderEntrySerializable>
        </Entries>
      </order>
      <newRecordIdentifier>guid</newRecordIdentifier>
    </CreateOrUpdateOrder>
  </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>
    <CreateOrUpdateOrderResponse xmlns="http://tempuri.org/">
      <CreateOrUpdateOrderResult>
        <ValidationResult>Successful or InvalidVehicle or InvalidDriver or InvalidCustomer or InvalidSubContractor or InvalidProduct or InvalidDepot or InvalidOrderNumber or InvalidOrderID or InvalidOrderEntryID or InvalidOrderEntry or MixedCardAndVirtualCardEntries or InvalidSubContractorAccepted or NoEntries or OrderEntryWithActivityRemoved or InvalidMaxAllocation or InvalidDates or RequireUniqueOrderReference or OrdersNotEnabled or UnspecifiedError or DormantDepot or OrderLimitViolation or OrderComplete or OrderEntryComplete</ValidationResult>
        <Order>
          <IsDeleted>boolean</IsDeleted>
          <Planned>boolean</Planned>
          <PlannedReasons>string</PlannedReasons>
          <OrderNumber>string</OrderNumber>
          <CustomerNumber>string</CustomerNumber>
          <SubContractorCustomerNumber>string</SubContractorCustomerNumber>
          <CustomerReference>string</CustomerReference>
          <EntriesCompleteAfterFirstUse>boolean</EntriesCompleteAfterFirstUse>
          <MaxAllocation>decimal</MaxAllocation>
          <SubContractorAccepted>boolean</SubContractorAccepted>
          <SubContractorDeclined>boolean</SubContractorDeclined>
          <StatusTitle>string</StatusTitle>
          <Entries>
            <OrderEntrySerializable xsi:nil="true" />
            <OrderEntrySerializable xsi:nil="true" />
          </Entries>
        </Order>
        <Message>string</Message>
      </CreateOrUpdateOrderResult>
    </CreateOrUpdateOrderResponse>
  </soap12:Body>
</soap12:Envelope>