VT_API


Click here for a complete list of operations.

GetUnitsForEnrolmentIncludingLinked

Gets a list of units for the enrolment with the specified ID, including linked units

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

<?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>
    <GetUnitsForEnrolmentIncludingLinked xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <enrolmentId>int</enrolmentId>
    </GetUnitsForEnrolmentIncludingLinked>
  </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>
    <GetUnitsForEnrolmentIncludingLinkedResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetUnitsForEnrolmentIncludingLinkedResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <EnunList>
          <TEnun>
            <EnroUnitId>int</EnroUnitId>
            <Qual_Code>string</Qual_Code>
            <Qual_Name>string</Qual_Name>
            <ID>int</ID>
            <Start>dateTime</Start>
            <Finish>dateTime</Finish>
            <Unit_Code>string</Unit_Code>
            <Unit_Name>string</Unit_Name>
            <Rety_Name>string</Rety_Name>
            <Rety_Result>int</Rety_Result>
            <OutcomeName>string</OutcomeName>
            <AssessmentStatus>int</AssessmentStatus>
            <Comment>string</Comment>
            <Hours>int</Hours>
            <Sequence>int</Sequence>
            <Percentage>int</Percentage>
          </TEnun>
          <TEnun>
            <EnroUnitId>int</EnroUnitId>
            <Qual_Code>string</Qual_Code>
            <Qual_Name>string</Qual_Name>
            <ID>int</ID>
            <Start>dateTime</Start>
            <Finish>dateTime</Finish>
            <Unit_Code>string</Unit_Code>
            <Unit_Name>string</Unit_Name>
            <Rety_Name>string</Rety_Name>
            <Rety_Result>int</Rety_Result>
            <OutcomeName>string</OutcomeName>
            <AssessmentStatus>int</AssessmentStatus>
            <Comment>string</Comment>
            <Hours>int</Hours>
            <Sequence>int</Sequence>
            <Percentage>int</Percentage>
          </TEnun>
        </EnunList>
      </GetUnitsForEnrolmentIncludingLinkedResult>
    </GetUnitsForEnrolmentIncludingLinkedResponse>
  </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>
    <GetUnitsForEnrolmentIncludingLinked xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <enrolmentId>int</enrolmentId>
    </GetUnitsForEnrolmentIncludingLinked>
  </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>
    <GetUnitsForEnrolmentIncludingLinkedResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetUnitsForEnrolmentIncludingLinkedResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <EnunList>
          <TEnun>
            <EnroUnitId>int</EnroUnitId>
            <Qual_Code>string</Qual_Code>
            <Qual_Name>string</Qual_Name>
            <ID>int</ID>
            <Start>dateTime</Start>
            <Finish>dateTime</Finish>
            <Unit_Code>string</Unit_Code>
            <Unit_Name>string</Unit_Name>
            <Rety_Name>string</Rety_Name>
            <Rety_Result>int</Rety_Result>
            <OutcomeName>string</OutcomeName>
            <AssessmentStatus>int</AssessmentStatus>
            <Comment>string</Comment>
            <Hours>int</Hours>
            <Sequence>int</Sequence>
            <Percentage>int</Percentage>
          </TEnun>
          <TEnun>
            <EnroUnitId>int</EnroUnitId>
            <Qual_Code>string</Qual_Code>
            <Qual_Name>string</Qual_Name>
            <ID>int</ID>
            <Start>dateTime</Start>
            <Finish>dateTime</Finish>
            <Unit_Code>string</Unit_Code>
            <Unit_Name>string</Unit_Name>
            <Rety_Name>string</Rety_Name>
            <Rety_Result>int</Rety_Result>
            <OutcomeName>string</OutcomeName>
            <AssessmentStatus>int</AssessmentStatus>
            <Comment>string</Comment>
            <Hours>int</Hours>
            <Sequence>int</Sequence>
            <Percentage>int</Percentage>
          </TEnun>
        </EnunList>
      </GetUnitsForEnrolmentIncludingLinkedResult>
    </GetUnitsForEnrolmentIncludingLinkedResponse>
  </soap12:Body>
</soap12:Envelope>