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
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class BaseRequest implements JsonSerializable
{
    public function __construct(
        /** @description 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")
        /** @var string */
        public string $ApiKey='',

        // @DataMember
        // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        /** @var string|null */
        public ?string $OAuthToken=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
        if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
        if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseSecureRequest extends BaseRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        /** @var string|null */
        public ?string $Token=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        /** @var string|null */
        public ?string $DeviceId=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        /** @var string */
        public string $AppId=''
    ) {
        parent::__construct($ApiKey,$OAuthToken);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Token'])) $this->Token = $o['Token'];
        if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
        if (isset($o['AppId'])) $this->AppId = $o['AppId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Token)) $o['Token'] = $this->Token;
        if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
        if (isset($this->AppId)) $o['AppId'] = $this->AppId;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseResponseResult implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        /** @var string|null */
        public ?string $StatusCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        /** @var string|null */
        public ?string $Login=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorDisplayText=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorMessage=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        /** @var string|null */
        public ?string $DomainName=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        /** @var string|null */
        public ?string $IpAddress=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
        if (isset($o['Login'])) $this->Login = $o['Login'];
        if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
        if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
        if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
        if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
        if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
        if (isset($this->Login)) $o['Login'] = $this->Login;
        if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
        if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
        if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
        if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
        if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseResponse implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        /** @var BaseResponseResult|null */
        public ?BaseResponseResult $Status=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class UpdateCcResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param BaseResponseResult|null $Status
     */
    public function __construct(
        ?BaseResponseResult $Status=null,
        // @DataMember
        /** @var string|null */
        public ?string $Topic=null,

        // @DataMember
        /** @var string|null */
        public ?string $ErrorDetails=null
    ) {
        parent::__construct($Status);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Topic'])) $this->Topic = $o['Topic'];
        if (isset($o['ErrorDetails'])) $this->ErrorDetails = $o['ErrorDetails'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Topic)) $o['Topic'] = $this->Topic;
        if (isset($this->ErrorDetails)) $o['ErrorDetails'] = $this->ErrorDetails;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description UpdateCCRequires active-e Customer Service. */
// @DataContract
class UpdateCcRequest extends BaseSecureRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     * @param string|null $Token
     * @param string|null $DeviceId
     * @param string $AppId
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        ?string $Token=null,
        ?string $DeviceId=null,
        string $AppId='',
        // @DataMember
        /** @var string|null */
        public ?string $CardToken=null,

        // @DataMember
        /** @var string|null */
        public ?string $LastFour=null,

        // @DataMember
        /** @var int */
        public int $ExpirationMonth=0,

        // @DataMember
        /** @var int */
        public int $ExpirationYear=0,

        // @DataMember
        /** @var string|null */
        public ?string $CardExpiration=null,

        // @DataMember
        /** @var string|null */
        public ?string $CardType=null,

        // @DataMember
        /** @var string|null */
        public ?string $AcctType=null,

        // @DataMember
        /** @var string|null */
        public ?string $Gateway=null,

        // @DataMember
        /** @var string|null */
        public ?string $TokenPk=null,

        // @DataMember
        /** @var string|null */
        public ?string $WebRef=null,

        // @DataMember
        /** @var string|null */
        public ?string $NickName=null,

        // @DataMember
        /** @var int|null */
        public ?int $Acct=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $MakePrimaryCard=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $IsTempToken=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $EnableAutoPay=null
    ) {
        parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['CardToken'])) $this->CardToken = $o['CardToken'];
        if (isset($o['LastFour'])) $this->LastFour = $o['LastFour'];
        if (isset($o['ExpirationMonth'])) $this->ExpirationMonth = $o['ExpirationMonth'];
        if (isset($o['ExpirationYear'])) $this->ExpirationYear = $o['ExpirationYear'];
        if (isset($o['CardExpiration'])) $this->CardExpiration = $o['CardExpiration'];
        if (isset($o['CardType'])) $this->CardType = $o['CardType'];
        if (isset($o['AcctType'])) $this->AcctType = $o['AcctType'];
        if (isset($o['Gateway'])) $this->Gateway = $o['Gateway'];
        if (isset($o['TokenPk'])) $this->TokenPk = $o['TokenPk'];
        if (isset($o['WebRef'])) $this->WebRef = $o['WebRef'];
        if (isset($o['NickName'])) $this->NickName = $o['NickName'];
        if (isset($o['Acct'])) $this->Acct = $o['Acct'];
        if (isset($o['MakePrimaryCard'])) $this->MakePrimaryCard = $o['MakePrimaryCard'];
        if (isset($o['IsTempToken'])) $this->IsTempToken = $o['IsTempToken'];
        if (isset($o['EnableAutoPay'])) $this->EnableAutoPay = $o['EnableAutoPay'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->CardToken)) $o['CardToken'] = $this->CardToken;
        if (isset($this->LastFour)) $o['LastFour'] = $this->LastFour;
        if (isset($this->ExpirationMonth)) $o['ExpirationMonth'] = $this->ExpirationMonth;
        if (isset($this->ExpirationYear)) $o['ExpirationYear'] = $this->ExpirationYear;
        if (isset($this->CardExpiration)) $o['CardExpiration'] = $this->CardExpiration;
        if (isset($this->CardType)) $o['CardType'] = $this->CardType;
        if (isset($this->AcctType)) $o['AcctType'] = $this->AcctType;
        if (isset($this->Gateway)) $o['Gateway'] = $this->Gateway;
        if (isset($this->TokenPk)) $o['TokenPk'] = $this->TokenPk;
        if (isset($this->WebRef)) $o['WebRef'] = $this->WebRef;
        if (isset($this->NickName)) $o['NickName'] = $this->NickName;
        if (isset($this->Acct)) $o['Acct'] = $this->Acct;
        if (isset($this->MakePrimaryCard)) $o['MakePrimaryCard'] = $this->MakePrimaryCard;
        if (isset($this->IsTempToken)) $o['IsTempToken'] = $this->IsTempToken;
        if (isset($this->EnableAutoPay)) $o['EnableAutoPay'] = $this->EnableAutoPay;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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"}}