| GET | /api/AutoPayInfo |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* AutoPayInfoRequires active-e Customer Service.
*/
@DataContract
public static class AutoPayInfoRequest extends BaseSecureRequest
{
@DataMember
public Integer Acct = null;
public Integer getAcct() { return Acct; }
public AutoPayInfoRequest setAcct(Integer value) { this.Acct = 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 AutoPayInfoResponse extends BaseResponse
{
@DataMember
public CcInfo PrimaryCard = null;
@DataMember
public AchDetail AchInfo = null;
@DataMember
public ArrayList<SubAccountInfo> SubAccounts = null;
public CcInfo getPrimaryCard() { return PrimaryCard; }
public AutoPayInfoResponse setPrimaryCard(CcInfo value) { this.PrimaryCard = value; return this; }
public AchDetail getAchInfo() { return AchInfo; }
public AutoPayInfoResponse setAchInfo(AchDetail value) { this.AchInfo = value; return this; }
public ArrayList<SubAccountInfo> getSubAccounts() { return SubAccounts; }
public AutoPayInfoResponse setSubAccounts(ArrayList<SubAccountInfo> value) { this.SubAccounts = 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(Name="CCInfo")
public static class CcInfo
{
/**
* Token returned from processor
*/
@DataMember
@ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
public String TokenStr = null;
/**
* Card Type (VISA, MCARD, AMEX, DSCVR)
*/
@DataMember
@ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
public String CardType = null;
/**
* Last four of the card
*/
@DataMember
@ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
public String LastFour = null;
/**
* Expiration Date of the Card. (MM/YY)
*/
@DataMember
@ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
public String Expiration = null;
/**
* Reason the card is on file.
*/
@DataMember
@ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
public String ReasonOnFile = null;
/**
* ID of the existing Token Record in AIM, if applicable
*/
@DataMember
@ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
public Long TokenPk = null;
/**
* Is this the customer's primary card? Defaults to false.
*/
@DataMember
@ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
public Boolean Primary = null;
public String getTokenStr() { return TokenStr; }
public CcInfo setTokenStr(String value) { this.TokenStr = value; return this; }
public String getCardType() { return CardType; }
public CcInfo setCardType(String value) { this.CardType = value; return this; }
public String getLastFour() { return LastFour; }
public CcInfo setLastFour(String value) { this.LastFour = value; return this; }
public String getExpiration() { return Expiration; }
public CcInfo setExpiration(String value) { this.Expiration = value; return this; }
public String getReasonOnFile() { return ReasonOnFile; }
public CcInfo setReasonOnFile(String value) { this.ReasonOnFile = value; return this; }
public Long getTokenPk() { return TokenPk; }
public CcInfo setTokenPk(Long value) { this.TokenPk = value; return this; }
public Boolean isPrimary() { return Primary; }
public CcInfo setPrimary(Boolean value) { this.Primary = value; return this; }
}
@DataContract
public static class AchDetail
{
@DataMember
public String Name = null;
@DataMember
public String BankNumber = null;
@DataMember
public String Routing = null;
@DataMember
public String Type = null;
public String getName() { return Name; }
public AchDetail setName(String value) { this.Name = value; return this; }
public String getBankNumber() { return BankNumber; }
public AchDetail setBankNumber(String value) { this.BankNumber = value; return this; }
public String getRouting() { return Routing; }
public AchDetail setRouting(String value) { this.Routing = value; return this; }
public String getType() { return Type; }
public AchDetail setType(String value) { this.Type = value; return this; }
}
@DataContract
public static class SubAccountInfo
{
@DataMember
public String Type = null;
@DataMember
public Integer Sub = null;
@DataMember
public CcInfo CardInfo = null;
@DataMember
public String AcctType = null;
@DataMember
public AutoPayDetail AutoPayDetail = null;
@DataMember
public ArrayList<SchedulingInfo> SchedulingRecords = null;
public String getType() { return Type; }
public SubAccountInfo setType(String value) { this.Type = value; return this; }
public Integer getSub() { return Sub; }
public SubAccountInfo setSub(Integer value) { this.Sub = value; return this; }
public CcInfo getCardInfo() { return CardInfo; }
public SubAccountInfo setCardInfo(CcInfo value) { this.CardInfo = value; return this; }
public String getAcctType() { return AcctType; }
public SubAccountInfo setAcctType(String value) { this.AcctType = value; return this; }
public AutoPayDetail getAutoPayDetail() { return AutoPayDetail; }
public SubAccountInfo setAutoPayDetail(AutoPayDetail value) { this.AutoPayDetail = value; return this; }
public ArrayList<SchedulingInfo> getSchedulingRecords() { return SchedulingRecords; }
public SubAccountInfo setSchedulingRecords(ArrayList<SchedulingInfo> value) { this.SchedulingRecords = value; return this; }
}
@DataContract
public static class AutoPayDetail
{
@DataMember
public Boolean IsAutoPay = null;
@DataMember
public Boolean IsAutoPayLateOnly = null;
@DataMember
public String AutoPayType = null;
public Boolean getIsAutoPay() { return IsAutoPay; }
public AutoPayDetail setIsAutoPay(Boolean value) { this.IsAutoPay = value; return this; }
public Boolean getIsAutoPayLateOnly() { return IsAutoPayLateOnly; }
public AutoPayDetail setIsAutoPayLateOnly(Boolean value) { this.IsAutoPayLateOnly = value; return this; }
public String getAutoPayType() { return AutoPayType; }
public AutoPayDetail setAutoPayType(String value) { this.AutoPayType = value; return this; }
}
@DataContract
public static class SchedulingInfo
{
@DataMember
public String Description = null;
@DataMember
public Date StartDate = null;
@DataMember
public Date EndDate = null;
@DataMember
public AutoPayDetail AutoPayDetail = null;
public String getDescription() { return Description; }
public SchedulingInfo setDescription(String value) { this.Description = value; return this; }
public Date getStartDate() { return StartDate; }
public SchedulingInfo setStartDate(Date value) { this.StartDate = value; return this; }
public Date getEndDate() { return EndDate; }
public SchedulingInfo setEndDate(Date value) { this.EndDate = value; return this; }
public AutoPayDetail getAutoPayDetail() { return AutoPayDetail; }
public SchedulingInfo setAutoPayDetail(AutoPayDetail value) { this.AutoPayDetail = value; return this; }
}
}
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/AutoPayInfo HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AutoPayInfoResponse 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>
<AchInfo>
<BankNumber>String</BankNumber>
<Name>String</Name>
<Routing>String</Routing>
<Type>String</Type>
</AchInfo>
<PrimaryCard>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</PrimaryCard>
<SubAccounts>
<SubAccountInfo>
<AcctType>String</AcctType>
<AutoPayDetail>
<AutoPayType>String</AutoPayType>
<IsAutoPay>false</IsAutoPay>
<IsAutoPayLateOnly>false</IsAutoPayLateOnly>
</AutoPayDetail>
<CardInfo>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</CardInfo>
<SchedulingRecords>
<SchedulingInfo>
<AutoPayDetail>
<AutoPayType>String</AutoPayType>
<IsAutoPay>false</IsAutoPay>
<IsAutoPayLateOnly>false</IsAutoPayLateOnly>
</AutoPayDetail>
<Description>String</Description>
<EndDate>0001-01-01T00:00:00</EndDate>
<StartDate>0001-01-01T00:00:00</StartDate>
</SchedulingInfo>
</SchedulingRecords>
<Sub>0</Sub>
<Type>String</Type>
</SubAccountInfo>
</SubAccounts>
</AutoPayInfoResponse>