TicketUserServices

GiftCardIssueRequest

**Requires Authentication**
Requires any of the roles:	Admin, TeamAdmin	Required permission:	Tickets.Add

The following routes are available for this service:
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 .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/Issue HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GiftCardIssueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Activate>false</Activate>
  <AmountMinor>0</AmountMinor>
  <BuyerEmail>String</BuyerEmail>
  <BuyerName>String</BuyerName>
  <BuyerPhone>String</BuyerPhone>
  <Code>String</Code>
  <GiftCardTypeId>0</GiftCardTypeId>
  <IdempotencyKey>String</IdempotencyKey>
  <Note>String</Note>
  <RecipientName>String</RecipientName>
</GiftCardIssueRequest>

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

<GiftCardIssueResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Code>String</Code>
  <CodeLast4>String</CodeLast4>
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <GiftCardId>0</GiftCardId>
  <Message>String</Message>
  <PaymentId>String</PaymentId>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
  <Success>false</Success>
</GiftCardIssueResult>