Response XML Schemas

Overview

Standard response XML schemas are defined here.

XML Schemas

Rate Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element maxOccurs="unbounded" name="rate">

          <xsd:complexType>

            <xsd:sequence>

              <xsd:element name="geocode" type="xsd:decimal" />

              <xsd:element name="effectiveDate" type="xsd:dateTime" />

              <xsd:element name="zip" type="xsd:string" />

              <xsd:element name="stateName" type="xsd:string" />

              <xsd:element name="stateSalesRate1" type="xsd:decimal" />

              <xsd:element name="stateSalesMinimum1" type="xsd:decimal" />

              <xsd:element name="stateSalesMaximum1" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitAmount1" type="xsd:decimal" />

              <xsd:element name="stateSplitSalesRate1" type="xsd:decimal" />

              <xsd:element name="stateSalesMaxTaxAmount1" type="xsd:decimal" />

              <xsd:element name="stateSalesRate2" type="xsd:decimal" />

              <xsd:element name="stateSalesMinimum2" type="xsd:decimal" />

              <xsd:element name="stateSalesMaximum2" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitAmount2" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitRate2" type="xsd:decimal" />

              <xsd:element name="stateSalesMaxTaxAmount2" type="xsd:decimal" />

              <xsd:element name="stateSalesRate3" type="xsd:decimal" />

              <xsd:element name="stateSalesMinimum3" type="xsd:decimal" />

              <xsd:element name="stateSalesMaximum3" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitAmount3" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitRate3" type="xsd:decimal" />

              <xsd:element name="stateSalesMaxTaxAmount3" type="xsd:decimal" />

              <xsd:element name="countyName" type="xsd:string" />

              <xsd:element name="countySalesRate1" type="xsd:decimal" />

              <xsd:element name="countySalesMinimum1" type="xsd:decimal" />

              <xsd:element name="countySalesMaximum1" type="xsd:decimal" />

              <xsd:element name="countySalesSplitAmount1" type="xsd:decimal" />

              <xsd:element name="countySplitSalesRate1" type="xsd:decimal" />

              <xsd:element name="countySalesMaxTaxAmount1" type="xsd:decimal" />

              <xsd:element name="countySalesRate2" type="xsd:decimal" />

              <xsd:element name="countySalesMinimum2" type="xsd:decimal" />

              <xsd:element name="countySalesMaximum2" type="xsd:decimal" />

              <xsd:element name="countySalesSplitAmount2" type="xsd:decimal" />

              <xsd:element name="countySalesSplitRate2" type="xsd:decimal" />

              <xsd:element name="countySalesMaxTaxAmount2" type="xsd:decimal" />

              <xsd:element name="countySalesRate3" type="xsd:decimal" />

              <xsd:element name="countySalesMinimum3" type="xsd:decimal" />

              <xsd:element name="countySalesMaximum3" type="xsd:decimal" />

              <xsd:element name="countySalesSplitAmount3" type="xsd:decimal" />

              <xsd:element name="countySalesSplitRate3" type="xsd:decimal" />

              <xsd:element name="countySalesMaxTaxAmount3" type="xsd:decimal" />

              <xsd:element name="cityName" type="xsd:string" />

              <xsd:element name="citySalesRate1" type="xsd:decimal" />

              <xsd:element name="citySalesMinimum1" type="xsd:decimal" />

              <xsd:element name="citySalesMaximum1" type="xsd:decimal" />

              <xsd:element name="citySalesSplitAmount1" type="xsd:decimal" />

              <xsd:element name="citySplitSalesRate1" type="xsd:decimal" />

              <xsd:element name="citySalesMaxTaxAmount1" type="xsd:decimal" />

              <xsd:element name="citySalesRate2" type="xsd:decimal" />

              <xsd:element name="citySalesMinimum2" type="xsd:decimal" />

              <xsd:element name="citySalesMaximum2" type="xsd:decimal" />

              <xsd:element name="citySalesSplitAmount2" type="xsd:decimal" />

              <xsd:element name="citySalesSplitRate2" type="xsd:decimal" />

              <xsd:element name="citySalesMaxTaxAmount2" type="xsd:decimal" />

              <xsd:element name="citySalesRate3" type="xsd:decimal" />

              <xsd:element name="citySalesMinimum3" type="xsd:decimal" />

              <xsd:element name="citySalesMaximum3" type="xsd:decimal" />

              <xsd:element name="citySalesSplitAmount3" type="xsd:decimal" />

              <xsd:element name="citySalesSplitRate3" type="xsd:decimal" />

              <xsd:element name="citySalesMaxTaxAmount3" type="xsd:decimal" />

              <xsd:element name="stj1Name" type="xsd:string" />

              <xsd:element name="stj1SalesRate1" type="xsd:decimal" />

              <xsd:element name="stj2Name" type="xsd:string" />

              <xsd:element name="stj2SalesRate1" type="xsd:decimal" />

              <xsd:element name="stj3Name" type="xsd:string" />

              <xsd:element name="stj3SalesRate1" type="xsd:decimal" />

              <xsd:element name="stj4Name" type="xsd:string" />

              <xsd:element name="stj4SalesRate1" type="xsd:decimal" />

              <xsd:element name="stj5Name" type="xsd:string" />

              <xsd:element name="stj5SalesRate1" type="xsd:decimal" />

              <xsd:element name="combinedSalesTaxRate" type="xsd:decimal" />

              <xsd:element name="sdCode" type="xsd:int" />

              <xsd:element name="defaultCity" type="xsd:string" />

            </xsd:sequence>

          </xsd:complexType>

        </xsd:element>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

Rate with Address Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element name="address">

          <xsd:complexType>

            <xsd:sequence>

              <xsd:element name="confidence" type="xsd:int" />

              <xsd:element name="cityName" type="xsd:string" />

              <xsd:element name="streetAddress2" type="xsd:string" />

              <xsd:element name="countyName" type="xsd:string" />

              <xsd:element name="streetAddress1" type="xsd:string" />

              <xsd:element name="zip" type="xsd:string" />

              <xsd:element name="stateName" type="xsd:string" />

              <xsd:element name="country" type="xsd:string" />

            </xsd:sequence>

          </xsd:complexType>

        </xsd:element>

        <xsd:element maxOccurs="unbounded" name="rate">

          <xsd:complexType>

            <xsd:sequence>

              <xsd:element name="geocode" type="xsd:decimal" />

              <xsd:element name="effectiveDate" type="xsd:dateTime" />

              <xsd:element name="zip" type="xsd:string" />

              <xsd:element name="stateName" type="xsd:string" />

              <xsd:element name="stateSalesRate1" type="xsd:decimal" />

              <xsd:element name="stateSalesMinimum1" type="xsd:decimal" />

              <xsd:element name="stateSalesMaximum1" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitAmount1" type="xsd:decimal" />

              <xsd:element name="stateSplitSalesRate1" type="xsd:decimal" />

              <xsd:element name="stateSalesMaxTaxAmount1" type="xsd:decimal" />

              <xsd:element name="stateSalesRate2" type="xsd:decimal" />

              <xsd:element name="stateSalesMinimum2" type="xsd:decimal" />

              <xsd:element name="stateSalesMaximum2" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitAmount2" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitRate2" type="xsd:decimal" />

              <xsd:element name="stateSalesMaxTaxAmount2" type="xsd:decimal" />

              <xsd:element name="stateSalesRate3" type="xsd:decimal" />

              <xsd:element name="stateSalesMinimum3" type="xsd:decimal" />

              <xsd:element name="stateSalesMaximum3" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitAmount3" type="xsd:decimal" />

              <xsd:element name="stateSalesSplitRate3" type="xsd:decimal" />

              <xsd:element name="stateSalesMaxTaxAmount3" type="xsd:decimal" />

              <xsd:element name="countyName" type="xsd:string" />

              <xsd:element name="countySalesRate1" type="xsd:decimal" />

              <xsd:element name="countySalesMinimum1" type="xsd:decimal" />

              <xsd:element name="countySalesMaximum1" type="xsd:decimal" />

              <xsd:element name="countySalesSplitAmount1" type="xsd:decimal" />

              <xsd:element name="countySplitSalesRate1" type="xsd:decimal" />

              <xsd:element name="countySalesMaxTaxAmount1" type="xsd:decimal" />

              <xsd:element name="countySalesRate2" type="xsd:decimal" />

              <xsd:element name="countySalesMinimum2" type="xsd:decimal" />

              <xsd:element name="countySalesMaximum2" type="xsd:decimal" />

              <xsd:element name="countySalesSplitAmount2" type="xsd:decimal" />

              <xsd:element name="countySalesSplitRate2" type="xsd:decimal" />

              <xsd:element name="countySalesMaxTaxAmount2" type="xsd:decimal" />

              <xsd:element name="countySalesRate3" type="xsd:decimal" />

              <xsd:element name="countySalesMinimum3" type="xsd:decimal" />

              <xsd:element name="countySalesMaximum3" type="xsd:decimal" />

              <xsd:element name="countySalesSplitAmount3" type="xsd:decimal" />

              <xsd:element name="countySalesSplitRate3" type="xsd:decimal" />

              <xsd:element name="countySalesMaxTaxAmount3" type="xsd:decimal" />

              <xsd:element name="cityName" type="xsd:string" />

              <xsd:element name="citySalesRate1" type="xsd:decimal" />

              <xsd:element name="citySalesMinimum1" type="xsd:decimal" />

              <xsd:element name="citySalesMaximum1" type="xsd:decimal" />

              <xsd:element name="citySalesSplitAmount1" type="xsd:decimal" />

              <xsd:element name="citySplitSalesRate1" type="xsd:decimal" />

              <xsd:element name="citySalesMaxTaxAmount1" type="xsd:decimal" />

              <xsd:element name="citySalesRate2" type="xsd:decimal" />

              <xsd:element name="citySalesMinimum2" type="xsd:decimal" />

              <xsd:element name="citySalesMaximum2" type="xsd:decimal" />

              <xsd:element name="citySalesSplitAmount2" type="xsd:decimal" />

              <xsd:element name="citySalesSplitRate2" type="xsd:decimal" />

              <xsd:element name="citySalesMaxTaxAmount2" type="xsd:decimal" />

              <xsd:element name="citySalesRate3" type="xsd:decimal" />

              <xsd:element name="citySalesMinimum3" type="xsd:decimal" />

              <xsd:element name="citySalesMaximum3" type="xsd:decimal" />

              <xsd:element name="citySalesSplitAmount3" type="xsd:decimal" />

              <xsd:element name="citySalesSplitRate3" type="xsd:decimal" />

              <xsd:element name="citySalesMaxTaxAmount3" type="xsd:decimal" />

              <xsd:element name="stj1Name" type="xsd:string" />

              <xsd:element name="stj1SalesRate1" type="xsd:decimal" />

              <xsd:element name="stj2Name" type="xsd:string" />

              <xsd:element name="stj2SalesRate1" type="xsd:decimal" />

              <xsd:element name="stj3Name" type="xsd:string" />

              <xsd:element name="stj3SalesRate1" type="xsd:decimal" />

              <xsd:element name="stj4Name" type="xsd:string" />

              <xsd:element name="stj4SalesRate1" type="xsd:decimal" />

              <xsd:element name="stj5Name" type="xsd:string" />

              <xsd:element name="stj5SalesRate1" type="xsd:decimal" />

              <xsd:element name="combinedSalesTaxRate" type="xsd:decimal" />

              <xsd:element name="sdCode" type="xsd:int" />

              <xsd:element name="defaultCity" type="xsd:string" />

            </xsd:sequence>

          </xsd:complexType>

        </xsd:element>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

Location Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element maxOccurs="unbounded" name="location">

          <xsd:complexType>

            <xsd:sequence>

              <xsd:element name="code" type="xsd:string" />

              <xsd:element name="sdCode" type="xsd:string" />

              <xsd:element name="version" type="xsd:int" />

              <xsd:element name="stateName" type="xsd:string" />

              <xsd:element name="geocode" type="xsd:string" />

              <xsd:element name="cityName" type="xsd:string" />

              <xsd:element name="parentCompany">

                <xsd:complexType>

                  <xsd:sequence>

                    <xsd:element name="version" type="xsd:int" />

                    <xsd:element name="companyName" type="xsd:string" />

                    <xsd:element name="id" type="xsd:int" />

                  </xsd:sequence>

                </xsd:complexType>

              </xsd:element>

              <xsd:element name="countyName" type="xsd:string" />

              <xsd:element name="autoUnmapped" type="xsd:boolean" />

              <xsd:element name="hideZip" type="xsd:boolean" />

              <xsd:element name="longitude" type="xsd:string" />

              <xsd:element name="geocodeCityName" type="xsd:string" />

              <xsd:element name="latitude" type="xsd:string" />

              <xsd:element name="id" type="xsd:int" />

              <xsd:element name="streetAddress2" type="xsd:string" />

              <xsd:element name="country" type="xsd:string" />

              <xsd:element name="streetAddress1" type="xsd:string" />

              <xsd:element name="geocodeZip" type="xsd:string" />

              <xsd:element name="oclIndicator" type="xsd:boolean" />

              <xsd:element name="zip" type="xsd:string" />

              <xsd:element name="name" type="xsd:string" />

            </xsd:sequence>

          </xsd:complexType>

        </xsd:element>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

Message Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element name="message" type="xsd:string" />

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

Geocode Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element maxOccurs="unbounded" name="geocodeRecord">

          <xsd:complexType>

            <xsd:sequence>

              <xsd:element name="geocode" type="xsd:decimal" />

              <xsd:element name="zip" type="xsd:string" />

              <xsd:element name="stateName" type="xsd:string" />

              <xsd:element name="countyName" type="xsd:string" />

              <xsd:element name="cityName" type="xsd:string" />

              <xsd:element name="sdCode" type="xsd:int" />

              <xsd:element name="defaultCity" type="xsd:string" />

            </xsd:sequence>

          </xsd:complexType>

        </xsd:element>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

Company Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element maxOccurs="unbounded" name="company">

          <xsd:complexType>

            <xsd:sequence>

              <xsd:element name="version" type="xsd:int" />

              <xsd:element name="companyName" type="xsd:string" />

              <xsd:element name="id" type="xsd:int" />

            </xsd:sequence>

          </xsd:complexType>

        </xsd:element>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

SubCompany Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element maxOccurs="unbounded" name="subCompany">

          <xsd:complexType>

            <xsd:sequence>

              <xsd:element name="version" type="xsd:int" />

              <xsd:element name="subCompanyName" type="xsd:string" />

              <xsd:element name="parentCompany">

                <xsd:complexType>

                  <xsd:sequence>

                    <xsd:element name="version" type="xsd:int" />

                    <xsd:element name="companyName" type="xsd:string" />

                    <xsd:element name="id" type="xsd:int" />

                  </xsd:sequence>

                </xsd:complexType>

              </xsd:element>

              <xsd:element name="id" type="xsd:int" />

            </xsd:sequence>

          </xsd:complexType>

        </xsd:element>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

Value Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element name="value" type="xsd:boolean" />

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

LocationId Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element name="locationId" type="xsd:int" />

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

Address Response

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element name="address">

          <xsd:complexType>

            <xsd:sequence>

              <xsd:element name="confidence" type="xsd:int" />

              <xsd:element name="cityName" type="xsd:string" />

              <xsd:element name="streetAddress2" type="xsd:string" />

              <xsd:element name="countyName" type="xsd:string" />

              <xsd:element name="streetAddress1" type="xsd:string" />

              <xsd:element name="zip" type="xsd:string" />

              <xsd:element name="stateName" type="xsd:string" />

              <xsd:element name="country" type="xsd:string" />

            </xsd:sequence>

          </xsd:complexType>

        </xsd:element>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>