TicketUserServices

GiftCardSearchRequest

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

The following routes are available for this service:
POST	/GiftCard/Search

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 GiftCardSearchResult:
    items: Optional[List[GiftCardSummary]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardSearchRequest:
    gift_card_type_id: Optional[int] = None
    scope: Optional[str] = None
    owner_id: Optional[int] = None
    status: Optional[str] = None
    code_last4: Optional[str] = None

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

POST /GiftCard/Search HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GiftCardSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CodeLast4>String</CodeLast4>
  <GiftCardTypeId>0</GiftCardTypeId>
  <OwnerId>0</OwnerId>
  <Scope>String</Scope>
  <Status>String</Status>
</GiftCardSearchRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items>
    <GiftCardSummary>
      <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>
    </GiftCardSummary>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</GiftCardSearchResult>