VT_API


Click here for a complete list of operations.

GetAdditionalDataFieldsForEntity

Gets a list of all fields available to be set for an entity

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

<?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>
    <GetAdditionalDataFieldsForEntity xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <entityName>string</entityName>
    </GetAdditionalDataFieldsForEntity>
  </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>
    <GetAdditionalDataFieldsForEntityResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetAdditionalDataFieldsForEntityResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <FieldList>
          <FieldDefinition>
            <FieldName>string</FieldName>
            <FieldType>String or Integer or Decimal or Date or DateTime</FieldType>
            <FieldDescription>string</FieldDescription>
            <MaximumLength>int</MaximumLength>
            <IsUpdateable>boolean</IsUpdateable>
            <ValidValuesList xsi:nil="true" />
          </FieldDefinition>
          <FieldDefinition>
            <FieldName>string</FieldName>
            <FieldType>String or Integer or Decimal or Date or DateTime</FieldType>
            <FieldDescription>string</FieldDescription>
            <MaximumLength>int</MaximumLength>
            <IsUpdateable>boolean</IsUpdateable>
            <ValidValuesList xsi:nil="true" />
          </FieldDefinition>
        </FieldList>
      </GetAdditionalDataFieldsForEntityResult>
    </GetAdditionalDataFieldsForEntityResponse>
  </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>
    <GetAdditionalDataFieldsForEntity xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <entityName>string</entityName>
    </GetAdditionalDataFieldsForEntity>
  </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>
    <GetAdditionalDataFieldsForEntityResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetAdditionalDataFieldsForEntityResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <FieldList>
          <FieldDefinition>
            <FieldName>string</FieldName>
            <FieldType>String or Integer or Decimal or Date or DateTime</FieldType>
            <FieldDescription>string</FieldDescription>
            <MaximumLength>int</MaximumLength>
            <IsUpdateable>boolean</IsUpdateable>
            <ValidValuesList xsi:nil="true" />
          </FieldDefinition>
          <FieldDefinition>
            <FieldName>string</FieldName>
            <FieldType>String or Integer or Decimal or Date or DateTime</FieldType>
            <FieldDescription>string</FieldDescription>
            <MaximumLength>int</MaximumLength>
            <IsUpdateable>boolean</IsUpdateable>
            <ValidValuesList xsi:nil="true" />
          </FieldDefinition>
        </FieldList>
      </GetAdditionalDataFieldsForEntityResult>
    </GetAdditionalDataFieldsForEntityResponse>
  </soap12:Body>
</soap12:Envelope>