| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"giftCardTypeId":0,"scope":"String","ownerId":0,"status":"String","codeLast4":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":[{"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"}],"statusCode":0,"message":"String"}