TicketUserServices

<back to all web services

DiscountCodeReportRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
POST/DiscountCodeReport
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 DiscountCodeReportRow:
    code: Optional[str] = None
    discount_code_type_id: Optional[int] = None
    type_name: Optional[str] = None
    is_percent: Optional[bool] = None
    percent: Optional[Decimal] = None
    fixed_amount: Optional[Decimal] = None
    redemptions: Optional[int] = None
    ticket_count: Optional[int] = None
    amount_discounted: Optional[Decimal] = None
    reversed_redemptions: Optional[int] = None
    reversed_amount: Optional[Decimal] = None
    first_used_at: Optional[datetime.datetime] = None
    last_used_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DiscountCodeReportResult:
    items: Optional[List[DiscountCodeReportRow]] = None
    ticket_count_total: Optional[int] = None
    amount_discounted_total: Optional[Decimal] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DiscountCodeReportRequest:
    owner_id: Optional[int] = None
    event_ids: Optional[List[int]] = None

Python DiscountCodeReportRequest 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 /DiscountCodeReport HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ownerId: 0,
	eventIds: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	items: 
	[
		{
			code: String,
			discountCodeTypeId: 0,
			typeName: String,
			isPercent: False,
			percent: 0,
			fixedAmount: 0,
			redemptions: 0,
			ticketCount: 0,
			amountDiscounted: 0,
			reversedRedemptions: 0,
			reversedAmount: 0,
			firstUsedAt: 0001-01-01,
			lastUsedAt: 0001-01-01
		}
	],
	ticketCountTotal: 0,
	amountDiscountedTotal: 0,
	statusCode: 0,
	message: String
}