AIM Web Services

<back to all web services

ShippingAddressLookupRequest

ShippingAddressLookup
Requires active-e Customer Service.

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

public class dtos
{

    /**
    * ShippingAddressLookupRequires active-e Customer Service.
    */
    @DataContract
    public static class ShippingAddressLookupRequest extends BaseSecureRequest
    {
        /**
        * Pass in this parameter if you want to lookup all shipping addresses linked to a customer. Not required if using a customer login. Do not pass in this parameter if passing in the ShipId parameter.
        */
        @DataMember
        @ApiMember(Description="Pass in this parameter if you want to lookup all shipping addresses linked to a customer. Not required if using a customer login. Do not pass in this parameter if passing in the ShipId parameter.", Name="Acct", ParameterType="query")
        public Integer Acct = null;

        /**
        * Use this parameter to lookup a single Shipping Address with this ID. Do not pass in this parameter if passing in the Acct parameter.
        */
        @DataMember
        @ApiMember(Description="Use this parameter to lookup a single Shipping Address with this ID. Do not pass in this parameter if passing in the Acct parameter.", Name="ShipId", ParameterType="query")
        public Long ShipId = null;
        
        public Integer getAcct() { return Acct; }
        public ShippingAddressLookupRequest setAcct(Integer value) { this.Acct = value; return this; }
        public Long getShipId() { return ShipId; }
        public ShippingAddressLookupRequest setShipId(Long value) { this.ShipId = 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 ShippingAddressLookupResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<ShipToInfo> ShipTos = null;
        
        public ArrayList<ShipToInfo> getShipTos() { return ShipTos; }
        public ShippingAddressLookupResponse setShipTos(ArrayList<ShipToInfo> value) { this.ShipTos = 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 ShipToInfo
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String Name = null;

        @DataMember
        public String Attention = null;

        @DataMember
        public String Address1 = null;

        @DataMember
        public String Address2 = null;

        @DataMember
        public String City = null;

        @DataMember
        public String State = null;

        @DataMember
        public String Zip = null;

        @DataMember
        public String Country = null;

        @DataMember
        public String Email = null;

        @DataMember
        public String Phone = null;

        @DataMember
        public String Phone2 = null;

        @DataMember
        public String Notes = null;

        @DataMember
        public Boolean Primary = null;

        @DataMember
        public String TaxLoc = null;

        @DataMember
        public Boolean Active = null;
        
        public Long getId() { return Id; }
        public ShipToInfo setId(Long value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ShipToInfo setName(String value) { this.Name = value; return this; }
        public String getAttention() { return Attention; }
        public ShipToInfo setAttention(String value) { this.Attention = value; return this; }
        public String getAddress1() { return Address1; }
        public ShipToInfo setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public ShipToInfo setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public ShipToInfo setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public ShipToInfo setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public ShipToInfo setZip(String value) { this.Zip = value; return this; }
        public String getCountry() { return Country; }
        public ShipToInfo setCountry(String value) { this.Country = value; return this; }
        public String getEmail() { return Email; }
        public ShipToInfo setEmail(String value) { this.Email = value; return this; }
        public String getPhone() { return Phone; }
        public ShipToInfo setPhone(String value) { this.Phone = value; return this; }
        public String getPhone2() { return Phone2; }
        public ShipToInfo setPhone2(String value) { this.Phone2 = value; return this; }
        public String getNotes() { return Notes; }
        public ShipToInfo setNotes(String value) { this.Notes = value; return this; }
        public Boolean isPrimary() { return Primary; }
        public ShipToInfo setPrimary(Boolean value) { this.Primary = value; return this; }
        public String getTaxLoc() { return TaxLoc; }
        public ShipToInfo setTaxLoc(String value) { this.TaxLoc = value; return this; }
        public Boolean isActive() { return Active; }
        public ShipToInfo setActive(Boolean value) { this.Active = value; return this; }
    }

}

Java ShippingAddressLookupRequest DTOs

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

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

<ShippingAddressLookupResponse 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>
  <ShipTos>
    <ShipToInfo>
      <Active>false</Active>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <Attention>String</Attention>
      <City>String</City>
      <Country>String</Country>
      <Email>String</Email>
      <Id>0</Id>
      <Name>String</Name>
      <Notes>String</Notes>
      <Phone>String</Phone>
      <Phone2>String</Phone2>
      <Primary>false</Primary>
      <State>String</State>
      <TaxLoc>String</TaxLoc>
      <Zip>String</Zip>
    </ShipToInfo>
  </ShipTos>
</ShippingAddressLookupResponse>