VT_API Web Service

VT_API

Click here for a complete list of operations.

GetClassesForClient

Gets a list of classes (instances) for the client with the specified code in the specified date range

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

<?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>
    <GetClassesForClient xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sClie_Code>string</sClie_Code>
      <xsdStart>dateTime</xsdStart>
      <xsdEnd>dateTime</xsdEnd>
    </GetClassesForClient>
  </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>
    <GetClassesForClientResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetClassesForClientResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <InstList>
          <TInst>
            <Inst_ID>int</Inst_ID>
            <Enro_ID>int</Enro_ID>
            <Prog_Name>string</Prog_Name>
            <Inst_Start>dateTime</Inst_Start>
            <Inst_Finish>dateTime</Inst_Finish>
            <Room_Code>string</Room_Code>
            <Inst_Code>string</Inst_Code>
            <Inst_Desc>string</Inst_Desc>
            <Clie_Code>string</Clie_Code>
            <Loca_Code>string</Loca_Code>
            <UnitCodes xsi:nil="true" />
          </TInst>
          <TInst>
            <Inst_ID>int</Inst_ID>
            <Enro_ID>int</Enro_ID>
            <Prog_Name>string</Prog_Name>
            <Inst_Start>dateTime</Inst_Start>
            <Inst_Finish>dateTime</Inst_Finish>
            <Room_Code>string</Room_Code>
            <Inst_Code>string</Inst_Code>
            <Inst_Desc>string</Inst_Desc>
            <Clie_Code>string</Clie_Code>
            <Loca_Code>string</Loca_Code>
            <UnitCodes xsi:nil="true" />
          </TInst>
        </InstList>
      </GetClassesForClientResult>
    </GetClassesForClientResponse>
  </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>
    <GetClassesForClient xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sClie_Code>string</sClie_Code>
      <xsdStart>dateTime</xsdStart>
      <xsdEnd>dateTime</xsdEnd>
    </GetClassesForClient>
  </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>
    <GetClassesForClientResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetClassesForClientResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <InstList>
          <TInst>
            <Inst_ID>int</Inst_ID>
            <Enro_ID>int</Enro_ID>
            <Prog_Name>string</Prog_Name>
            <Inst_Start>dateTime</Inst_Start>
            <Inst_Finish>dateTime</Inst_Finish>
            <Room_Code>string</Room_Code>
            <Inst_Code>string</Inst_Code>
            <Inst_Desc>string</Inst_Desc>
            <Clie_Code>string</Clie_Code>
            <Loca_Code>string</Loca_Code>
            <UnitCodes xsi:nil="true" />
          </TInst>
          <TInst>
            <Inst_ID>int</Inst_ID>
            <Enro_ID>int</Enro_ID>
            <Prog_Name>string</Prog_Name>
            <Inst_Start>dateTime</Inst_Start>
            <Inst_Finish>dateTime</Inst_Finish>
            <Room_Code>string</Room_Code>
            <Inst_Code>string</Inst_Code>
            <Inst_Desc>string</Inst_Desc>
            <Clie_Code>string</Clie_Code>
            <Loca_Code>string</Loca_Code>
            <UnitCodes xsi:nil="true" />
          </TInst>
        </InstList>
      </GetClassesForClientResult>
    </GetClassesForClientResponse>
  </soap12:Body>
</soap12:Envelope>