VT_API Web Service

VT_API

Click here for a complete list of operations.

GetWebWaitlist

Retrieves a web waitlist entry with the specified ID

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

<?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>
    <GetWebWaitlist xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <webWaitlistId>int</webWaitlistId>
    </GetWebWaitlist>
  </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>
    <GetWebWaitlistResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetWebWaitlistResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <WebWaitlist>
          <WebWaitlistId>int</WebWaitlistId>
          <WebClient>
            <Wecl_ID>int</Wecl_ID>
            <Webe_ID>int</Webe_ID>
            <Weco_ID>int</Weco_ID>
            <Code>string</Code>
            <Surname>string</Surname>
            <Given>string</Given>
            <Other>string</Other>
            <Title>string</Title>
            <DOB>dateTime</DOB>
            <Gender>string</Gender>
            <Addr>string</Addr>
            <City>string</City>
            <PCode>string</PCode>
            <Stat_ShortName>string</Stat_ShortName>
            <HomePhone>string</HomePhone>
            <WorkPhone>string</WorkPhone>
            <Mobile>string</Mobile>
            <Email>string</Email>
            <EmergencyName>string</EmergencyName>
            <EmergencyPhone>string</EmergencyPhone>
            <EmergencyMobile>string</EmergencyMobile>
            <PostalAddr>string</PostalAddr>
            <PostalCity>string</PostalCity>
            <PostalPostcode>string</PostalPostcode>
            <PostalStat_ShortName>string</PostalStat_ShortName>
            <DivisionId>int</DivisionId>
            <UsualAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
            <USI>string</USI>
            <SurveyContactStatusCode>string</SurveyContactStatusCode>
          </WebClient>
          <Programme>
            <Prog_ID>int</Prog_ID>
            <Prog_Code>string</Prog_Code>
            <Prog_Name>string</Prog_Name>
            <Prog_Desc>string</Prog_Desc>
            <Prog_Active>int</Prog_Active>
            <Prgt_Name>string</Prgt_Name>
            <WaitlistFlag>int</WaitlistFlag>
          </Programme>
          <Description>string</Description>
          <TimeStamp>dateTime</TimeStamp>
          <ReferralId>int</ReferralId>
        </WebWaitlist>
      </GetWebWaitlistResult>
    </GetWebWaitlistResponse>
  </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>
    <GetWebWaitlist xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <webWaitlistId>int</webWaitlistId>
    </GetWebWaitlist>
  </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>
    <GetWebWaitlistResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetWebWaitlistResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <WebWaitlist>
          <WebWaitlistId>int</WebWaitlistId>
          <WebClient>
            <Wecl_ID>int</Wecl_ID>
            <Webe_ID>int</Webe_ID>
            <Weco_ID>int</Weco_ID>
            <Code>string</Code>
            <Surname>string</Surname>
            <Given>string</Given>
            <Other>string</Other>
            <Title>string</Title>
            <DOB>dateTime</DOB>
            <Gender>string</Gender>
            <Addr>string</Addr>
            <City>string</City>
            <PCode>string</PCode>
            <Stat_ShortName>string</Stat_ShortName>
            <HomePhone>string</HomePhone>
            <WorkPhone>string</WorkPhone>
            <Mobile>string</Mobile>
            <Email>string</Email>
            <EmergencyName>string</EmergencyName>
            <EmergencyPhone>string</EmergencyPhone>
            <EmergencyMobile>string</EmergencyMobile>
            <PostalAddr>string</PostalAddr>
            <PostalCity>string</PostalCity>
            <PostalPostcode>string</PostalPostcode>
            <PostalStat_ShortName>string</PostalStat_ShortName>
            <DivisionId>int</DivisionId>
            <UsualAddress xsi:nil="true" />
            <PostalAddress xsi:nil="true" />
            <USI>string</USI>
            <SurveyContactStatusCode>string</SurveyContactStatusCode>
          </WebClient>
          <Programme>
            <Prog_ID>int</Prog_ID>
            <Prog_Code>string</Prog_Code>
            <Prog_Name>string</Prog_Name>
            <Prog_Desc>string</Prog_Desc>
            <Prog_Active>int</Prog_Active>
            <Prgt_Name>string</Prgt_Name>
            <WaitlistFlag>int</WaitlistFlag>
          </Programme>
          <Description>string</Description>
          <TimeStamp>dateTime</TimeStamp>
          <ReferralId>int</ReferralId>
        </WebWaitlist>
      </GetWebWaitlistResult>
    </GetWebWaitlistResponse>
  </soap12:Body>
</soap12:Envelope>