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
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type LocalizedMessage() = 
        member val Is:String = null with get,set
        member val En:String = null with get,set

    [<AllowNullLiteral>]
    type GiftCardRedeemResult() = 
        member val Ok:Boolean = new Boolean() with get,set
        member val Reason:String = null with get,set
        member val Message:LocalizedMessage = null with get,set
        member val RedeemedAmountMinor:Int32 = new Int32() with get,set
        member val NewBalanceMinor:Int32 = new Int32() with get,set
        member val TransactionId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SettlementTag:String = null with get,set
        member val StatusCode:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type GiftCardRedeemRequest() = 
        member val HoldId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Code:String = null with get,set
        member val AmountMinor:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EventId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TargetOwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OrderPaymentReference:String = null with get,set
        member val IdempotencyKey:String = null with get,set

F# GiftCardRedeemRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	holdId: 0,
	code: String,
	amountMinor: 0,
	eventId: 0,
	targetOwnerId: 0,
	orderPaymentReference: String,
	idempotencyKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ok: False,
	reason: String,
	message: 
	{
		is: String,
		en: String
	},
	redeemedAmountMinor: 0,
	newBalanceMinor: 0,
	transactionId: 0,
	settlementTag: String,
	statusCode: 0
}