efun.id.api

<back to all web services

GetReceivedGiftcodeRequest

Requires Authentication
The following routes are available for this service:
GET/api/v1/games/{GameId}/giftcode/received

export class PagingRequest
{
    public page: number;
    public limit: number;
    public offSet: number;

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

export class ReceivedGiftcodeResponse
{
    public eventId: number;
    public eventName: string;
    public eventUrl?: string;
    public description?: string;
    public iconUrl?: string;
    public label?: string;
    public labelColor?: string;
    public eventType: number;
    public code?: string;
    public serverId?: string;
    public characterId?: string;
    public characterName?: string;
    public startDate?: string;
    public dueDate?: string;
    public eventStartDate?: string;
    public eventEndDate?: string;
    public createdDate: string;
    public isUsed: boolean;

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

export class GetReceivedGiftcodeRequest extends PagingRequest
{
    public gameId: number;

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

export class Pagination
{
    public total: number;
    public pages: number;
    public offset: number;
    public limit: number;
    public currentPage: number;

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

export class PageResponse<T> implements IResponseRequest
{
    public code: number;
    public message: string;
    public data: ReceivedGiftcodeResponse[] = [];
    public pagination: Pagination;

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

TypeScript GetReceivedGiftcodeRequest 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.

GET /api/v1/games/{GameId}/giftcode/received HTTP/1.1 
Host: efun-id-api-sandbox.efun.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			eventId: 0,
			eventName: String,
			eventUrl: String,
			description: String,
			iconUrl: String,
			label: String,
			labelColor: String,
			eventType: 0,
			code: String,
			serverId: String,
			characterId: String,
			characterName: String,
			startDate: "0001-01-01T00:00:00.0000000+07:06",
			dueDate: "0001-01-01T00:00:00.0000000+07:06",
			eventStartDate: "0001-01-01T00:00:00.0000000+07:06",
			eventEndDate: "0001-01-01T00:00:00.0000000+07:06",
			isUsed: False
		}
	]
}