VT_API Web Service

VT_API

Click here for a complete list of operations.

GetClientExtendedDetails

Gets the extended details for a client with the specified 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 /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/GetClientExtendedDetails"

<?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>
    <GetClientExtendedDetails xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sClie_Code>string</sClie_Code>
      <xsdStart>dateTime</xsdStart>
      <xsdEnd>dateTime</xsdEnd>
    </GetClientExtendedDetails>
  </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>
    <GetClientExtendedDetailsResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetClientExtendedDetailsResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ClieExtended>
          <ClientDetail>
            <Empl_Identifier>string</Empl_Identifier>
            <Clie_Other>string</Clie_Other>
            <Clie_Username>string</Clie_Username>
            <Clie_DOB>dateTime</Clie_DOB>
            <Clie_RAddr>string</Clie_RAddr>
            <Clie_RCity>string</Clie_RCity>
            <Clie_RPCode>string</Clie_RPCode>
            <Stat_RShortName>string</Stat_RShortName>
            <Clie_PAddr>string</Clie_PAddr>
            <Clie_PCity>string</Clie_PCity>
            <Clie_PPCode>string</Clie_PPCode>
            <Stat_PShortName>string</Stat_PShortName>
            <Clie_Address_Type>int</Clie_Address_Type>
            <Clie_Email>string</Clie_Email>
            <Clie_FaxPhone>string</Clie_FaxPhone>
            <Clie_HomePhone>string</Clie_HomePhone>
            <Clie_WorkPhone>string</Clie_WorkPhone>
            <Clie_MobilePhone>string</Clie_MobilePhone>
            <Clie_EmergencyName>string</Clie_EmergencyName>
            <Clie_EmergencyPhone>string</Clie_EmergencyPhone>
            <Clie_Title>string</Clie_Title>
            <Gender>string</Gender>
            <PositionName>string</PositionName>
            <PositionCode>string</PositionCode>
            <Clie_Passport>string</Clie_Passport>
            <Clie_Visa>string</Clie_Visa>
            <Vity_Name>string</Vity_Name>
            <Clie_VisaExpiry>dateTime</Clie_VisaExpiry>
            <Clie_DateLastAssessed>dateTime</Clie_DateLastAssessed>
            <Clie_Commenced>dateTime</Clie_Commenced>
            <TerminationDate>dateTime</TerminationDate>
            <Clie_Salary>decimal</Clie_Salary>
            <DivisionId>int</DivisionId>
            <UsualAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
            <USI>string</USI>
            <USIExempt>boolean</USIExempt>
          </ClientDetail>
          <AVETMISS>
            <Scle_Code>string</Scle_Code>
            <Lang_Code>string</Lang_Code>
            <Emca_Code>string</Emca_Code>
            <Coun_Code>string</Coun_Code>
            <Clie_YearCompleted>int</Clie_YearCompleted>
            <Clie_WhereCompleted>string</Clie_WhereCompleted>
            <DisabilityFlag>string</DisabilityFlag>
            <PriorEdFlag>string</PriorEdFlag>
            <AtSchoolFlag>string</AtSchoolFlag>
            <ProfSpokEngFlag>string</ProfSpokEngFlag>
            <AboriginalFlag>string</AboriginalFlag>
            <DisabilityList xsi:nil="true" />
            <PriorEdList xsi:nil="true" />
          </AVETMISS>
          <Classes>
            <TInst xsi:nil="true" />
            <TInst xsi:nil="true" />
          </Classes>
          <Enrolments>
            <TClieEnro xsi:nil="true" />
            <TClieEnro xsi:nil="true" />
          </Enrolments>
          <Contracts>
            <TCont xsi:nil="true" />
            <TCont xsi:nil="true" />
          </Contracts>
          <EnrolledUnits>
            <TEnun xsi:nil="true" />
            <TEnun xsi:nil="true" />
          </EnrolledUnits>
          <Events>
            <TEven xsi:nil="true" />
            <TEven xsi:nil="true" />
          </Events>
          <Attendances>
            <TAtte xsi:nil="true" />
            <TAtte xsi:nil="true" />
          </Attendances>
          <Awards>
            <TQucl xsi:nil="true" />
            <TQucl xsi:nil="true" />
          </Awards>
        </ClieExtended>
      </GetClientExtendedDetailsResult>
    </GetClientExtendedDetailsResponse>
  </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>
    <GetClientExtendedDetails xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sClie_Code>string</sClie_Code>
      <xsdStart>dateTime</xsdStart>
      <xsdEnd>dateTime</xsdEnd>
    </GetClientExtendedDetails>
  </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>
    <GetClientExtendedDetailsResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetClientExtendedDetailsResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ClieExtended>
          <ClientDetail>
            <Empl_Identifier>string</Empl_Identifier>
            <Clie_Other>string</Clie_Other>
            <Clie_Username>string</Clie_Username>
            <Clie_DOB>dateTime</Clie_DOB>
            <Clie_RAddr>string</Clie_RAddr>
            <Clie_RCity>string</Clie_RCity>
            <Clie_RPCode>string</Clie_RPCode>
            <Stat_RShortName>string</Stat_RShortName>
            <Clie_PAddr>string</Clie_PAddr>
            <Clie_PCity>string</Clie_PCity>
            <Clie_PPCode>string</Clie_PPCode>
            <Stat_PShortName>string</Stat_PShortName>
            <Clie_Address_Type>int</Clie_Address_Type>
            <Clie_Email>string</Clie_Email>
            <Clie_FaxPhone>string</Clie_FaxPhone>
            <Clie_HomePhone>string</Clie_HomePhone>
            <Clie_WorkPhone>string</Clie_WorkPhone>
            <Clie_MobilePhone>string</Clie_MobilePhone>
            <Clie_EmergencyName>string</Clie_EmergencyName>
            <Clie_EmergencyPhone>string</Clie_EmergencyPhone>
            <Clie_Title>string</Clie_Title>
            <Gender>string</Gender>
            <PositionName>string</PositionName>
            <PositionCode>string</PositionCode>
            <Clie_Passport>string</Clie_Passport>
            <Clie_Visa>string</Clie_Visa>
            <Vity_Name>string</Vity_Name>
            <Clie_VisaExpiry>dateTime</Clie_VisaExpiry>
            <Clie_DateLastAssessed>dateTime</Clie_DateLastAssessed>
            <Clie_Commenced>dateTime</Clie_Commenced>
            <TerminationDate>dateTime</TerminationDate>
            <Clie_Salary>decimal</Clie_Salary>
            <DivisionId>int</DivisionId>
            <UsualAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
            <USI>string</USI>
            <USIExempt>boolean</USIExempt>
          </ClientDetail>
          <AVETMISS>
            <Scle_Code>string</Scle_Code>
            <Lang_Code>string</Lang_Code>
            <Emca_Code>string</Emca_Code>
            <Coun_Code>string</Coun_Code>
            <Clie_YearCompleted>int</Clie_YearCompleted>
            <Clie_WhereCompleted>string</Clie_WhereCompleted>
            <DisabilityFlag>string</DisabilityFlag>
            <PriorEdFlag>string</PriorEdFlag>
            <AtSchoolFlag>string</AtSchoolFlag>
            <ProfSpokEngFlag>string</ProfSpokEngFlag>
            <AboriginalFlag>string</AboriginalFlag>
            <DisabilityList xsi:nil="true" />
            <PriorEdList xsi:nil="true" />
          </AVETMISS>
          <Classes>
            <TInst xsi:nil="true" />
            <TInst xsi:nil="true" />
          </Classes>
          <Enrolments>
            <TClieEnro xsi:nil="true" />
            <TClieEnro xsi:nil="true" />
          </Enrolments>
          <Contracts>
            <TCont xsi:nil="true" />
            <TCont xsi:nil="true" />
          </Contracts>
          <EnrolledUnits>
            <TEnun xsi:nil="true" />
            <TEnun xsi:nil="true" />
          </EnrolledUnits>
          <Events>
            <TEven xsi:nil="true" />
            <TEven xsi:nil="true" />
          </Events>
          <Attendances>
            <TAtte xsi:nil="true" />
            <TAtte xsi:nil="true" />
          </Attendances>
          <Awards>
            <TQucl xsi:nil="true" />
            <TQucl xsi:nil="true" />
          </Awards>
        </ClieExtended>
      </GetClientExtendedDetailsResult>
    </GetClientExtendedDetailsResponse>
  </soap12:Body>
</soap12:Envelope>