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 Foundation
import ServiceStack

/**
* UpdateCCRequires active-e Customer Service.
*/
// @DataContract
public class UpdateCcRequest : BaseSecureRequest
{
    // @DataMember
    public var cardToken:String

    // @DataMember
    public var lastFour:String

    // @DataMember
    public var expirationMonth:Int

    // @DataMember
    public var expirationYear:Int

    // @DataMember
    public var cardExpiration:String

    // @DataMember
    public var cardType:String

    // @DataMember
    public var acctType:String

    // @DataMember
    public var gateway:String

    // @DataMember
    public var tokenPk:String

    // @DataMember
    public var webRef:String

    // @DataMember
    public var nickName:String

    // @DataMember
    public var acct:Int?

    // @DataMember
    public var makePrimaryCard:Bool

    // @DataMember
    public var isTempToken:Bool

    // @DataMember
    public var enableAutoPay:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case cardToken
        case lastFour
        case expirationMonth
        case expirationYear
        case cardExpiration
        case cardType
        case acctType
        case gateway
        case tokenPk
        case webRef
        case nickName
        case acct
        case makePrimaryCard
        case isTempToken
        case enableAutoPay
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        cardToken = try container.decodeIfPresent(String.self, forKey: .cardToken)
        lastFour = try container.decodeIfPresent(String.self, forKey: .lastFour)
        expirationMonth = try container.decodeIfPresent(Int.self, forKey: .expirationMonth)
        expirationYear = try container.decodeIfPresent(Int.self, forKey: .expirationYear)
        cardExpiration = try container.decodeIfPresent(String.self, forKey: .cardExpiration)
        cardType = try container.decodeIfPresent(String.self, forKey: .cardType)
        acctType = try container.decodeIfPresent(String.self, forKey: .acctType)
        gateway = try container.decodeIfPresent(String.self, forKey: .gateway)
        tokenPk = try container.decodeIfPresent(String.self, forKey: .tokenPk)
        webRef = try container.decodeIfPresent(String.self, forKey: .webRef)
        nickName = try container.decodeIfPresent(String.self, forKey: .nickName)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
        makePrimaryCard = try container.decodeIfPresent(Bool.self, forKey: .makePrimaryCard)
        isTempToken = try container.decodeIfPresent(Bool.self, forKey: .isTempToken)
        enableAutoPay = try container.decodeIfPresent(Bool.self, forKey: .enableAutoPay)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if cardToken != nil { try container.encode(cardToken, forKey: .cardToken) }
        if lastFour != nil { try container.encode(lastFour, forKey: .lastFour) }
        if expirationMonth != nil { try container.encode(expirationMonth, forKey: .expirationMonth) }
        if expirationYear != nil { try container.encode(expirationYear, forKey: .expirationYear) }
        if cardExpiration != nil { try container.encode(cardExpiration, forKey: .cardExpiration) }
        if cardType != nil { try container.encode(cardType, forKey: .cardType) }
        if acctType != nil { try container.encode(acctType, forKey: .acctType) }
        if gateway != nil { try container.encode(gateway, forKey: .gateway) }
        if tokenPk != nil { try container.encode(tokenPk, forKey: .tokenPk) }
        if webRef != nil { try container.encode(webRef, forKey: .webRef) }
        if nickName != nil { try container.encode(nickName, forKey: .nickName) }
        if acct != nil { try container.encode(acct, forKey: .acct) }
        if makePrimaryCard != nil { try container.encode(makePrimaryCard, forKey: .makePrimaryCard) }
        if isTempToken != nil { try container.encode(isTempToken, forKey: .isTempToken) }
        if enableAutoPay != nil { try container.encode(enableAutoPay, forKey: .enableAutoPay) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class UpdateCcResponse : BaseResponse
{
    // @DataMember
    public var topic:String

    // @DataMember
    public var errorDetails:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case topic
        case errorDetails
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        topic = try container.decodeIfPresent(String.self, forKey: .topic)
        errorDetails = try container.decodeIfPresent(String.self, forKey: .errorDetails)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if topic != nil { try container.encode(topic, forKey: .topic) }
        if errorDetails != nil { try container.encode(errorDetails, forKey: .errorDetails) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

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

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

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

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

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

Swift 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>