AIM Web Services

<back to all web services

UpdateCcRequest

UpdateCC
Requires active-e Customer Service.

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

public class dtos
{

    /**
    * UpdateCCRequires active-e Customer Service.
    */
    @DataContract
    public static class UpdateCcRequest extends BaseSecureRequest
    {
        @DataMember
        public String CardToken = null;

        @DataMember
        public String LastFour = null;

        @DataMember
        public Integer ExpirationMonth = null;

        @DataMember
        public Integer ExpirationYear = null;

        @DataMember
        public String CardExpiration = null;

        @DataMember
        public String CardType = null;

        @DataMember
        public String AcctType = null;

        @DataMember
        public String Gateway = null;

        @DataMember
        public String TokenPk = null;

        @DataMember
        public String WebRef = null;

        @DataMember
        public String NickName = null;

        @DataMember
        public Integer Acct = null;

        @DataMember
        public Boolean MakePrimaryCard = null;

        @DataMember
        public Boolean IsTempToken = null;

        @DataMember
        public Boolean EnableAutoPay = null;
        
        public String getCardToken() { return CardToken; }
        public UpdateCcRequest setCardToken(String value) { this.CardToken = value; return this; }
        public String getLastFour() { return LastFour; }
        public UpdateCcRequest setLastFour(String value) { this.LastFour = value; return this; }
        public Integer getExpirationMonth() { return ExpirationMonth; }
        public UpdateCcRequest setExpirationMonth(Integer value) { this.ExpirationMonth = value; return this; }
        public Integer getExpirationYear() { return ExpirationYear; }
        public UpdateCcRequest setExpirationYear(Integer value) { this.ExpirationYear = value; return this; }
        public String getCardExpiration() { return CardExpiration; }
        public UpdateCcRequest setCardExpiration(String value) { this.CardExpiration = value; return this; }
        public String getCardType() { return CardType; }
        public UpdateCcRequest setCardType(String value) { this.CardType = value; return this; }
        public String getAcctType() { return AcctType; }
        public UpdateCcRequest setAcctType(String value) { this.AcctType = value; return this; }
        public String getGateway() { return Gateway; }
        public UpdateCcRequest setGateway(String value) { this.Gateway = value; return this; }
        public String getTokenPk() { return TokenPk; }
        public UpdateCcRequest setTokenPk(String value) { this.TokenPk = value; return this; }
        public String getWebRef() { return WebRef; }
        public UpdateCcRequest setWebRef(String value) { this.WebRef = value; return this; }
        public String getNickName() { return NickName; }
        public UpdateCcRequest setNickName(String value) { this.NickName = value; return this; }
        public Integer getAcct() { return Acct; }
        public UpdateCcRequest setAcct(Integer value) { this.Acct = value; return this; }
        public Boolean isMakePrimaryCard() { return MakePrimaryCard; }
        public UpdateCcRequest setMakePrimaryCard(Boolean value) { this.MakePrimaryCard = value; return this; }
        public Boolean getIsTempToken() { return IsTempToken; }
        public UpdateCcRequest setIsTempToken(Boolean value) { this.IsTempToken = value; return this; }
        public Boolean isEnableAutoPay() { return EnableAutoPay; }
        public UpdateCcRequest setEnableAutoPay(Boolean value) { this.EnableAutoPay = 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 UpdateCcResponse extends BaseResponse
    {
        @DataMember
        public String Topic = null;

        @DataMember
        public String ErrorDetails = null;
        
        public String getTopic() { return Topic; }
        public UpdateCcResponse setTopic(String value) { this.Topic = value; return this; }
        public String getErrorDetails() { return ErrorDetails; }
        public UpdateCcResponse setErrorDetails(String value) { this.ErrorDetails = 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 UpdateCcRequest 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/UpdateCC HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateCcRequest 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>
  <Acct>0</Acct>
  <AcctType>String</AcctType>
  <CardExpiration>String</CardExpiration>
  <CardToken>String</CardToken>
  <CardType>String</CardType>
  <EnableAutoPay>false</EnableAutoPay>
  <ExpirationMonth>0</ExpirationMonth>
  <ExpirationYear>0</ExpirationYear>
  <Gateway>String</Gateway>
  <IsTempToken>false</IsTempToken>
  <LastFour>String</LastFour>
  <MakePrimaryCard>false</MakePrimaryCard>
  <NickName>String</NickName>
  <TokenPk>String</TokenPk>
  <WebRef>String</WebRef>
</UpdateCcRequest>

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

<UpdateCcResponse 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>
  <ErrorDetails>String</ErrorDetails>
  <Topic>String</Topic>
</UpdateCcResponse>