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}
import Foundation
import ServiceStack

public class GiftCardLedgerRequest : Codable
{
    public var giftCardId:Int?

    required public init(){}
}

public class GiftCardLedgerResult : Codable
{
    public var card:GiftCardSummary?
    public var transactions:[GiftCardTransaction] = []
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class GiftCardSummary : Codable
{
    public var id:Int?
    public var giftCardTypeId:Int?
    public var codeLast4:String?
    public var scope:String?
    public var scopeOwnerId:Int?
    public var currency:String?
    public var initialValueMinor:Int?
    public var currentBalanceMinor:Int?
    public var status:String?
    public var activatedAt:Date?
    public var expiresAt:Date?
    public var createdAt:Date?
    public var buyerName:String?
    public var buyerEmail:String?
    public var buyerPhone:String?
    public var paymentId:String?
    public var paymentMethodId:String?
    public var purchasePaymentReference:String?

    required public init(){}
}

public class GiftCardTransaction : Codable
{
    public var id:Int?
    public var giftCardId:Int?
    public var kind:String?
    public var amountMinor:Int?
    public var status:String?
    public var holdExpiresAt:Date?
    public var relatedHoldId:Int?
    public var orderPaymentReference:String?
    public var eventId:Int?
    public var ownerId:Int?
    public var idempotencyKey:String?
    public var createdAt:Date?
    public var note:String?

    required public init(){}
}


Swift 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
}