VT_API Web Service

VT_API

Click here for a complete list of operations.

GetWebEnrolmentsSince

Gets a list of web enrolments since the specified Date

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

<?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>
    <GetWebEnrolmentsSince xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sinceDate>dateTime</sinceDate>
    </GetWebEnrolmentsSince>
  </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>
    <GetWebEnrolmentsSinceResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetWebEnrolmentsSinceResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <WebeList>
          <TWebe>
            <Webe_ID>int</Webe_ID>
            <Occu_ID>int</Occu_ID>
            <Stamp>dateTime</Stamp>
            <Payment_Order>string</Payment_Order>
            <Receipt>string</Receipt>
            <Amount>decimal</Amount>
            <AmountPaid>decimal</AmountPaid>
            <MakeInvoice>int</MakeInvoice>
            <Purchase_Order>string</Purchase_Order>
            <Webe_Type>int</Webe_Type>
            <Desc>string</Desc>
            <ReferralId>int</ReferralId>
            <InvoiceeWebEmployerId>int</InvoiceeWebEmployerId>
            <CombineInvoice>int</CombineInvoice>
            <StudyReasonId>int</StudyReasonId>
            <PaymentPlanProvider>int</PaymentPlanProvider>
            <PaymentPlanFrequency>int</PaymentPlanFrequency>
            <PaymentPlanInstalmentAmount>decimal</PaymentPlanInstalmentAmount>
            <VETenrolRegistrationId>string</VETenrolRegistrationId>
            <VicCohortCodes xsi:nil="true" />
          </TWebe>
          <TWebe>
            <Webe_ID>int</Webe_ID>
            <Occu_ID>int</Occu_ID>
            <Stamp>dateTime</Stamp>
            <Payment_Order>string</Payment_Order>
            <Receipt>string</Receipt>
            <Amount>decimal</Amount>
            <AmountPaid>decimal</AmountPaid>
            <MakeInvoice>int</MakeInvoice>
            <Purchase_Order>string</Purchase_Order>
            <Webe_Type>int</Webe_Type>
            <Desc>string</Desc>
            <ReferralId>int</ReferralId>
            <InvoiceeWebEmployerId>int</InvoiceeWebEmployerId>
            <CombineInvoice>int</CombineInvoice>
            <StudyReasonId>int</StudyReasonId>
            <PaymentPlanProvider>int</PaymentPlanProvider>
            <PaymentPlanFrequency>int</PaymentPlanFrequency>
            <PaymentPlanInstalmentAmount>decimal</PaymentPlanInstalmentAmount>
            <VETenrolRegistrationId>string</VETenrolRegistrationId>
            <VicCohortCodes xsi:nil="true" />
          </TWebe>
        </WebeList>
      </GetWebEnrolmentsSinceResult>
    </GetWebEnrolmentsSinceResponse>
  </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>
    <GetWebEnrolmentsSince xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <sinceDate>dateTime</sinceDate>
    </GetWebEnrolmentsSince>
  </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>
    <GetWebEnrolmentsSinceResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetWebEnrolmentsSinceResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <WebeList>
          <TWebe>
            <Webe_ID>int</Webe_ID>
            <Occu_ID>int</Occu_ID>
            <Stamp>dateTime</Stamp>
            <Payment_Order>string</Payment_Order>
            <Receipt>string</Receipt>
            <Amount>decimal</Amount>
            <AmountPaid>decimal</AmountPaid>
            <MakeInvoice>int</MakeInvoice>
            <Purchase_Order>string</Purchase_Order>
            <Webe_Type>int</Webe_Type>
            <Desc>string</Desc>
            <ReferralId>int</ReferralId>
            <InvoiceeWebEmployerId>int</InvoiceeWebEmployerId>
            <CombineInvoice>int</CombineInvoice>
            <StudyReasonId>int</StudyReasonId>
            <PaymentPlanProvider>int</PaymentPlanProvider>
            <PaymentPlanFrequency>int</PaymentPlanFrequency>
            <PaymentPlanInstalmentAmount>decimal</PaymentPlanInstalmentAmount>
            <VETenrolRegistrationId>string</VETenrolRegistrationId>
            <VicCohortCodes xsi:nil="true" />
          </TWebe>
          <TWebe>
            <Webe_ID>int</Webe_ID>
            <Occu_ID>int</Occu_ID>
            <Stamp>dateTime</Stamp>
            <Payment_Order>string</Payment_Order>
            <Receipt>string</Receipt>
            <Amount>decimal</Amount>
            <AmountPaid>decimal</AmountPaid>
            <MakeInvoice>int</MakeInvoice>
            <Purchase_Order>string</Purchase_Order>
            <Webe_Type>int</Webe_Type>
            <Desc>string</Desc>
            <ReferralId>int</ReferralId>
            <InvoiceeWebEmployerId>int</InvoiceeWebEmployerId>
            <CombineInvoice>int</CombineInvoice>
            <StudyReasonId>int</StudyReasonId>
            <PaymentPlanProvider>int</PaymentPlanProvider>
            <PaymentPlanFrequency>int</PaymentPlanFrequency>
            <PaymentPlanInstalmentAmount>decimal</PaymentPlanInstalmentAmount>
            <VETenrolRegistrationId>string</VETenrolRegistrationId>
            <VicCohortCodes xsi:nil="true" />
          </TWebe>
        </WebeList>
      </GetWebEnrolmentsSinceResult>
    </GetWebEnrolmentsSinceResponse>
  </soap12:Body>
</soap12:Envelope>