GET | /api/ShippingAddressLookup |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* ShippingAddressLookupRequires active-e Customer Service.
*/
@DataContract
open class ShippingAddressLookupRequest : 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")
var Acct:Int? = 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")
var ShipId:Long? = null
}
@DataContract
open class BaseSecureRequest : BaseRequest()
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
var Token:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
var DeviceId:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
var AppId:String? = null
}
@DataContract
open 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")
var ApiKey:String? = null
@DataMember
@ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
var OAuthToken:String? = null
}
@DataContract
open class ShippingAddressLookupResponse : BaseResponse()
{
@DataMember
var ShipTos:ArrayList<ShipToInfo> = ArrayList<ShipToInfo>()
}
@DataContract
open class BaseResponse
{
/**
*
*/
@DataMember
@ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
var Status:BaseResponseResult? = null
}
@DataContract
open class BaseResponseResult
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
var StatusCode:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
var Login:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
var ErrorCode:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
var ErrorDisplayText:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
var ErrorMessage:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
var DomainName:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
var IpAddress:String? = null
}
@DataContract
open class ShipToInfo
{
@DataMember
var Id:Long? = null
@DataMember
var Name:String? = null
@DataMember
var Attention:String? = null
@DataMember
var Address1:String? = null
@DataMember
var Address2:String? = null
@DataMember
var City:String? = null
@DataMember
var State:String? = null
@DataMember
var Zip:String? = null
@DataMember
var Country:String? = null
@DataMember
var Email:String? = null
@DataMember
var Phone:String? = null
@DataMember
var Phone2:String? = null
@DataMember
var Notes:String? = null
@DataMember
var Primary:Boolean? = null
@DataMember
var TaxLoc:String? = null
@DataMember
var Active:Boolean? = null
}
Kotlin ShippingAddressLookupRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
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>