TicketUserServices

GiftCardLedgerRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Requires the permission:	ReadData

The following routes are available for this service:
GET	/GiftCard/Ledger/{GiftCardId}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardSummary:
    id: Optional[int] = None
    gift_card_type_id: Optional[int] = None
    code_last4: Optional[str] = None
    scope: Optional[str] = None
    scope_owner_id: Optional[int] = None
    currency: Optional[str] = None
    initial_value_minor: Optional[int] = None
    current_balance_minor: Optional[int] = None
    status: Optional[str] = None
    activated_at: Optional[datetime.datetime] = None
    expires_at: Optional[datetime.datetime] = None
    created_at: Optional[datetime.datetime] = None
    buyer_name: Optional[str] = None
    buyer_email: Optional[str] = None
    buyer_phone: Optional[str] = None
    payment_id: Optional[str] = None
    payment_method_id: Optional[str] = None
    purchase_payment_reference: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardTransaction:
    id: Optional[int] = None
    gift_card_id: Optional[int] = None
    kind: Optional[str] = None
    amount_minor: Optional[int] = None
    status: Optional[str] = None
    hold_expires_at: Optional[datetime.datetime] = None
    related_hold_id: Optional[int] = None
    order_payment_reference: Optional[str] = None
    event_id: Optional[int] = None
    owner_id: Optional[int] = None
    idempotency_key: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardLedgerResult:
    card: Optional[GiftCardSummary] = None
    transactions: Optional[List[GiftCardTransaction]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardLedgerRequest:
    gift_card_id: Optional[int] = None

Python 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>