VT_API


Click here for a complete list of operations.

AddAward

Creates a new award for a client's enrolment

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

<?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>
    <AddAward xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <enrolmentId>int</enrolmentId>
      <awardTypeName>string</awardTypeName>
      <parchmentNumber>string</parchmentNumber>
      <recordedDate>dateTime</recordedDate>
      <dateCompleted>dateTime</dateCompleted>
      <expiryDate>dateTime</expiryDate>
      <issued>boolean</issued>
      <licenceNumber>string</licenceNumber>
      <description>string</description>
      <referenceLink>string</referenceLink>
      <issuedDate>dateTime</issuedDate>
      <completionStatement>boolean</completionStatement>
    </AddAward>
  </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>
    <AddAwardResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <AddAwardResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ParchmentNumber>string</ParchmentNumber>
        <ExpiryDate>dateTime</ExpiryDate>
      </AddAwardResult>
    </AddAwardResponse>
  </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>
    <AddAward xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <enrolmentId>int</enrolmentId>
      <awardTypeName>string</awardTypeName>
      <parchmentNumber>string</parchmentNumber>
      <recordedDate>dateTime</recordedDate>
      <dateCompleted>dateTime</dateCompleted>
      <expiryDate>dateTime</expiryDate>
      <issued>boolean</issued>
      <licenceNumber>string</licenceNumber>
      <description>string</description>
      <referenceLink>string</referenceLink>
      <issuedDate>dateTime</issuedDate>
      <completionStatement>boolean</completionStatement>
    </AddAward>
  </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>
    <AddAwardResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <AddAwardResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ParchmentNumber>string</ParchmentNumber>
        <ExpiryDate>dateTime</ExpiryDate>
      </AddAwardResult>
    </AddAwardResponse>
  </soap12:Body>
</soap12:Envelope>