TicketUserServices

<back to all web services

GiftCardBalanceRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin, MobileAppRequires the permission:ReadData
The following routes are available for this service:
POST/GiftCard/Balance
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 GiftCardValidateResult:
    ok: Optional[bool] = None
    reason: Optional[str] = None
    message: Optional[LocalizedMessage] = None
    status: Optional[str] = None
    available_minor: Optional[int] = None
    applicable_minor: Optional[int] = None
    scope: Optional[str] = None
    scope_owner_id: 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 GiftCardBalanceRequest:
    code: Optional[str] = None

Python GiftCardBalanceRequest 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/Balance HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GiftCardBalanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Code>String</Code>
</GiftCardBalanceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GiftCardValidateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ApplicableMinor>0</ApplicableMinor>
  <AvailableMinor>0</AvailableMinor>
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <Message>
    <En>String</En>
    <Is>String</Is>
  </Message>
  <Ok>false</Ok>
  <Reason>String</Reason>
  <Scope>String</Scope>
  <ScopeOwnerId>0</ScopeOwnerId>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
</GiftCardValidateResult>