VT_API Web Service

VT_API

Click here for a complete list of operations.

GetEmployeeEnrolmentsForEmployerEnrolment

Gets a list of client enrolments for employees enrolled for an employer in an occurrence or booking

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

<?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>
    <GetEmployeeEnrolmentsForEmployerEnrolment xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <employerIdentifier>string</employerIdentifier>
      <occurrenceId>int</occurrenceId>
    </GetEmployeeEnrolmentsForEmployerEnrolment>
  </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>
    <GetEmployeeEnrolmentsForEmployerEnrolmentResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetEmployeeEnrolmentsForEmployerEnrolmentResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ClieEnroList>
          <TClieEnro>
            <Clie_Code>string</Clie_Code>
            <GivenName>string</GivenName>
            <Surname>string</Surname>
          </TClieEnro>
          <TClieEnro>
            <Clie_Code>string</Clie_Code>
            <GivenName>string</GivenName>
            <Surname>string</Surname>
          </TClieEnro>
        </ClieEnroList>
      </GetEmployeeEnrolmentsForEmployerEnrolmentResult>
    </GetEmployeeEnrolmentsForEmployerEnrolmentResponse>
  </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>
    <GetEmployeeEnrolmentsForEmployerEnrolment xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <employerIdentifier>string</employerIdentifier>
      <occurrenceId>int</occurrenceId>
    </GetEmployeeEnrolmentsForEmployerEnrolment>
  </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>
    <GetEmployeeEnrolmentsForEmployerEnrolmentResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetEmployeeEnrolmentsForEmployerEnrolmentResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ClieEnroList>
          <TClieEnro>
            <Clie_Code>string</Clie_Code>
            <GivenName>string</GivenName>
            <Surname>string</Surname>
          </TClieEnro>
          <TClieEnro>
            <Clie_Code>string</Clie_Code>
            <GivenName>string</GivenName>
            <Surname>string</Surname>
          </TClieEnro>
        </ClieEnroList>
      </GetEmployeeEnrolmentsForEmployerEnrolmentResult>
    </GetEmployeeEnrolmentsForEmployerEnrolmentResponse>
  </soap12:Body>
</soap12:Envelope>