GatewayInterfaceManagement Web Service

GatewayInterfaceManagement

Click here for a complete list of operations.

InitiateAccountTransaction

Start Account Changes with AccountSetup create

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 /Gateway3/GatewayInterfaceManagement.asmx HTTP/1.1
Host: gateway.pharmx.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.pharmx.com.au/gateway3/gatewayinterfacemanagement/InitiateAccountTransaction"

<?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>
    <InitiateAccountTransaction xmlns="http://www.pharmx.com.au/gateway3/gatewayinterfacemanagement">
      <userDetail>
        <Username>string</Username>
        <Password>string</Password>
        <ApplicationId>int</ApplicationId>
        <ApplicationVersionNumber>int</ApplicationVersionNumber>
        <Extension1>string</Extension1>
        <Extension2>string</Extension2>
      </userDetail>
      <account>
        <ChangeAction>unsignedByte</ChangeAction>
        <ChangeStatus>string</ChangeStatus>
        <ChangePending>string</ChangePending>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <AccountNumber>string</AccountNumber>
        <PharmacyName>string</PharmacyName>
        <MaxOrdersPerMonth>int</MaxOrdersPerMonth>
        <MinimumOrderValue>decimal</MinimumOrderValue>
        <FreightCosts>decimal</FreightCosts>
        <Note>string</Note>
        <AccountSetupId>guid</AccountSetupId>
        <BillToAccountNumber>string</BillToAccountNumber>
        <WithSupplier>boolean</WithSupplier>
        <WithVendor>boolean</WithVendor>
        <PaymentType>Credit or Prepaid</PaymentType>
        <SiteId>int</SiteId>
      </account>
    </InitiateAccountTransaction>
  </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>
    <InitiateAccountTransactionResponse xmlns="http://www.pharmx.com.au/gateway3/gatewayinterfacemanagement">
      <InitiateAccountTransactionResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </InitiateAccountTransactionResult>
    </InitiateAccountTransactionResponse>
  </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 /Gateway3/GatewayInterfaceManagement.asmx HTTP/1.1
Host: gateway.pharmx.com.au
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>
    <InitiateAccountTransaction xmlns="http://www.pharmx.com.au/gateway3/gatewayinterfacemanagement">
      <userDetail>
        <Username>string</Username>
        <Password>string</Password>
        <ApplicationId>int</ApplicationId>
        <ApplicationVersionNumber>int</ApplicationVersionNumber>
        <Extension1>string</Extension1>
        <Extension2>string</Extension2>
      </userDetail>
      <account>
        <ChangeAction>unsignedByte</ChangeAction>
        <ChangeStatus>string</ChangeStatus>
        <ChangePending>string</ChangePending>
        <SupplierId>int</SupplierId>
        <StateSupplierId>int</StateSupplierId>
        <AccountNumber>string</AccountNumber>
        <PharmacyName>string</PharmacyName>
        <MaxOrdersPerMonth>int</MaxOrdersPerMonth>
        <MinimumOrderValue>decimal</MinimumOrderValue>
        <FreightCosts>decimal</FreightCosts>
        <Note>string</Note>
        <AccountSetupId>guid</AccountSetupId>
        <BillToAccountNumber>string</BillToAccountNumber>
        <WithSupplier>boolean</WithSupplier>
        <WithVendor>boolean</WithVendor>
        <PaymentType>Credit or Prepaid</PaymentType>
        <SiteId>int</SiteId>
      </account>
    </InitiateAccountTransaction>
  </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>
    <InitiateAccountTransactionResponse xmlns="http://www.pharmx.com.au/gateway3/gatewayinterfacemanagement">
      <InitiateAccountTransactionResult>
        <Success>boolean</Success>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <DocumentCount>int</DocumentCount>
        <Documents>
          <DocumentType />
          <DocumentType />
        </Documents>
      </InitiateAccountTransactionResult>
    </InitiateAccountTransactionResponse>
  </soap12:Body>
</soap12:Envelope>