TicketUserServices

<back to all web services

GiftCardLedgerRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
GET/GiftCard/Ledger/{GiftCardId}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;
using TicketUserServices.ServiceModel.Types;

namespace TicketUserServices.ServiceModel
{
    public partial class GiftCardLedgerRequest
    {
        public virtual int GiftCardId { get; set; }
    }

    public partial class GiftCardLedgerResult
    {
        public GiftCardLedgerResult()
        {
            Transactions = new List<GiftCardTransaction>{};
        }

        public virtual GiftCardSummary Card { get; set; }
        public virtual List<GiftCardTransaction> Transactions { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class GiftCardSummary
    {
        public virtual int ID { get; set; }
        public virtual int GiftCardTypeId { get; set; }
        public virtual string CodeLast4 { get; set; }
        public virtual string Scope { get; set; }
        public virtual int? ScopeOwnerId { get; set; }
        public virtual string Currency { get; set; }
        public virtual int InitialValueMinor { get; set; }
        public virtual int CurrentBalanceMinor { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime? ActivatedAt { get; set; }
        public virtual DateTime? ExpiresAt { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual string BuyerName { get; set; }
        public virtual string BuyerEmail { get; set; }
        public virtual string BuyerPhone { get; set; }
        public virtual string PaymentId { get; set; }
        public virtual string PaymentMethodId { get; set; }
        public virtual string PurchasePaymentReference { get; set; }
    }

}

namespace TicketUserServices.ServiceModel.Types
{
    public partial class GiftCardTransaction
    {
        public virtual int ID { get; set; }
        public virtual int GiftCardId { get; set; }
        public virtual string Kind { get; set; }
        public virtual int AmountMinor { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime? HoldExpiresAt { get; set; }
        public virtual int? RelatedHoldId { get; set; }
        public virtual string OrderPaymentReference { get; set; }
        public virtual int? EventId { get; set; }
        public virtual int? OwnerId { get; set; }
        public virtual string IdempotencyKey { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual string Note { get; set; }
    }

}

C# GiftCardLedgerRequest 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.

GET /GiftCard/Ledger/{GiftCardId} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	card: 
	{
		id: 0,
		giftCardTypeId: 0,
		codeLast4: String,
		scope: String,
		scopeOwnerId: 0,
		currency: String,
		initialValueMinor: 0,
		currentBalanceMinor: 0,
		status: String,
		activatedAt: 0001-01-01,
		expiresAt: 0001-01-01,
		createdAt: 0001-01-01,
		buyerName: String,
		buyerEmail: String,
		buyerPhone: String,
		paymentId: String,
		paymentMethodId: String,
		purchasePaymentReference: String
	},
	transactions: 
	[
		{
			id: 0,
			giftCardId: 0,
			kind: String,
			amountMinor: 0,
			status: String,
			holdExpiresAt: 0001-01-01,
			relatedHoldId: 0,
			orderPaymentReference: String,
			eventId: 0,
			ownerId: 0,
			idempotencyKey: String,
			createdAt: 0001-01-01,
			note: String
		}
	],
	statusCode: 0,
	message: String
}