VT_API


Click here for a complete list of operations.

CompleteWebReservation

Completes a client or employer reservation to make it available for processing, and automatically processes it if the occurrence is configured to do so

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

<?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>
    <CompleteWebReservation xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <webEnrolId>int</webEnrolId>
    </CompleteWebReservation>
  </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>
    <CompleteWebReservationResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <CompleteWebReservationResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <WasAutoProcessed>boolean</WasAutoProcessed>
        <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>
      </CompleteWebReservationResult>
    </CompleteWebReservationResponse>
  </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>
    <CompleteWebReservation xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <webEnrolId>int</webEnrolId>
    </CompleteWebReservation>
  </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>
    <CompleteWebReservationResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <CompleteWebReservationResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <WasAutoProcessed>boolean</WasAutoProcessed>
        <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>
      </CompleteWebReservationResult>
    </CompleteWebReservationResponse>
  </soap12:Body>
</soap12:Envelope>