TicketUserServices

<back to all web services

GiftCardTypesSearchRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCardType/Search
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 GiftCardType:
    id: Optional[int] = None
    name: Optional[str] = None
    scope: Optional[str] = None
    owner_id: Optional[int] = None
    currency: Optional[str] = None
    default_expiry_months: Optional[int] = None
    is_active: Optional[bool] = None
    created_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardTypesResult:
    items: Optional[List[GiftCardType]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GiftCardTypesSearchRequest:
    scope: Optional[str] = None
    owner_id: Optional[int] = None

Python GiftCardTypesSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GiftCardType/Search HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	scope: String,
	ownerId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	items: 
	[
		{
			id: 0,
			name: String,
			scope: String,
			ownerId: 0,
			currency: String,
			defaultExpiryMonths: 0,
			isActive: False,
			createdAt: 0001-01-01
		}
	],
	statusCode: 0,
	message: String
}