Trendsic Platform Service

<back to all web services

AvailableGiftCardRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AvailableGiftCard/{AgentId}
"use strict";
export class GiftCard {
    /** @param {{GiftCardId?:number,AgentId?:number,CardType?:string,CardNumber?:string,ContactId?:number,DateCreated?:string,DateModified?:string,DateDeleted?:string,GiftCardGameSetId?:string,FirstApptDate?:string,IsReferrerCard?:boolean,AgentName?:string,ContactName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    GiftCardId;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    CardType;
    /** @type {string} */
    CardNumber;
    /** @type {number} */
    ContactId;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    DateModified;
    /** @type {string} */
    DateDeleted;
    /** @type {string} */
    GiftCardGameSetId;
    /** @type {string} */
    FirstApptDate;
    /** @type {boolean} */
    IsReferrerCard;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    ContactName;
}
export class GiftCardResponse {
    /** @param {{ResponseStatus?:ResponseStatus,GiftCard?:GiftCard[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {GiftCard[]} */
    GiftCard = [];
}
export class AvailableGiftCardRequest {
    /** @param {{AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
}

JavaScript AvailableGiftCardRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/AvailableGiftCard/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"GiftCard":[{"GiftCardId":0,"AgentId":0,"CardType":"String","CardNumber":"String","ContactId":0,"DateCreated":"0001-01-01T00:00:00.0000000","DateModified":"0001-01-01T00:00:00.0000000","DateDeleted":"0001-01-01T00:00:00.0000000","GiftCardGameSetId":"String","FirstApptDate":"0001-01-01T00:00:00.0000000","IsReferrerCard":false,"AgentName":"String","ContactName":"String"}]}