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

namespace TicketUserServices.ServiceModel
{
    public partial class GiftCardRedeemRequest
    {
        public virtual int? HoldId { get; set; }
        public virtual string Code { get; set; }
        public virtual int? AmountMinor { get; set; }
        public virtual int? EventId { get; set; }
        public virtual int? TargetOwnerId { get; set; }
        public virtual string OrderPaymentReference { get; set; }
        public virtual string IdempotencyKey { get; set; }
    }

    public partial class GiftCardRedeemResult
    {
        public virtual bool Ok { get; set; }
        public virtual string Reason { get; set; }
        public virtual LocalizedMessage Message { get; set; }
        public virtual int RedeemedAmountMinor { get; set; }
        public virtual int NewBalanceMinor { get; set; }
        public virtual int? TransactionId { get; set; }
        public virtual string SettlementTag { get; set; }
        public virtual int StatusCode { get; set; }
    }

    public partial class LocalizedMessage
    {
        public virtual string Is { get; set; }
        public virtual string En { get; set; }
    }

}

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