VT_API


Click here for a complete list of operations.

GetAwardsForClient

Gets a list of awards for the 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 /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/GetAwardsForClient"

<?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>
    <GetAwardsForClient xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sClie_Code>string</sClie_Code>
    </GetAwardsForClient>
  </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>
    <GetAwardsForClientResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetAwardsForClientResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <QuclList>
          <TQucl>
            <Qucl_ID>int</Qucl_ID>
            <Qual_Code>string</Qual_Code>
            <Qual_Name>string</Qual_Name>
            <Clie_Code>string</Clie_Code>
            <Loca_Code>string</Loca_Code>
            <Qucl_Cert>string</Qucl_Cert>
            <Qucl_Recorded>dateTime</Qucl_Recorded>
            <Staf_Code>string</Staf_Code>
            <Awty_Type>string</Awty_Type>
            <AwardTypeName>string</AwardTypeName>
            <AwardTypeCode>string</AwardTypeCode>
            <Expiry>dateTime</Expiry>
            <OrganisationId>int</OrganisationId>
            <DocumentReference>string</DocumentReference>
            <EnrolledUnits xsi:nil="true" />
            <Notes>string</Notes>
            <LicenceNumber>string</LicenceNumber>
            <CompleteDate>dateTime</CompleteDate>
            <IssuedDate>dateTime</IssuedDate>
            <Issued>boolean</Issued>
            <Completion>boolean</Completion>
          </TQucl>
          <TQucl>
            <Qucl_ID>int</Qucl_ID>
            <Qual_Code>string</Qual_Code>
            <Qual_Name>string</Qual_Name>
            <Clie_Code>string</Clie_Code>
            <Loca_Code>string</Loca_Code>
            <Qucl_Cert>string</Qucl_Cert>
            <Qucl_Recorded>dateTime</Qucl_Recorded>
            <Staf_Code>string</Staf_Code>
            <Awty_Type>string</Awty_Type>
            <AwardTypeName>string</AwardTypeName>
            <AwardTypeCode>string</AwardTypeCode>
            <Expiry>dateTime</Expiry>
            <OrganisationId>int</OrganisationId>
            <DocumentReference>string</DocumentReference>
            <EnrolledUnits xsi:nil="true" />
            <Notes>string</Notes>
            <LicenceNumber>string</LicenceNumber>
            <CompleteDate>dateTime</CompleteDate>
            <IssuedDate>dateTime</IssuedDate>
            <Issued>boolean</Issued>
            <Completion>boolean</Completion>
          </TQucl>
        </QuclList>
      </GetAwardsForClientResult>
    </GetAwardsForClientResponse>
  </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>
    <GetAwardsForClient xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sClie_Code>string</sClie_Code>
    </GetAwardsForClient>
  </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>
    <GetAwardsForClientResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetAwardsForClientResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <QuclList>
          <TQucl>
            <Qucl_ID>int</Qucl_ID>
            <Qual_Code>string</Qual_Code>
            <Qual_Name>string</Qual_Name>
            <Clie_Code>string</Clie_Code>
            <Loca_Code>string</Loca_Code>
            <Qucl_Cert>string</Qucl_Cert>
            <Qucl_Recorded>dateTime</Qucl_Recorded>
            <Staf_Code>string</Staf_Code>
            <Awty_Type>string</Awty_Type>
            <AwardTypeName>string</AwardTypeName>
            <AwardTypeCode>string</AwardTypeCode>
            <Expiry>dateTime</Expiry>
            <OrganisationId>int</OrganisationId>
            <DocumentReference>string</DocumentReference>
            <EnrolledUnits xsi:nil="true" />
            <Notes>string</Notes>
            <LicenceNumber>string</LicenceNumber>
            <CompleteDate>dateTime</CompleteDate>
            <IssuedDate>dateTime</IssuedDate>
            <Issued>boolean</Issued>
            <Completion>boolean</Completion>
          </TQucl>
          <TQucl>
            <Qucl_ID>int</Qucl_ID>
            <Qual_Code>string</Qual_Code>
            <Qual_Name>string</Qual_Name>
            <Clie_Code>string</Clie_Code>
            <Loca_Code>string</Loca_Code>
            <Qucl_Cert>string</Qucl_Cert>
            <Qucl_Recorded>dateTime</Qucl_Recorded>
            <Staf_Code>string</Staf_Code>
            <Awty_Type>string</Awty_Type>
            <AwardTypeName>string</AwardTypeName>
            <AwardTypeCode>string</AwardTypeCode>
            <Expiry>dateTime</Expiry>
            <OrganisationId>int</OrganisationId>
            <DocumentReference>string</DocumentReference>
            <EnrolledUnits xsi:nil="true" />
            <Notes>string</Notes>
            <LicenceNumber>string</LicenceNumber>
            <CompleteDate>dateTime</CompleteDate>
            <IssuedDate>dateTime</IssuedDate>
            <Issued>boolean</Issued>
            <Completion>boolean</Completion>
          </TQucl>
        </QuclList>
      </GetAwardsForClientResult>
    </GetAwardsForClientResponse>
  </soap12:Body>
</soap12:Envelope>