| Requires any of the roles: | Admin, TeamAdmin | Required permission: | Tickets.Add |
| POST | /GiftCard/Issue |
|---|
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 GiftCardIssueResult:
success: Optional[bool] = None
gift_card_id: Optional[int] = None
code: Optional[str] = None
code_last4: Optional[str] = None
status: Optional[str] = None
expires_at: Optional[datetime.datetime] = None
payment_id: Optional[str] = None
status_code: Optional[int] = None
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardIssueRequest:
gift_card_type_id: Optional[int] = None
amount_minor: Optional[int] = None
code: Optional[str] = None
activate: Optional[bool] = None
buyer_name: Optional[str] = None
buyer_email: Optional[str] = None
buyer_phone: Optional[str] = None
recipient_name: Optional[str] = None
idempotency_key: Optional[str] = None
note: Optional[str] = None
Python GiftCardIssueRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /GiftCard/Issue HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
giftCardTypeId: 0,
amountMinor: 0,
code: String,
activate: False,
buyerName: String,
buyerEmail: String,
buyerPhone: String,
recipientName: String,
idempotencyKey: String,
note: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
success: False,
giftCardId: 0,
code: String,
codeLast4: String,
status: String,
expiresAt: 0001-01-01,
paymentId: String,
statusCode: 0,
message: String
}