| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Requires the permission: | ReadData |
| POST | /GiftCard/Validate |
|---|
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 GiftCardValidateRequest:
code: Optional[str] = None
event_id: Optional[int] = None
target_owner_id: Optional[int] = None
amount_minor: Optional[int] = None
Python GiftCardValidateRequest 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/Validate HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
code: String,
eventId: 0,
targetOwnerId: 0,
amountMinor: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ok: False,
reason: String,
message:
{
is: String,
en: String
},
status: String,
availableMinor: 0,
applicableMinor: 0,
scope: String,
scopeOwnerId: 0,
expiresAt: 0001-01-01,
statusCode: 0
}