AIM Web Services

<back to all web services

GiftCardRequest

GiftCard
Requires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.

The following routes are available for this service:
GET, POST/api/GiftCard
import Foundation
import ServiceStack

/**
* GiftCardRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
// @DataContract
public class GiftCardRequest : BaseRequest
{
    // @DataMember
    public var giftCard:String

    // @DataMember
    public var pin:String

    // @DataMember
    public var webRef:String

    // @DataMember
    public var chargeAmount:Double

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

    private enum CodingKeys : String, CodingKey {
        case giftCard
        case pin
        case webRef
        case chargeAmount
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        giftCard = try container.decodeIfPresent(String.self, forKey: .giftCard)
        pin = try container.decodeIfPresent(String.self, forKey: .pin)
        webRef = try container.decodeIfPresent(String.self, forKey: .webRef)
        chargeAmount = try container.decodeIfPresent(Double.self, forKey: .chargeAmount)
    }

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

// @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 GiftCardResponse : BaseResponse
{
    // @DataMember
    public var balance:Double

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

    private enum CodingKeys : String, CodingKey {
        case balance
    }

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

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

// @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 GiftCardRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/GiftCard HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"GiftCard":"String","PIN":"String","WebRef":"String","ChargeAmount":0,"ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Balance":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}