TicketUserServices

<back to all web services

GiftCardIssueRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequired permission:Tickets.Add
The following routes are available for this service:
POST/GiftCard/Issue

export class GiftCardIssueResult
{
    public success?: boolean;
    public giftCardId?: number;
    public code?: string;
    public codeLast4?: string;
    public status?: string;
    public expiresAt?: string;
    public paymentId?: string;
    public statusCode?: number;
    public message?: string;

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

export class GiftCardIssueRequest
{
    public giftCardTypeId?: number;
    public amountMinor?: number;
    public code?: string;
    public activate?: boolean;
    public buyerName?: string;
    public buyerEmail?: string;
    public buyerPhone?: string;
    public recipientName?: string;
    public idempotencyKey?: string;
    public note?: string;

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

TypeScript GiftCardIssueRequest 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 /GiftCard/Issue HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	giftCardTypeId: 0,
	amountMinor: 0,
	code: String,
	activate: False,
	buyerName: String,
	buyerEmail: String,
	buyerPhone: String,
	recipientName: String,
	idempotencyKey: String,
	note: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	success: False,
	giftCardId: 0,
	code: String,
	codeLast4: String,
	status: String,
	expiresAt: 0001-01-01,
	paymentId: String,
	statusCode: 0,
	message: String
}