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 java.math.*
import java.util.*
import net.servicestack.client.*


/**
* GiftCardRequires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.
*/
@DataContract
open class GiftCardRequest : BaseRequest()
{
    @DataMember
    var GiftCard:String? = null

    @DataMember
    var PIN:String? = null

    @DataMember
    var WebRef:String? = null

    @DataMember
    var ChargeAmount:BigDecimal? = null
}

@DataContract
open class BaseRequest
{
    /**
    * 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 ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class GiftCardResponse : BaseResponse()
{
    @DataMember
    var Balance:BigDecimal? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

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

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

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

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

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

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

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