Trendsic Platform Service

<back to all web services

GiftCardRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,DELETE,OPTIONS/v1/GiftCard/{GiftCardId}
GET,POST,PUT,OPTIONS/v1/GiftCard
GET,OPTIONS/v1/GiftCard/ByGameSet/{GiftCardGameSetId}
"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 GiftCardRequest {
    /** @param {{GiftCard?:GiftCard[],GiftCardId?:number,GiftCardGameSetId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GiftCard[]} */
    GiftCard = [];
    /** @type {number} */
    GiftCardId;
    /** @type {number} */
    GiftCardGameSetId;
}

JavaScript GiftCardRequest 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 /v1/GiftCard HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GiftCard: 
	[
		{
			GiftCardId: 0,
			AgentId: 0,
			CardType: String,
			CardNumber: String,
			ContactId: 0,
			DateCreated: 0001-01-01,
			DateModified: 0001-01-01,
			DateDeleted: 0001-01-01,
			GiftCardGameSetId: String,
			FirstApptDate: 0001-01-01,
			IsReferrerCard: False,
			AgentName: String,
			ContactName: String
		}
	],
	GiftCardId: 0,
	GiftCardGameSetId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			DateModified: 0001-01-01,
			DateDeleted: 0001-01-01,
			GiftCardGameSetId: String,
			FirstApptDate: 0001-01-01,
			IsReferrerCard: False,
			AgentName: String,
			ContactName: String
		}
	]
}