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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
    # @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    api_key: Optional[str] = None
    """
    This is your AIM API Key provided by Tri-Tech
    """


    # @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    o_auth_token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
    # @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    token: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    device_id: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    app_id: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
    # @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    status_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    login: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    error_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    error_display_text: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    error_message: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    domain_name: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    ip_address: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
    # @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    status: Optional[BaseResponseResult] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateCcResponse(BaseResponse):
    topic: Optional[str] = None
    error_details: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateCcRequest(BaseSecureRequest):
    """
    UpdateCCRequires active-e Customer Service.
    """

    card_token: Optional[str] = None
    last_four: Optional[str] = None
    expiration_month: int = 0
    expiration_year: int = 0
    card_expiration: Optional[str] = None
    card_type: Optional[str] = None
    acct_type: Optional[str] = None
    gateway: Optional[str] = None
    token_pk: Optional[str] = None
    web_ref: Optional[str] = None
    nick_name: Optional[str] = None
    acct: Optional[int] = None
    make_primary_card: bool = False
    is_temp_token: bool = False
    enable_auto_pay: bool = False

Python 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","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"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"}}