VT_API Web Service

VT_API

Click here for a complete list of operations.

ProcessWebEnrolment

Processes a web enrolment with the specified ID, to turn it into a real 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 /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/ProcessWebEnrolment"

<?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>
    <ProcessWebEnrolment xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <webEnrolId>int</webEnrolId>
      <updateMatches>boolean</updateMatches>
    </ProcessWebEnrolment>
  </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>
    <ProcessWebEnrolmentResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <ProcessWebEnrolmentResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ProcessedWebEnrol>
          <WebEnrolmentId>int</WebEnrolmentId>
          <EnrolmentId>int</EnrolmentId>
          <OccurrenceId>int</OccurrenceId>
          <EnroleeType>int</EnroleeType>
          <EnroleeWasCreated>boolean</EnroleeWasCreated>
          <EnroleeIdentifier>string</EnroleeIdentifier>
          <EnroleeName>string</EnroleeName>
          <InvoiceId>int</InvoiceId>
          <InvoiceNumber>string</InvoiceNumber>
          <InvoiceItemIds>
            <int>int</int>
            <int>int</int>
          </InvoiceItemIds>
          <PaymentId>int</PaymentId>
          <AmountInvoiced>decimal</AmountInvoiced>
          <GSTInvoiced>decimal</GSTInvoiced>
          <AmountPaid>decimal</AmountPaid>
          <GSTPaid>decimal</GSTPaid>
          <InvoiceDate>dateTime</InvoiceDate>
          <AutoLmsTransfer>
            <WasTransferredToLms>boolean</WasTransferredToLms>
            <ErrorsOccurred>boolean</ErrorsOccurred>
            <ClientWasCreatedInLms>boolean</ClientWasCreatedInLms>
            <ErrorMessage>string</ErrorMessage>
          </AutoLmsTransfer>
          <ProcessedEmployees>
            <TProcessedEmployee xsi:nil="true" />
            <TProcessedEmployee xsi:nil="true" />
          </ProcessedEmployees>
        </ProcessedWebEnrol>
      </ProcessWebEnrolmentResult>
    </ProcessWebEnrolmentResponse>
  </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>
    <ProcessWebEnrolment xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <webEnrolId>int</webEnrolId>
      <updateMatches>boolean</updateMatches>
    </ProcessWebEnrolment>
  </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>
    <ProcessWebEnrolmentResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <ProcessWebEnrolmentResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ProcessedWebEnrol>
          <WebEnrolmentId>int</WebEnrolmentId>
          <EnrolmentId>int</EnrolmentId>
          <OccurrenceId>int</OccurrenceId>
          <EnroleeType>int</EnroleeType>
          <EnroleeWasCreated>boolean</EnroleeWasCreated>
          <EnroleeIdentifier>string</EnroleeIdentifier>
          <EnroleeName>string</EnroleeName>
          <InvoiceId>int</InvoiceId>
          <InvoiceNumber>string</InvoiceNumber>
          <InvoiceItemIds>
            <int>int</int>
            <int>int</int>
          </InvoiceItemIds>
          <PaymentId>int</PaymentId>
          <AmountInvoiced>decimal</AmountInvoiced>
          <GSTInvoiced>decimal</GSTInvoiced>
          <AmountPaid>decimal</AmountPaid>
          <GSTPaid>decimal</GSTPaid>
          <InvoiceDate>dateTime</InvoiceDate>
          <AutoLmsTransfer>
            <WasTransferredToLms>boolean</WasTransferredToLms>
            <ErrorsOccurred>boolean</ErrorsOccurred>
            <ClientWasCreatedInLms>boolean</ClientWasCreatedInLms>
            <ErrorMessage>string</ErrorMessage>
          </AutoLmsTransfer>
          <ProcessedEmployees>
            <TProcessedEmployee xsi:nil="true" />
            <TProcessedEmployee xsi:nil="true" />
          </ProcessedEmployees>
        </ProcessedWebEnrol>
      </ProcessWebEnrolmentResult>
    </ProcessWebEnrolmentResponse>
  </soap12:Body>
</soap12:Envelope>