TicketUserServices

<back to all web services

GiftCardRedeemRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Redeem
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GiftCardRedeemRequest
{
    var holdId:Int? = null
    var code:String? = null
    var amountMinor:Int? = null
    var eventId:Int? = null
    var targetOwnerId:Int? = null
    var orderPaymentReference:String? = null
    var idempotencyKey:String? = null
}

open class GiftCardRedeemResult
{
    var ok:Boolean? = null
    var reason:String? = null
    var message:LocalizedMessage? = null
    var redeemedAmountMinor:Int? = null
    var newBalanceMinor:Int? = null
    var transactionId:Int? = null
    var settlementTag:String? = null
    var statusCode:Int? = null
}

open class LocalizedMessage
{
    @SerializedName("is") var Is:String? = null
    var en:String? = null
}

Kotlin GiftCardRedeemRequest 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 /GiftCard/Redeem HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GiftCardRedeemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AmountMinor>0</AmountMinor>
  <Code>String</Code>
  <EventId>0</EventId>
  <HoldId>0</HoldId>
  <IdempotencyKey>String</IdempotencyKey>
  <OrderPaymentReference>String</OrderPaymentReference>
  <TargetOwnerId>0</TargetOwnerId>
</GiftCardRedeemRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardRedeemResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>
    <En>String</En>
    <Is>String</Is>
  </Message>
  <NewBalanceMinor>0</NewBalanceMinor>
  <Ok>false</Ok>
  <Reason>String</Reason>
  <RedeemedAmountMinor>0</RedeemedAmountMinor>
  <SettlementTag>String</SettlementTag>
  <StatusCode>0</StatusCode>
  <TransactionId>0</TransactionId>
</GiftCardRedeemResult>