VT_API


Click here for a complete list of operations.

SearchWebOccurrences

Searches for web-published occurrences with available places

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

<?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>
    <SearchWebOccurrences xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <programmeId>int</programmeId>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <overlapDates>boolean</overlapDates>
      <locationCode>string</locationCode>
      <returnOccurrenceLists>
        <string>string</string>
        <string>string</string>
      </returnOccurrenceLists>
      <includeFull>boolean</includeFull>
    </SearchWebOccurrences>
  </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>
    <SearchWebOccurrencesResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <SearchWebOccurrencesResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <OccuExtendedList>
          <TOccuExtended>
            <OccurrenceDetail xsi:nil="true" />
            <Classes xsi:nil="true" />
            <Prices xsi:nil="true" />
            <Staff xsi:nil="true" />
            <StudyReasons xsi:nil="true" />
            <Tasks xsi:nil="true" />
            <Units xsi:nil="true" />
          </TOccuExtended>
          <TOccuExtended>
            <OccurrenceDetail xsi:nil="true" />
            <Classes xsi:nil="true" />
            <Prices xsi:nil="true" />
            <Staff xsi:nil="true" />
            <StudyReasons xsi:nil="true" />
            <Tasks xsi:nil="true" />
            <Units xsi:nil="true" />
          </TOccuExtended>
        </OccuExtendedList>
      </SearchWebOccurrencesResult>
    </SearchWebOccurrencesResponse>
  </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>
    <SearchWebOccurrences xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <programmeId>int</programmeId>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <overlapDates>boolean</overlapDates>
      <locationCode>string</locationCode>
      <returnOccurrenceLists>
        <string>string</string>
        <string>string</string>
      </returnOccurrenceLists>
      <includeFull>boolean</includeFull>
    </SearchWebOccurrences>
  </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>
    <SearchWebOccurrencesResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <SearchWebOccurrencesResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <OccuExtendedList>
          <TOccuExtended>
            <OccurrenceDetail xsi:nil="true" />
            <Classes xsi:nil="true" />
            <Prices xsi:nil="true" />
            <Staff xsi:nil="true" />
            <StudyReasons xsi:nil="true" />
            <Tasks xsi:nil="true" />
            <Units xsi:nil="true" />
          </TOccuExtended>
          <TOccuExtended>
            <OccurrenceDetail xsi:nil="true" />
            <Classes xsi:nil="true" />
            <Prices xsi:nil="true" />
            <Staff xsi:nil="true" />
            <StudyReasons xsi:nil="true" />
            <Tasks xsi:nil="true" />
            <Units xsi:nil="true" />
          </TOccuExtended>
        </OccuExtendedList>
      </SearchWebOccurrencesResult>
    </SearchWebOccurrencesResponse>
  </soap12:Body>
</soap12:Envelope>