VT_API Web Service

VT_API

Click here for a complete list of operations.

SearchForEmployer

Gets a list of employers with a name matching the specified search string, optionally 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/SearchForEmployer"

<?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>
    <SearchForEmployer xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <searchString>string</searchString>
      <searchOption>int</searchOption>
      <sinceDate>dateTime</sinceDate>
    </SearchForEmployer>
  </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>
    <SearchForEmployerResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <SearchForEmployerResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <EmplList>
          <TEmpl>
            <Empl_Identifier>string</Empl_Identifier>
            <Emty_Code>string</Emty_Code>
            <Anzs_Code>string</Anzs_Code>
            <Empl_Name>string</Empl_Name>
            <Empl_LegalName>string</Empl_LegalName>
            <Empl_EmployerSize>int</Empl_EmployerSize>
            <Empl_BAddr>string</Empl_BAddr>
            <Empl_BCity>string</Empl_BCity>
            <Empl_BPCode>string</Empl_BPCode>
            <BusinessState>string</BusinessState>
            <Empl_PAddr>string</Empl_PAddr>
            <Empl_PCity>string</Empl_PCity>
            <Empl_PPCode>string</Empl_PPCode>
            <PostalState>string</PostalState>
            <Empl_Phone>string</Empl_Phone>
            <Empl_Fax>string</Empl_Fax>
            <Empl_Mobile>string</Empl_Mobile>
            <Empl_Email>string</Empl_Email>
            <Empl_ACN>string</Empl_ACN>
            <Empl_ABN>string</Empl_ABN>
            <Empl_Active>int</Empl_Active>
            <Empl_Parent>string</Empl_Parent>
            <ParentName>string</ParentName>
            <Empl_Type>int</Empl_Type>
            <Empl_Code>string</Empl_Code>
            <URL>string</URL>
            <BusinessAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
          </TEmpl>
          <TEmpl>
            <Empl_Identifier>string</Empl_Identifier>
            <Emty_Code>string</Emty_Code>
            <Anzs_Code>string</Anzs_Code>
            <Empl_Name>string</Empl_Name>
            <Empl_LegalName>string</Empl_LegalName>
            <Empl_EmployerSize>int</Empl_EmployerSize>
            <Empl_BAddr>string</Empl_BAddr>
            <Empl_BCity>string</Empl_BCity>
            <Empl_BPCode>string</Empl_BPCode>
            <BusinessState>string</BusinessState>
            <Empl_PAddr>string</Empl_PAddr>
            <Empl_PCity>string</Empl_PCity>
            <Empl_PPCode>string</Empl_PPCode>
            <PostalState>string</PostalState>
            <Empl_Phone>string</Empl_Phone>
            <Empl_Fax>string</Empl_Fax>
            <Empl_Mobile>string</Empl_Mobile>
            <Empl_Email>string</Empl_Email>
            <Empl_ACN>string</Empl_ACN>
            <Empl_ABN>string</Empl_ABN>
            <Empl_Active>int</Empl_Active>
            <Empl_Parent>string</Empl_Parent>
            <ParentName>string</ParentName>
            <Empl_Type>int</Empl_Type>
            <Empl_Code>string</Empl_Code>
            <URL>string</URL>
            <BusinessAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
          </TEmpl>
        </EmplList>
      </SearchForEmployerResult>
    </SearchForEmployerResponse>
  </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 />
</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 />
</soap12:Envelope>