VT_API Web Service

VT_API

Click here for a complete list of operations.

VerifyAward

Verifies the existence of an award and returns its details

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

<?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>
    <VerifyAward xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <givenName>string</givenName>
      <surname>string</surname>
      <parchmentNumber>string</parchmentNumber>
    </VerifyAward>
  </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>
    <VerifyAwardResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <VerifyAwardResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <Award>
          <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>
            <TEnun xsi:nil="true" />
            <TEnun xsi:nil="true" />
          </EnrolledUnits>
          <Notes>string</Notes>
          <LicenceNumber>string</LicenceNumber>
          <CompleteDate>dateTime</CompleteDate>
          <IssuedDate>dateTime</IssuedDate>
          <Issued>boolean</Issued>
          <Completion>boolean</Completion>
        </Award>
      </VerifyAwardResult>
    </VerifyAwardResponse>
  </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>
    <VerifyAward xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <givenName>string</givenName>
      <surname>string</surname>
      <parchmentNumber>string</parchmentNumber>
    </VerifyAward>
  </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>
    <VerifyAwardResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <VerifyAwardResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <Award>
          <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>
            <TEnun xsi:nil="true" />
            <TEnun xsi:nil="true" />
          </EnrolledUnits>
          <Notes>string</Notes>
          <LicenceNumber>string</LicenceNumber>
          <CompleteDate>dateTime</CompleteDate>
          <IssuedDate>dateTime</IssuedDate>
          <Issued>boolean</Issued>
          <Completion>boolean</Completion>
        </Award>
      </VerifyAwardResult>
    </VerifyAwardResponse>
  </soap12:Body>
</soap12:Envelope>