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 java.io.InputStream
import net.servicestack.client.*


/**
* UpdateCCRequires active-e Customer Service.
*/
@DataContract
open class UpdateCcRequest : BaseSecureRequest()
{
    @DataMember
    open var CardToken:String? = null

    @DataMember
    open var LastFour:String? = null

    @DataMember
    open var ExpirationMonth:Int? = null

    @DataMember
    open var ExpirationYear:Int? = null

    @DataMember
    open var CardExpiration:String? = null

    @DataMember
    open var CardType:String? = null

    @DataMember
    open var AcctType:String? = null

    @DataMember
    open var Gateway:String? = null

    @DataMember
    open var TokenPk:String? = null

    @DataMember
    open var WebRef:String? = null

    @DataMember
    open var NickName:String? = null

    @DataMember
    open var Acct:Int? = null

    @DataMember
    open var MakePrimaryCard:Boolean? = null

    @DataMember
    open var IsTempToken:Boolean? = null

    @DataMember
    open var EnableAutoPay:Boolean? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    open var Token: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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    open var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    open var AppId:String? = null
}

@DataContract
open class UpdateCcResponse : BaseResponse()
{
    @DataMember
    open var Topic:String? = null

    @DataMember
    open var ErrorDetails:String? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    open var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    open var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    open var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    open var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    open var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    open var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    open var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    open var IpAddress:String? = null
}

Kotlin UpdateCcRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"CardToken":"String","LastFour":"String","ExpirationMonth":0,"ExpirationYear":0,"CardExpiration":"String","CardType":"String","AcctType":"String","Gateway":"String","TokenPk":"String","WebRef":"String","NickName":"String","Acct":0,"MakePrimaryCard":false,"IsTempToken":false,"EnableAutoPay":false,"Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}

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

{"Topic":"String","ErrorDetails":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}