VT_API Web Service

VT_API

Click here for a complete list of operations.

QueryAdditionalData

Generic function for getting VETtrak data

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

<?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>
    <QueryAdditionalData xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <entityName>string</entityName>
      <filterCriteria>
        <FilterCriteria>
          <Field>string</Field>
          <Operator>Equals or LessThan or GreaterThan or LessThanOrEqualTo or GreaterThanOrEqualTo or NotEqualTo or StartsWith or Contains</Operator>
          <Value>string</Value>
        </FilterCriteria>
        <FilterCriteria>
          <Field>string</Field>
          <Operator>Equals or LessThan or GreaterThan or LessThanOrEqualTo or GreaterThanOrEqualTo or NotEqualTo or StartsWith or Contains</Operator>
          <Value>string</Value>
        </FilterCriteria>
      </filterCriteria>
      <sortCriteria>
        <SortCriteria>
          <Field>string</Field>
          <Order>Ascending or Descending</Order>
        </SortCriteria>
        <SortCriteria>
          <Field>string</Field>
          <Order>Ascending or Descending</Order>
        </SortCriteria>
      </sortCriteria>
      <returnFields>
        <ReturnField>
          <Field>string</Field>
          <Aggregate>Count or Average or Sum or Min or Max</Aggregate>
        </ReturnField>
        <ReturnField>
          <Field>string</Field>
          <Aggregate>Count or Average or Sum or Min or Max</Aggregate>
        </ReturnField>
      </returnFields>
      <options>string</options>
    </QueryAdditionalData>
  </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>
    <QueryAdditionalDataResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <QueryAdditionalDataResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <Fields>
          <string>string</string>
          <string>string</string>
        </Fields>
        <Values>
          <ArrayOfString>
            <string>string</string>
            <string>string</string>
          </ArrayOfString>
          <ArrayOfString>
            <string>string</string>
            <string>string</string>
          </ArrayOfString>
        </Values>
      </QueryAdditionalDataResult>
    </QueryAdditionalDataResponse>
  </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>
    <QueryAdditionalData xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <entityName>string</entityName>
      <filterCriteria>
        <FilterCriteria>
          <Field>string</Field>
          <Operator>Equals or LessThan or GreaterThan or LessThanOrEqualTo or GreaterThanOrEqualTo or NotEqualTo or StartsWith or Contains</Operator>
          <Value>string</Value>
        </FilterCriteria>
        <FilterCriteria>
          <Field>string</Field>
          <Operator>Equals or LessThan or GreaterThan or LessThanOrEqualTo or GreaterThanOrEqualTo or NotEqualTo or StartsWith or Contains</Operator>
          <Value>string</Value>
        </FilterCriteria>
      </filterCriteria>
      <sortCriteria>
        <SortCriteria>
          <Field>string</Field>
          <Order>Ascending or Descending</Order>
        </SortCriteria>
        <SortCriteria>
          <Field>string</Field>
          <Order>Ascending or Descending</Order>
        </SortCriteria>
      </sortCriteria>
      <returnFields>
        <ReturnField>
          <Field>string</Field>
          <Aggregate>Count or Average or Sum or Min or Max</Aggregate>
        </ReturnField>
        <ReturnField>
          <Field>string</Field>
          <Aggregate>Count or Average or Sum or Min or Max</Aggregate>
        </ReturnField>
      </returnFields>
      <options>string</options>
    </QueryAdditionalData>
  </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>
    <QueryAdditionalDataResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <QueryAdditionalDataResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <Fields>
          <string>string</string>
          <string>string</string>
        </Fields>
        <Values>
          <ArrayOfString>
            <string>string</string>
            <string>string</string>
          </ArrayOfString>
          <ArrayOfString>
            <string>string</string>
            <string>string</string>
          </ArrayOfString>
        </Values>
      </QueryAdditionalDataResult>
    </QueryAdditionalDataResponse>
  </soap12:Body>
</soap12:Envelope>