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 java.math.*
import java.util.*
import net.servicestack.client.*


open class GiftCardLedgerRequest
{
    var giftCardId:Int? = null
}

open class GiftCardLedgerResult
{
    var card:GiftCardSummary? = null
    var transactions:ArrayList<GiftCardTransaction> = ArrayList<GiftCardTransaction>()
    var statusCode:Int? = null
    var message:String? = null
}

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

open class GiftCardTransaction
{
    var id:Int? = null
    var giftCardId:Int? = null
    var kind:String? = null
    var amountMinor:Int? = null
    var status:String? = null
    var holdExpiresAt:Date? = null
    var relatedHoldId:Int? = null
    var orderPaymentReference:String? = null
    var eventId:Int? = null
    var ownerId:Int? = null
    var idempotencyKey:String? = null
    var createdAt:Date? = null
    var note:String? = null
}

Kotlin GiftCardLedgerRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000","createdAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","relatedHoldId":0,"orderPaymentReference":"String","eventId":0,"ownerId":0,"idempotencyKey":"String","createdAt":"0001-01-01T00:00:00.0000000","note":"String"}],"statusCode":0,"message":"String"}