VT_API


Click here for a complete list of operations.

GetUnitStateDetails

Gets the state-based details for a unit or module

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

<?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>
    <GetUnitStateDetails xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <unitCode>string</unitCode>
    </GetUnitStateDetails>
  </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>
    <GetUnitStateDetailsResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetUnitStateDetailsResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <UnitStateList>
          <TUnitState>
            <UnitCode>string</UnitCode>
            <StateShortName>string</StateShortName>
            <Hours>int</Hours>
            <PointScore>int</PointScore>
            <Amount>decimal</Amount>
            <ExpiryMonths>int</ExpiryMonths>
          </TUnitState>
          <TUnitState>
            <UnitCode>string</UnitCode>
            <StateShortName>string</StateShortName>
            <Hours>int</Hours>
            <PointScore>int</PointScore>
            <Amount>decimal</Amount>
            <ExpiryMonths>int</ExpiryMonths>
          </TUnitState>
        </UnitStateList>
      </GetUnitStateDetailsResult>
    </GetUnitStateDetailsResponse>
  </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>
    <GetUnitStateDetails xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <unitCode>string</unitCode>
    </GetUnitStateDetails>
  </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>
    <GetUnitStateDetailsResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetUnitStateDetailsResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <UnitStateList>
          <TUnitState>
            <UnitCode>string</UnitCode>
            <StateShortName>string</StateShortName>
            <Hours>int</Hours>
            <PointScore>int</PointScore>
            <Amount>decimal</Amount>
            <ExpiryMonths>int</ExpiryMonths>
          </TUnitState>
          <TUnitState>
            <UnitCode>string</UnitCode>
            <StateShortName>string</StateShortName>
            <Hours>int</Hours>
            <PointScore>int</PointScore>
            <Amount>decimal</Amount>
            <ExpiryMonths>int</ExpiryMonths>
          </TUnitState>
        </UnitStateList>
      </GetUnitStateDetailsResult>
    </GetUnitStateDetailsResponse>
  </soap12:Body>
</soap12:Envelope>