VT_API Web Service

VT_API

Click here for a complete list of operations.

GetSuburbList

Gets a list of suburbs, optionally for a state and/or that have been modified since a date

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 /VT_API.asmx HTTP/1.1
Host: vettrak.jmdr.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.ozsoft.com.au/VETtrak/api/complete/GetSuburbList"

<?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>
    <GetSuburbList xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <state>string</state>
      <sinceDate>dateTime</sinceDate>
    </GetSuburbList>
  </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>
    <GetSuburbListResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetSuburbListResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <SuburbList>
          <TSuburb>
            <SuburbId>int</SuburbId>
            <Code>string</Code>
            <Name>string</Name>
            <State>string</State>
          </TSuburb>
          <TSuburb>
            <SuburbId>int</SuburbId>
            <Code>string</Code>
            <Name>string</Name>
            <State>string</State>
          </TSuburb>
        </SuburbList>
      </GetSuburbListResult>
    </GetSuburbListResponse>
  </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 /VT_API.asmx HTTP/1.1
Host: vettrak.jmdr.com
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>
    <GetSuburbList xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <state>string</state>
      <sinceDate>dateTime</sinceDate>
    </GetSuburbList>
  </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>
    <GetSuburbListResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetSuburbListResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <SuburbList>
          <TSuburb>
            <SuburbId>int</SuburbId>
            <Code>string</Code>
            <Name>string</Name>
            <State>string</State>
          </TSuburb>
          <TSuburb>
            <SuburbId>int</SuburbId>
            <Code>string</Code>
            <Name>string</Name>
            <State>string</State>
          </TSuburb>
        </SuburbList>
      </GetSuburbListResult>
    </GetSuburbListResponse>
  </soap12:Body>
</soap12:Envelope>