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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    ///<summary>
    ///UpdateCCRequires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class UpdateCcRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual string CardToken { get; set; }

        [DataMember]
        public virtual string LastFour { get; set; }

        [DataMember]
        public virtual int ExpirationMonth { get; set; }

        [DataMember]
        public virtual int ExpirationYear { get; set; }

        [DataMember]
        public virtual string CardExpiration { get; set; }

        [DataMember]
        public virtual string CardType { get; set; }

        [DataMember]
        public virtual string AcctType { get; set; }

        [DataMember]
        public virtual string Gateway { get; set; }

        [DataMember]
        public virtual string TokenPk { get; set; }

        [DataMember]
        public virtual string WebRef { get; set; }

        [DataMember]
        public virtual string NickName { get; set; }

        [DataMember]
        public virtual int? Acct { get; set; }

        [DataMember]
        public virtual bool MakePrimaryCard { get; set; }

        [DataMember]
        public virtual bool IsTempToken { get; set; }

        [DataMember]
        public virtual bool EnableAutoPay { get; set; }
    }

    [DataContract]
    public partial class UpdateCcResponse
        : BaseResponse
    {
        [DataMember]
        public virtual string Topic { get; set; }

        [DataMember]
        public virtual string ErrorDetails { get; set; }
    }

}

C# 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>