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
"use strict";
export class PagingRequest {
    /** @param {{page?:number,limit?:number,offSet?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    page;
    /** @type {number} */
    limit;
    /** @type {number} */
    offSet;
}
export class ReceivedGiftcodeResponse {
    /** @param {{eventId?:number,eventName?:string,eventUrl?:string,description?:string,iconUrl?:string,label?:string,labelColor?:string,eventType?:number,code?:string,serverId?:string,characterId?:string,characterName?:string,startDate?:string,dueDate?:string,eventStartDate?:string,eventEndDate?:string,createdDate?:string,isUsed?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    eventId;
    /** @type {string} */
    eventName;
    /** @type {?string} */
    eventUrl;
    /** @type {?string} */
    description;
    /** @type {?string} */
    iconUrl;
    /** @type {?string} */
    label;
    /** @type {?string} */
    labelColor;
    /** @type {number} */
    eventType;
    /** @type {?string} */
    code;
    /** @type {?string} */
    serverId;
    /** @type {?string} */
    characterId;
    /** @type {?string} */
    characterName;
    /** @type {?string} */
    startDate;
    /** @type {?string} */
    dueDate;
    /** @type {?string} */
    eventStartDate;
    /** @type {?string} */
    eventEndDate;
    /** @type {string} */
    createdDate;
    /** @type {boolean} */
    isUsed;
}
export class GetReceivedGiftcodeRequest extends PagingRequest {
    /** @param {{gameId?:number,page?:number,limit?:number,offSet?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    gameId;
}
export class Pagination {
    /** @param {{total?:number,pages?:number,offset?:number,limit?:number,currentPage?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    total;
    /** @type {number} */
    pages;
    /** @type {number} */
    offset;
    /** @type {number} */
    limit;
    /** @type {number} */
    currentPage;
}
/** @typedef T {any} */
export class PageResponse {
    /** @param {{code?:number,message?:string,data?:ReceivedGiftcodeResponse[],pagination?:Pagination}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    code;
    /** @type {string} */
    message;
    /** @type {ReceivedGiftcodeResponse[]} */
    data = [];
    /** @type {Pagination} */
    pagination;
}

JavaScript GetReceivedGiftcodeRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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","createdDate":"0001-01-01T00:00:00.0000000+07:06","isUsed":false}],"pagination":null}