| Requires the role: | Admin | Requires the permission: | ReadData |
| POST | /Support/Customer360 |
|---|
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 SupportTicketRow:
ticket_id: Optional[int] = None
ticket_token_id: Optional[str] = None
event_id: Optional[int] = None
event: Optional[str] = None
time_of_event_u_t_c: Optional[datetime.datetime] = None
event_owner_id: Optional[int] = None
event_owner_name: Optional[str] = None
ticket_status: Optional[str] = None
ticket_name: Optional[str] = None
payment_method_id: Optional[str] = None
payment_id: Optional[str] = None
payment_reference: Optional[str] = None
timestamp_bought: Optional[datetime.datetime] = None
timestamp_activated: Optional[datetime.datetime] = None
holder_name: Optional[str] = None
phone_verification_number: Optional[str] = None
payment_phone_number: Optional[str] = None
seat_display_string: Optional[str] = None
section_name: Optional[str] = None
row_name: Optional[str] = None
seat_name: Optional[str] = None
total_price: Optional[Decimal] = None
count: Optional[int] = None
ticket_transferred_from: Optional[int] = None
original_phone_verification_number: Optional[str] = None
device_id: Optional[str] = None
never_opened: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupportOwnerCardRow:
id: Optional[int] = None
owner_id: Optional[int] = None
owner_name: Optional[str] = None
owner_card_type_id: Optional[int] = None
owner_card_type_name: Optional[str] = None
holder_name: Optional[str] = None
holder_email: Optional[str] = None
phone_verification_number: Optional[str] = None
payment_phone_number: Optional[str] = None
payment_status: Optional[str] = None
payment_method_id: Optional[str] = None
payment_id: Optional[str] = None
payment_reference: Optional[str] = None
time_stamp_bought_u_t_c: Optional[datetime.datetime] = None
card_valid_from_u_t_c: Optional[datetime.datetime] = None
card_valid_to_u_t_c: Optional[datetime.datetime] = None
initial_max_tickets: Optional[int] = None
current_available_tickets: Optional[int] = None
card_price: Optional[Decimal] = None
price_paid: Optional[Decimal] = None
current_store_credit: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WebshopOrderLine:
id: Optional[int] = None
order_id: Optional[int] = None
product_id: Optional[int] = None
variant_id: Optional[int] = None
# @StringLength(200)
product_name: Optional[str] = None
# @StringLength(50)
size: Optional[str] = None
# @StringLength(50)
color: Optional[str] = None
unit_price_minor: Optional[int] = None
quantity: Optional[int] = None
line_total_minor: Optional[int] = None
# @StringLength(20)
status: Optional[str] = None
legacy_detail_id: Optional[int] = None
created_at: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupportWebshopOrderRow:
id: Optional[int] = None
order_reference: Optional[str] = None
owner_id: Optional[int] = None
owner_name: Optional[str] = None
status: Optional[str] = None
total_minor: Optional[int] = None
delivery_fee_minor: Optional[int] = None
total_discount_minor: Optional[int] = None
gift_paid_minor: Optional[int] = None
currency: Optional[str] = None
delivery_type: Optional[str] = None
payment_method_id: Optional[str] = None
payment_id: Optional[str] = None
payment_reference: Optional[str] = None
created_at: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
buyer_name: Optional[str] = None
buyer_email: Optional[str] = None
buyer_phone: Optional[str] = None
lines: Optional[List[WebshopOrderLine]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupportGiftCardRow:
id: Optional[int] = None
code_last4: Optional[str] = None
code_masked: Optional[str] = None
status: Optional[str] = None
scope: Optional[str] = None
scope_owner_id: Optional[int] = None
scope_owner_name: Optional[str] = None
purchase_owner_id: Optional[int] = None
purchase_owner_name: Optional[str] = None
currency: Optional[str] = None
initial_value_minor: Optional[int] = None
current_balance_minor: Optional[int] = None
created_at: Optional[datetime.datetime] = None
activated_at: Optional[datetime.datetime] = None
expires_at: Optional[datetime.datetime] = None
purchase_payment_reference: Optional[str] = None
payment_id: Optional[str] = None
payment_method_id: Optional[str] = None
buyer_name: Optional[str] = None
buyer_email: Optional[str] = None
buyer_phone: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupportSharedLinkRow:
id: Optional[int] = None
event_id: Optional[int] = None
event_name: Optional[str] = None
event_owner_id: Optional[int] = None
event_owner_name: Optional[str] = None
status: Optional[str] = None
recipient_phone: Optional[str] = None
recipient_email: Optional[str] = None
ticket_count: Optional[int] = None
created_at: Optional[datetime.datetime] = None
valid_to: Optional[datetime.datetime] = None
sold_at: Optional[datetime.datetime] = None
sold_ticket_order_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupportCustomerTotals:
ticket_spend: Optional[Decimal] = None
ticket_spend_live: Optional[Decimal] = None
webshop_spend_minor: Optional[int] = None
gift_card_spend_minor: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupportCustomer360Result:
phone: Optional[str] = None
email: Optional[str] = None
tickets: Optional[List[SupportTicketRow]] = None
owner_cards: Optional[List[SupportOwnerCardRow]] = None
webshop_orders: Optional[List[SupportWebshopOrderRow]] = None
gift_cards: Optional[List[SupportGiftCardRow]] = None
shared_ticket_links: Optional[List[SupportSharedLinkRow]] = None
totals: Optional[SupportCustomerTotals] = None
warnings: Optional[List[str]] = None
status_code: Optional[int] = None
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupportCustomer360Request:
phone: Optional[str] = None
email: Optional[str] = None
Python SupportCustomer360Request 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 /Support/Customer360 HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
phone: String,
email: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
phone: String,
email: String,
tickets:
[
{
ticketId: 0,
ticketTokenId: String,
eventId: 0,
event: String,
timeOfEventUTC: 0001-01-01,
eventOwnerId: 0,
eventOwnerName: String,
ticketStatus: String,
ticketName: String,
paymentMethodId: String,
paymentId: String,
paymentReference: String,
timestampBought: 0001-01-01,
timestampActivated: 0001-01-01,
holderName: String,
phoneVerificationNumber: String,
paymentPhoneNumber: String,
seatDisplayString: String,
sectionName: String,
rowName: String,
seatName: String,
totalPrice: 0,
count: 0,
ticketTransferredFrom: 0,
originalPhoneVerificationNumber: String,
deviceId: String,
neverOpened: False
}
],
ownerCards:
[
{
id: 0,
ownerId: 0,
ownerName: String,
ownerCardTypeId: 0,
ownerCardTypeName: String,
holderName: String,
holderEmail: String,
phoneVerificationNumber: String,
paymentPhoneNumber: String,
paymentStatus: String,
paymentMethodId: String,
paymentId: String,
paymentReference: String,
timeStampBoughtUTC: 0001-01-01,
cardValidFromUTC: 0001-01-01,
cardValidToUTC: 0001-01-01,
initialMaxTickets: 0,
currentAvailableTickets: 0,
cardPrice: 0,
pricePaid: 0,
currentStoreCredit: 0
}
],
webshopOrders:
[
{
id: 0,
orderReference: String,
ownerId: 0,
ownerName: String,
status: String,
totalMinor: 0,
deliveryFeeMinor: 0,
totalDiscountMinor: 0,
giftPaidMinor: 0,
currency: String,
deliveryType: String,
paymentMethodId: String,
paymentId: String,
paymentReference: String,
createdAt: 0001-01-01,
updatedAt: 0001-01-01,
buyerName: String,
buyerEmail: String,
buyerPhone: String,
lines:
[
{
id: 0,
orderId: 0,
productId: 0,
variantId: 0,
productName: String,
size: String,
color: String,
unitPriceMinor: 0,
quantity: 0,
lineTotalMinor: 0,
status: String,
legacyDetailId: 0,
createdAt: 0001-01-01
}
]
}
],
giftCards:
[
{
id: 0,
codeLast4: String,
codeMasked: String,
status: String,
scope: String,
scopeOwnerId: 0,
scopeOwnerName: String,
purchaseOwnerId: 0,
purchaseOwnerName: String,
currency: String,
initialValueMinor: 0,
currentBalanceMinor: 0,
createdAt: 0001-01-01,
activatedAt: 0001-01-01,
expiresAt: 0001-01-01,
purchasePaymentReference: String,
paymentId: String,
paymentMethodId: String,
buyerName: String,
buyerEmail: String,
buyerPhone: String
}
],
sharedTicketLinks:
[
{
id: 0,
eventId: 0,
eventName: String,
eventOwnerId: 0,
eventOwnerName: String,
status: String,
recipientPhone: String,
recipientEmail: String,
ticketCount: 0,
createdAt: 0001-01-01,
validTo: 0001-01-01,
soldAt: 0001-01-01,
soldTicketOrderId: 0
}
],
totals:
{
ticketSpend: 0,
ticketSpendLive: 0,
webshopSpendMinor: 0,
giftCardSpendMinor: 0
},
warnings:
[
String
],
statusCode: 0,
message: String
}