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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardLedgerResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Card>
    <ActivatedAt>0001-01-01T00:00:00</ActivatedAt>
    <BuyerEmail>String</BuyerEmail>
    <BuyerName>String</BuyerName>
    <BuyerPhone>String</BuyerPhone>
    <CodeLast4>String</CodeLast4>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <Currency>String</Currency>
    <CurrentBalanceMinor>0</CurrentBalanceMinor>
    <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
    <GiftCardTypeId>0</GiftCardTypeId>
    <ID>0</ID>
    <InitialValueMinor>0</InitialValueMinor>
    <PaymentId>String</PaymentId>
    <PaymentMethodId>String</PaymentMethodId>
    <PurchasePaymentReference>String</PurchasePaymentReference>
    <Scope>String</Scope>
    <ScopeOwnerId>0</ScopeOwnerId>
    <Status>String</Status>
  </Card>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
  <Transactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:GiftCardTransaction>
      <d2p1:AmountMinor>0</d2p1:AmountMinor>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:EventId>0</d2p1:EventId>
      <d2p1:GiftCardId>0</d2p1:GiftCardId>
      <d2p1:HoldExpiresAt>0001-01-01T00:00:00</d2p1:HoldExpiresAt>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:IdempotencyKey>String</d2p1:IdempotencyKey>
      <d2p1:Kind>String</d2p1:Kind>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:OrderPaymentReference>String</d2p1:OrderPaymentReference>
      <d2p1:OwnerId>0</d2p1:OwnerId>
      <d2p1:RelatedHoldId>0</d2p1:RelatedHoldId>
      <d2p1:Status>String</d2p1:Status>
    </d2p1:GiftCardTransaction>
  </Transactions>
</GiftCardLedgerResult>