VT_API


Click here for a complete list of operations.

SearchForSurname

Gets a list of clients with a surname containing the specified search string, up to the specified maximum number of clients

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

<?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>
    <SearchForSurname xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sSearchString>string</sSearchString>
      <iMaxRecords>int</iMaxRecords>
    </SearchForSurname>
  </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>
    <SearchForSurnameResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <SearchForSurnameResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ClieList>
          <TClie>
            <Clie_Surname>string</Clie_Surname>
            <Clie_Given>string</Clie_Given>
            <Clie_Code>string</Clie_Code>
          </TClie>
          <TClie>
            <Clie_Surname>string</Clie_Surname>
            <Clie_Given>string</Clie_Given>
            <Clie_Code>string</Clie_Code>
          </TClie>
        </ClieList>
      </SearchForSurnameResult>
    </SearchForSurnameResponse>
  </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 /VET_VETENROL_API/vt_api.asmx HTTP/1.1
Host: sthservices.ozsoft.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>
    <SearchForSurname xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sSearchString>string</sSearchString>
      <iMaxRecords>int</iMaxRecords>
    </SearchForSurname>
  </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>
    <SearchForSurnameResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <SearchForSurnameResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ClieList>
          <TClie>
            <Clie_Surname>string</Clie_Surname>
            <Clie_Given>string</Clie_Given>
            <Clie_Code>string</Clie_Code>
          </TClie>
          <TClie>
            <Clie_Surname>string</Clie_Surname>
            <Clie_Given>string</Clie_Given>
            <Clie_Code>string</Clie_Code>
          </TClie>
        </ClieList>
      </SearchForSurnameResult>
    </SearchForSurnameResponse>
  </soap12:Body>
</soap12:Envelope>