VT_API Web Service

VT_API

Click here for a complete list of operations.

GetEnrolledTasksForOccurrence

Retrieves a list of enrolled tasks for all enrolments in an occurrence

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

<?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>
    <GetEnrolledTasksForOccurrence xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <occurrenceId>int</occurrenceId>
      <activeEnrolmentsOnly>boolean</activeEnrolmentsOnly>
    </GetEnrolledTasksForOccurrence>
  </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>
    <GetEnrolledTasksForOccurrenceResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetEnrolledTasksForOccurrenceResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <TaskEnrolmentList>
          <TTaskEnrolment>
            <TaskEnrolmentId>int</TaskEnrolmentId>
            <EnrolmentId>int</EnrolmentId>
            <TaskId>int</TaskId>
            <TaskCode>string</TaskCode>
            <TaskName>string</TaskName>
            <ClientCode>string</ClientCode>
            <GivenName>string</GivenName>
            <Surname>string</Surname>
            <TaskStatusCode>string</TaskStatusCode>
            <TaskStatusName>string</TaskStatusName>
            <TaskStatusType>int</TaskStatusType>
            <StartDate>dateTime</StartDate>
            <DueDate>dateTime</DueDate>
            <StatusDate>dateTime</StatusDate>
            <CompleteDate>dateTime</CompleteDate>
            <Percentage>int</Percentage>
            <Description>string</Description>
          </TTaskEnrolment>
          <TTaskEnrolment>
            <TaskEnrolmentId>int</TaskEnrolmentId>
            <EnrolmentId>int</EnrolmentId>
            <TaskId>int</TaskId>
            <TaskCode>string</TaskCode>
            <TaskName>string</TaskName>
            <ClientCode>string</ClientCode>
            <GivenName>string</GivenName>
            <Surname>string</Surname>
            <TaskStatusCode>string</TaskStatusCode>
            <TaskStatusName>string</TaskStatusName>
            <TaskStatusType>int</TaskStatusType>
            <StartDate>dateTime</StartDate>
            <DueDate>dateTime</DueDate>
            <StatusDate>dateTime</StatusDate>
            <CompleteDate>dateTime</CompleteDate>
            <Percentage>int</Percentage>
            <Description>string</Description>
          </TTaskEnrolment>
        </TaskEnrolmentList>
      </GetEnrolledTasksForOccurrenceResult>
    </GetEnrolledTasksForOccurrenceResponse>
  </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>
    <GetEnrolledTasksForOccurrence xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <occurrenceId>int</occurrenceId>
      <activeEnrolmentsOnly>boolean</activeEnrolmentsOnly>
    </GetEnrolledTasksForOccurrence>
  </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>
    <GetEnrolledTasksForOccurrenceResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetEnrolledTasksForOccurrenceResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <TaskEnrolmentList>
          <TTaskEnrolment>
            <TaskEnrolmentId>int</TaskEnrolmentId>
            <EnrolmentId>int</EnrolmentId>
            <TaskId>int</TaskId>
            <TaskCode>string</TaskCode>
            <TaskName>string</TaskName>
            <ClientCode>string</ClientCode>
            <GivenName>string</GivenName>
            <Surname>string</Surname>
            <TaskStatusCode>string</TaskStatusCode>
            <TaskStatusName>string</TaskStatusName>
            <TaskStatusType>int</TaskStatusType>
            <StartDate>dateTime</StartDate>
            <DueDate>dateTime</DueDate>
            <StatusDate>dateTime</StatusDate>
            <CompleteDate>dateTime</CompleteDate>
            <Percentage>int</Percentage>
            <Description>string</Description>
          </TTaskEnrolment>
          <TTaskEnrolment>
            <TaskEnrolmentId>int</TaskEnrolmentId>
            <EnrolmentId>int</EnrolmentId>
            <TaskId>int</TaskId>
            <TaskCode>string</TaskCode>
            <TaskName>string</TaskName>
            <ClientCode>string</ClientCode>
            <GivenName>string</GivenName>
            <Surname>string</Surname>
            <TaskStatusCode>string</TaskStatusCode>
            <TaskStatusName>string</TaskStatusName>
            <TaskStatusType>int</TaskStatusType>
            <StartDate>dateTime</StartDate>
            <DueDate>dateTime</DueDate>
            <StatusDate>dateTime</StatusDate>
            <CompleteDate>dateTime</CompleteDate>
            <Percentage>int</Percentage>
            <Description>string</Description>
          </TTaskEnrolment>
        </TaskEnrolmentList>
      </GetEnrolledTasksForOccurrenceResult>
    </GetEnrolledTasksForOccurrenceResponse>
  </soap12:Body>
</soap12:Envelope>