TicketUserServices

<back to all web services

OwnerCardsUpgradeCandidatesRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
POST/OrderOwnerCards/upgrade/candidatesLive owner cards of a verified phone and the card types each may be upgraded to (rules U1-U10)

export class OwnerCardUpgradeResultBase
{
    public statusCode?: number;
    public message?: string;
    public reason?: string;

    public constructor(init?: Partial<OwnerCardUpgradeResultBase>) { (Object as any).assign(this, init); }
}

export class OwnerCardUpgradeTarget
{
    public ownerCardTypeId?: number;
    public name?: string;
    public description?: string;
    public imageUrl?: string;
    public price?: number;
    public delta?: number;
    public validFromUTC?: string;
    public validToUTC?: string;

    public constructor(init?: Partial<OwnerCardUpgradeTarget>) { (Object as any).assign(this, init); }
}

export class OwnerCardUpgradeSource
{
    public sourceOwnerCardId?: number;
    public ownerId?: number;
    public ownerCardTypeId?: number;
    public typeName?: string;
    public pricePaid?: number;
    public cardPrice?: number;
    public cardValidFromUTC?: string;
    public cardValidToUTC?: string;
    public paymentStatus?: string;
    public eligible?: boolean;
    public reasonCode?: number;
    public reason?: string;
    public candidates?: OwnerCardUpgradeTarget[];

    public constructor(init?: Partial<OwnerCardUpgradeSource>) { (Object as any).assign(this, init); }
}

export class OwnerCardsUpgradeCandidatesResult extends OwnerCardUpgradeResultBase
{
    public enabled?: boolean;
    public cards?: OwnerCardUpgradeSource[];

    public constructor(init?: Partial<OwnerCardsUpgradeCandidatesResult>) { super(init); (Object as any).assign(this, init); }
}

export class OwnerCardsUpgradeCandidatesRequest
{
    public buyerPhone?: string;
    public sourceOwnerCardId?: number;

    public constructor(init?: Partial<OwnerCardsUpgradeCandidatesRequest>) { (Object as any).assign(this, init); }
}

TypeScript OwnerCardsUpgradeCandidatesRequest 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 /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
}