Trendsic Platform Service

<back to all web services

GiftCardSurveyRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/Survey/GiftCard/{UID}
"use strict";
export class SurveyQuestion {
    /** @param {{QuestionId?:number,QuestionType?:string,HTML?:string,DependsOn?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    QuestionId;
    /** @type {string} */
    QuestionType;
    /** @type {string} */
    HTML;
    /** @type {string} */
    DependsOn;
}
export class Survey {
    /** @param {{SurveyId?:number,ContactId?:number,Questions?:SurveyQuestion[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SurveyId;
    /** @type {number} */
    ContactId;
    /** @type {SurveyQuestion[]} */
    Questions = [];
}
export class GiftCardSurvey extends Survey {
    /** @param {{GiftCardId?:number,GiftCards?:string[],SurveyId?:number,ContactId?:number,Questions?:SurveyQuestion[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    GiftCardId;
    /** @type {string[]} */
    GiftCards = [];
}
export class GiftCardSurveyResponse {
    /** @param {{Survey?:GiftCardSurvey,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GiftCardSurvey} */
    Survey;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GiftCardSurveyRequest {
    /** @param {{UID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UID;
}

JavaScript GiftCardSurveyRequest 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 /v1/Survey/GiftCard/{UID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Survey: 
	{
		GiftCardId: 0,
		GiftCards: 
		[
			String
		],
		SurveyId: 0,
		ContactId: 0,
		Questions: 
		[
			{
				QuestionId: 0,
				QuestionType: String,
				HTML: String,
				DependsOn: String
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}