VT_API Web Service

VT_API

Click here for a complete list of operations.

UpdateWebClient

Records the specified additional data against the client linked to the specified web enrolment 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/UpdateWebClient"

<?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>
    <UpdateWebClient xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <iWebe_ID>int</iWebe_ID>
      <sOther>string</sOther>
      <sTitle>string</sTitle>
      <sGender>string</sGender>
      <sAddr>string</sAddr>
      <sCity>string</sCity>
      <sPCode>string</sPCode>
      <sShortState>string</sShortState>
      <sHomePhone>string</sHomePhone>
      <sWorkPhone>string</sWorkPhone>
      <sMobilePhone>string</sMobilePhone>
      <sEmail>string</sEmail>
      <sEmergencyName>string</sEmergencyName>
      <sEmergencyPhone>string</sEmergencyPhone>
      <sEmergencyMobile>string</sEmergencyMobile>
      <postalAddr>string</postalAddr>
      <postalCity>string</postalCity>
      <postalPCode>string</postalPCode>
      <postalShortState>string</postalShortState>
      <divisionId>int</divisionId>
      <usi>string</usi>
      <usualAddress>
        <Building>string</Building>
        <UnitDetails>string</UnitDetails>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <POBox>string</POBox>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
      </usualAddress>
      <postalAddress>
        <Building>string</Building>
        <UnitDetails>string</UnitDetails>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <POBox>string</POBox>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
      </postalAddress>
      <surveyContactStatusCode>string</surveyContactStatusCode>
    </UpdateWebClient>
  </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>
    <UpdateWebClientResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <UpdateWebClientResult>
        <ID>int</ID>
        <Token>string</Token>
        <Status>int</Status>
        <StatusMessage>string</StatusMessage>
        <Identifier>string</Identifier>
        <TokenType>string</TokenType>
      </UpdateWebClientResult>
    </UpdateWebClientResponse>
  </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>
    <UpdateWebClient xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <sToken>string</sToken>
      <iWebe_ID>int</iWebe_ID>
      <sOther>string</sOther>
      <sTitle>string</sTitle>
      <sGender>string</sGender>
      <sAddr>string</sAddr>
      <sCity>string</sCity>
      <sPCode>string</sPCode>
      <sShortState>string</sShortState>
      <sHomePhone>string</sHomePhone>
      <sWorkPhone>string</sWorkPhone>
      <sMobilePhone>string</sMobilePhone>
      <sEmail>string</sEmail>
      <sEmergencyName>string</sEmergencyName>
      <sEmergencyPhone>string</sEmergencyPhone>
      <sEmergencyMobile>string</sEmergencyMobile>
      <postalAddr>string</postalAddr>
      <postalCity>string</postalCity>
      <postalPCode>string</postalPCode>
      <postalShortState>string</postalShortState>
      <divisionId>int</divisionId>
      <usi>string</usi>
      <usualAddress>
        <Building>string</Building>
        <UnitDetails>string</UnitDetails>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <POBox>string</POBox>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
      </usualAddress>
      <postalAddress>
        <Building>string</Building>
        <UnitDetails>string</UnitDetails>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <POBox>string</POBox>
        <City>string</City>
        <State>string</State>
        <Postcode>string</Postcode>
      </postalAddress>
      <surveyContactStatusCode>string</surveyContactStatusCode>
    </UpdateWebClient>
  </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>
    <UpdateWebClientResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <UpdateWebClientResult>
        <ID>int</ID>
        <Token>string</Token>
        <Status>int</Status>
        <StatusMessage>string</StatusMessage>
        <Identifier>string</Identifier>
        <TokenType>string</TokenType>
      </UpdateWebClientResult>
    </UpdateWebClientResponse>
  </soap12:Body>
</soap12:Envelope>