VT_API


Click here for a complete list of operations.

GetWebEmployersForOccurrence

Gets a list of employers enrolled in all web enrolments against the specified occurrence ID

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

<?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>
    <GetWebEmployersForOccurrence xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <iOccu_ID>int</iOccu_ID>
    </GetWebEmployersForOccurrence>
  </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>
    <GetWebEmployersForOccurrenceResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetWebEmployersForOccurrenceResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <WecoList>
          <TWeco>
            <Weco_ID>int</Weco_ID>
            <Webe_ID>int</Webe_ID>
            <Identifier>string</Identifier>
            <Name>string</Name>
            <Addr>string</Addr>
            <City>string</City>
            <PCode>string</PCode>
            <Stat_ShortName>string</Stat_ShortName>
            <Phone>string</Phone>
            <Expected>int</Expected>
            <PostalAddr>string</PostalAddr>
            <PostalCity>string</PostalCity>
            <PostalPostcode>string</PostalPostcode>
            <PostalStat_ShortName>string</PostalStat_ShortName>
            <BusinessAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
          </TWeco>
          <TWeco>
            <Weco_ID>int</Weco_ID>
            <Webe_ID>int</Webe_ID>
            <Identifier>string</Identifier>
            <Name>string</Name>
            <Addr>string</Addr>
            <City>string</City>
            <PCode>string</PCode>
            <Stat_ShortName>string</Stat_ShortName>
            <Phone>string</Phone>
            <Expected>int</Expected>
            <PostalAddr>string</PostalAddr>
            <PostalCity>string</PostalCity>
            <PostalPostcode>string</PostalPostcode>
            <PostalStat_ShortName>string</PostalStat_ShortName>
            <BusinessAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
          </TWeco>
        </WecoList>
      </GetWebEmployersForOccurrenceResult>
    </GetWebEmployersForOccurrenceResponse>
  </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>
    <GetWebEmployersForOccurrence xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <iOccu_ID>int</iOccu_ID>
    </GetWebEmployersForOccurrence>
  </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>
    <GetWebEmployersForOccurrenceResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetWebEmployersForOccurrenceResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <WecoList>
          <TWeco>
            <Weco_ID>int</Weco_ID>
            <Webe_ID>int</Webe_ID>
            <Identifier>string</Identifier>
            <Name>string</Name>
            <Addr>string</Addr>
            <City>string</City>
            <PCode>string</PCode>
            <Stat_ShortName>string</Stat_ShortName>
            <Phone>string</Phone>
            <Expected>int</Expected>
            <PostalAddr>string</PostalAddr>
            <PostalCity>string</PostalCity>
            <PostalPostcode>string</PostalPostcode>
            <PostalStat_ShortName>string</PostalStat_ShortName>
            <BusinessAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
          </TWeco>
          <TWeco>
            <Weco_ID>int</Weco_ID>
            <Webe_ID>int</Webe_ID>
            <Identifier>string</Identifier>
            <Name>string</Name>
            <Addr>string</Addr>
            <City>string</City>
            <PCode>string</PCode>
            <Stat_ShortName>string</Stat_ShortName>
            <Phone>string</Phone>
            <Expected>int</Expected>
            <PostalAddr>string</PostalAddr>
            <PostalCity>string</PostalCity>
            <PostalPostcode>string</PostalPostcode>
            <PostalStat_ShortName>string</PostalStat_ShortName>
            <BusinessAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
          </TWeco>
        </WecoList>
      </GetWebEmployersForOccurrenceResult>
    </GetWebEmployersForOccurrenceResponse>
  </soap12:Body>
</soap12:Envelope>