| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Required permission: | Tickets.Add |
| POST | /GiftCard/Hold |
|---|
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 LocalizedMessage:
is_: Optional[str] = field(metadata=config(field_name='is'), default=None)
en: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardHoldResult:
ok: Optional[bool] = None
reason: Optional[str] = None
message: Optional[LocalizedMessage] = None
hold_id: Optional[int] = None
held_amount_minor: Optional[int] = None
remaining_available_minor: Optional[int] = None
expires_at: Optional[datetime.datetime] = None
status_code: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardHoldRequest:
code: Optional[str] = None
amount_minor: Optional[int] = None
event_id: Optional[int] = None
target_owner_id: Optional[int] = None
order_payment_reference: Optional[str] = None
idempotency_key: Optional[str] = None
Python GiftCardHoldRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /GiftCard/Hold HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GiftCardHoldRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<AmountMinor>0</AmountMinor>
<Code>String</Code>
<EventId>0</EventId>
<IdempotencyKey>String</IdempotencyKey>
<OrderPaymentReference>String</OrderPaymentReference>
<TargetOwnerId>0</TargetOwnerId>
</GiftCardHoldRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GiftCardHoldResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
<HeldAmountMinor>0</HeldAmountMinor>
<HoldId>0</HoldId>
<Message>
<En>String</En>
<Is>String</Is>
</Message>
<Ok>false</Ok>
<Reason>String</Reason>
<RemainingAvailableMinor>0</RemainingAvailableMinor>
<StatusCode>0</StatusCode>
</GiftCardHoldResult>