AIM Web Services

<back to all web services

GetTaxAuthoritiesRequest

GetTaxAuthorities
Requires active-e Customer Service.

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * GetTaxAuthoritiesRequires active-e Customer Service.
    */
    @DataContract
    public static class GetTaxAuthoritiesRequest extends BaseSecureRequest
    {
        /**
        * Tax Authority lookup. If sent, all other parameters will be ignored.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Tax Authority lookup. If sent, all other parameters will be ignored.", Format="int64", Name="TaxAuthorityId", ParameterType="query")
        public Long TaxAuthorityId = null;
        
        public Long getTaxAuthorityId() { return TaxAuthorityId; }
        public GetTaxAuthoritiesRequest setTaxAuthorityId(Long value) { this.TaxAuthorityId = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * This is your AIM API Key provided by Tri-Tech
        */
        @DataMember
        @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class GetTaxAuthoritiesResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<TaxAuthoritityInfo> TaxAuthorities = null;
        
        public ArrayList<TaxAuthoritityInfo> getTaxAuthorities() { return TaxAuthorities; }
        public GetTaxAuthoritiesResponse setTaxAuthorities(ArrayList<TaxAuthoritityInfo> value) { this.TaxAuthorities = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class TaxAuthoritityInfo
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String Desc = null;

        @DataMember
        public String ShortDesc = null;

        @DataMember
        public String City = null;

        @DataMember
        public String County = null;

        @DataMember
        public String ZipCode = null;

        @DataMember
        public String GeoCode = null;

        @DataMember
        public BigDecimal TaxRate1 = null;

        @DataMember
        public BigDecimal TaxRate2 = null;
        
        public Long getId() { return Id; }
        public TaxAuthoritityInfo setId(Long value) { this.Id = value; return this; }
        public String getDesc() { return Desc; }
        public TaxAuthoritityInfo setDesc(String value) { this.Desc = value; return this; }
        public String getShortDesc() { return ShortDesc; }
        public TaxAuthoritityInfo setShortDesc(String value) { this.ShortDesc = value; return this; }
        public String getCity() { return City; }
        public TaxAuthoritityInfo setCity(String value) { this.City = value; return this; }
        public String getCounty() { return County; }
        public TaxAuthoritityInfo setCounty(String value) { this.County = value; return this; }
        public String getZipCode() { return ZipCode; }
        public TaxAuthoritityInfo setZipCode(String value) { this.ZipCode = value; return this; }
        public String getGeoCode() { return GeoCode; }
        public TaxAuthoritityInfo setGeoCode(String value) { this.GeoCode = value; return this; }
        public BigDecimal getTaxRate1() { return TaxRate1; }
        public TaxAuthoritityInfo setTaxRate1(BigDecimal value) { this.TaxRate1 = value; return this; }
        public BigDecimal getTaxRate2() { return TaxRate2; }
        public TaxAuthoritityInfo setTaxRate2(BigDecimal value) { this.TaxRate2 = value; return this; }
    }

}

Java GetTaxAuthoritiesRequest DTOs

GET /api/GetTaxAuthorities HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTaxAuthoritiesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <TaxAuthorities>
    <GetTaxAuthoritiesResponse.TaxAuthoritityInfo>
      <City>String</City>
      <County>String</County>
      <Desc>String</Desc>
      <GeoCode>String</GeoCode>
      <Id>0</Id>
      <ShortDesc>String</ShortDesc>
      <TaxRate1>0</TaxRate1>
      <TaxRate2>0</TaxRate2>
      <ZipCode>String</ZipCode>
    </GetTaxAuthoritiesResponse.TaxAuthoritityInfo>
  </TaxAuthorities>
</GetTaxAuthoritiesResponse>