AIM Web Services

<back to all web services

AddShippingAddressRequest

AddShippingAddress
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/AddShippingAddress
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * AddShippingAddressRequires active-e Customer Service.
    */
    @DataContract
    public static class AddShippingAddressRequest extends BaseSecureRequest
    {
        @DataMember
        public Integer CustomerAccount = null;

        @DataMember
        public Integer CopyAddressFromAccount = null;

        @DataMember
        public String AddressName = null;

        @DataMember
        public AddressInfo AddressInfo = null;
        
        public Integer getCustomerAccount() { return CustomerAccount; }
        public AddShippingAddressRequest setCustomerAccount(Integer value) { this.CustomerAccount = value; return this; }
        public Integer getCopyAddressFromAccount() { return CopyAddressFromAccount; }
        public AddShippingAddressRequest setCopyAddressFromAccount(Integer value) { this.CopyAddressFromAccount = value; return this; }
        public String getAddressName() { return AddressName; }
        public AddShippingAddressRequest setAddressName(String value) { this.AddressName = value; return this; }
        public AddressInfo getAddressInfo() { return AddressInfo; }
        public AddShippingAddressRequest setAddressInfo(AddressInfo value) { this.AddressInfo = 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 AddressInfo
    {
        @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 HomePhone = null;

        @DataMember
        public String WorkPhone = null;

        @DataMember
        public String Notes = null;
        
        public String getAttention() { return Attention; }
        public AddressInfo setAttention(String value) { this.Attention = value; return this; }
        public String getAddress1() { return Address1; }
        public AddressInfo setAddress1(String value) { this.Address1 = value; return this; }
        public String getAddress2() { return Address2; }
        public AddressInfo setAddress2(String value) { this.Address2 = value; return this; }
        public String getCity() { return City; }
        public AddressInfo setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public AddressInfo setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public AddressInfo setZip(String value) { this.Zip = value; return this; }
        public String getCountry() { return Country; }
        public AddressInfo setCountry(String value) { this.Country = value; return this; }
        public String getEmail() { return Email; }
        public AddressInfo setEmail(String value) { this.Email = value; return this; }
        public String getHomePhone() { return HomePhone; }
        public AddressInfo setHomePhone(String value) { this.HomePhone = value; return this; }
        public String getWorkPhone() { return WorkPhone; }
        public AddressInfo setWorkPhone(String value) { this.WorkPhone = value; return this; }
        public String getNotes() { return Notes; }
        public AddressInfo setNotes(String value) { this.Notes = value; return this; }
    }

    @DataContract
    public static class AddShippingAddressResponse extends BaseResponse
    {
        @DataMember
        public Long AddressId = null;
        
        public Long getAddressId() { return AddressId; }
        public AddShippingAddressResponse setAddressId(Long value) { this.AddressId = 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; }
    }

}

Java AddShippingAddressRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/AddShippingAddress HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddShippingAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <AddressInfo>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <Attention>String</Attention>
    <City>String</City>
    <Country>String</Country>
    <Email>String</Email>
    <HomePhone>String</HomePhone>
    <Notes>String</Notes>
    <State>String</State>
    <WorkPhone>String</WorkPhone>
    <Zip>String</Zip>
  </AddressInfo>
  <AddressName>String</AddressName>
  <CopyAddressFromAccount>0</CopyAddressFromAccount>
  <CustomerAccount>0</CustomerAccount>
</AddShippingAddressRequest>

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

<AddShippingAddressResponse 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>
  <AddressId>0</AddressId>
</AddShippingAddressResponse>