| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | ReadData |
| POST | /OrderOwnerCards/upgrade/candidates | Live owner cards of a verified phone and the card types each may be upgraded to (rules U1-U10) |
|---|
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 OwnerCardUpgradeResultBase:
status_code: Optional[int] = None
message: Optional[str] = None
reason: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerCardUpgradeTarget:
owner_card_type_id: Optional[int] = None
name: Optional[str] = None
description: Optional[str] = None
image_url: Optional[str] = None
price: Optional[int] = None
delta: Optional[int] = None
valid_from_u_t_c: Optional[datetime.datetime] = None
valid_to_u_t_c: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerCardUpgradeSource:
source_owner_card_id: Optional[int] = None
owner_id: Optional[int] = None
owner_card_type_id: Optional[int] = None
type_name: Optional[str] = None
price_paid: Optional[int] = None
card_price: Optional[int] = None
card_valid_from_u_t_c: Optional[datetime.datetime] = None
card_valid_to_u_t_c: Optional[datetime.datetime] = None
payment_status: Optional[str] = None
eligible: Optional[bool] = None
reason_code: Optional[int] = None
reason: Optional[str] = None
candidates: Optional[List[OwnerCardUpgradeTarget]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerCardsUpgradeCandidatesResult(OwnerCardUpgradeResultBase):
enabled: Optional[bool] = None
cards: Optional[List[OwnerCardUpgradeSource]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwnerCardsUpgradeCandidatesRequest:
buyer_phone: Optional[str] = None
source_owner_card_id: Optional[int] = None
Python OwnerCardsUpgradeCandidatesRequest 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 /OrderOwnerCards/upgrade/candidates HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
buyerPhone: String,
sourceOwnerCardId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
enabled: False,
cards:
[
{
sourceOwnerCardId: 0,
ownerId: 0,
ownerCardTypeId: 0,
typeName: String,
pricePaid: 0,
cardPrice: 0,
cardValidFromUTC: 0001-01-01,
cardValidToUTC: 0001-01-01,
paymentStatus: String,
eligible: False,
reasonCode: 0,
reason: String,
candidates:
[
{
ownerCardTypeId: 0,
name: String,
description: String,
imageUrl: String,
price: 0,
delta: 0,
validFromUTC: 0001-01-01,
validToUTC: 0001-01-01
}
]
}
],
statusCode: 0,
message: String,
reason: String
}