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}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel
Imports TicketUserServices.ServiceModel.Types

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class GiftCardLedgerRequest
            Public Overridable Property GiftCardId As Integer
        End Class

        Public Partial Class GiftCardLedgerResult
            Public Sub New()
                Transactions = New List(Of GiftCardTransaction)
            End Sub

            Public Overridable Property Card As GiftCardSummary
            Public Overridable Property Transactions As List(Of GiftCardTransaction)
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class GiftCardSummary
            Public Overridable Property ID As Integer
            Public Overridable Property GiftCardTypeId As Integer
            Public Overridable Property CodeLast4 As String
            Public Overridable Property Scope As String
            Public Overridable Property ScopeOwnerId As Nullable(Of Integer)
            Public Overridable Property Currency As String
            Public Overridable Property InitialValueMinor As Integer
            Public Overridable Property CurrentBalanceMinor As Integer
            Public Overridable Property Status As String
            Public Overridable Property ActivatedAt As Nullable(Of Date)
            Public Overridable Property ExpiresAt As Nullable(Of Date)
            Public Overridable Property CreatedAt As Date
            Public Overridable Property BuyerName As String
            Public Overridable Property BuyerEmail As String
            Public Overridable Property BuyerPhone As String
            Public Overridable Property PaymentId As String
            Public Overridable Property PaymentMethodId As String
            Public Overridable Property PurchasePaymentReference As String
        End Class
    End Namespace

    Namespace TicketUserServices.ServiceModel.Types

        Public Partial Class GiftCardTransaction
            Public Overridable Property ID As Integer
            Public Overridable Property GiftCardId As Integer
            Public Overridable Property Kind As String
            Public Overridable Property AmountMinor As Integer
            Public Overridable Property Status As String
            Public Overridable Property HoldExpiresAt As Nullable(Of Date)
            Public Overridable Property RelatedHoldId As Nullable(Of Integer)
            Public Overridable Property OrderPaymentReference As String
            Public Overridable Property EventId As Nullable(Of Integer)
            Public Overridable Property OwnerId As Nullable(Of Integer)
            Public Overridable Property IdempotencyKey As String
            Public Overridable Property CreatedAt As Date
            Public Overridable Property Note As String
        End Class
    End Namespace
End Namespace

VB.NET 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"}