VT_API


Click here for a complete list of operations.

GetContractsForStaff

Gets a list of trainees and their contracts assigned to the staff member with the specified client code

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

<?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>
    <GetContractsForStaff xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sClie_Code>string</sClie_Code>
    </GetContractsForStaff>
  </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>
    <GetContractsForStaffResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetContractsForStaffResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ContStaffList>
          <TContStaff>
            <Client xsi:nil="true" />
            <Contract xsi:nil="true" />
            <StaffRole xsi:nil="true" />
          </TContStaff>
          <TContStaff>
            <Client xsi:nil="true" />
            <Contract xsi:nil="true" />
            <StaffRole xsi:nil="true" />
          </TContStaff>
        </ContStaffList>
      </GetContractsForStaffResult>
    </GetContractsForStaffResponse>
  </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>
    <GetContractsForStaff xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sClie_Code>string</sClie_Code>
    </GetContractsForStaff>
  </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>
    <GetContractsForStaffResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetContractsForStaffResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ContStaffList>
          <TContStaff>
            <Client xsi:nil="true" />
            <Contract xsi:nil="true" />
            <StaffRole xsi:nil="true" />
          </TContStaff>
          <TContStaff>
            <Client xsi:nil="true" />
            <Contract xsi:nil="true" />
            <StaffRole xsi:nil="true" />
          </TContStaff>
        </ContStaffList>
      </GetContractsForStaffResult>
    </GetContractsForStaffResponse>
  </soap12:Body>
</soap12:Envelope>