VT_API Web Service

VT_API

Click here for a complete list of operations.

AddWebClientRelationship

Adds a relationship for a web client

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

<?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>
    <AddWebClientRelationship xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <webEnrolId>int</webEnrolId>
      <clieRelationship>
        <ClieRelationshipId>int</ClieRelationshipId>
        <RelationshipTypeCode>string</RelationshipTypeCode>
        <RelationshipTypeName>string</RelationshipTypeName>
        <RelationId>int</RelationId>
        <RelationName>string</RelationName>
        <ToClient>
          <ClientCode>string</ClientCode>
          <GivenName>string</GivenName>
          <Surname>string</Surname>
          <OtherNames>string</OtherNames>
          <Email>string</Email>
          <MobilePhone>string</MobilePhone>
          <HomePhone>string</HomePhone>
        </ToClient>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <Description>string</Description>
      </clieRelationship>
    </AddWebClientRelationship>
  </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>
    <AddWebClientRelationshipResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <AddWebClientRelationshipResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ID>int</ID>
      </AddWebClientRelationshipResult>
    </AddWebClientRelationshipResponse>
  </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>
    <AddWebClientRelationship xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <webEnrolId>int</webEnrolId>
      <clieRelationship>
        <ClieRelationshipId>int</ClieRelationshipId>
        <RelationshipTypeCode>string</RelationshipTypeCode>
        <RelationshipTypeName>string</RelationshipTypeName>
        <RelationId>int</RelationId>
        <RelationName>string</RelationName>
        <ToClient>
          <ClientCode>string</ClientCode>
          <GivenName>string</GivenName>
          <Surname>string</Surname>
          <OtherNames>string</OtherNames>
          <Email>string</Email>
          <MobilePhone>string</MobilePhone>
          <HomePhone>string</HomePhone>
        </ToClient>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <Description>string</Description>
      </clieRelationship>
    </AddWebClientRelationship>
  </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>
    <AddWebClientRelationshipResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <AddWebClientRelationshipResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <ID>int</ID>
      </AddWebClientRelationshipResult>
    </AddWebClientRelationshipResponse>
  </soap12:Body>
</soap12:Envelope>