| POST | /v1/onboarding/dismiss |
|---|
"use strict";
export class OnboardingStep {
/** @param {{Key?:string,Chapter?:string,Title?:string,Why?:string,HelpHtml?:string,IconHtml?:string,CtaLabel?:string,CtaRoute?:string,Required?:boolean,State?:number,Done?:boolean,AutoDetected?:boolean,Count?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Chapter;
/** @type {string} */
Title;
/** @type {string} */
Why;
/** @type {string} */
HelpHtml;
/** @type {string} */
IconHtml;
/** @type {string} */
CtaLabel;
/** @type {string} */
CtaRoute;
/** @type {boolean} */
Required;
/** @type {number} */
State;
/** @type {boolean} */
Done;
/** @type {boolean} */
AutoDetected;
/** @type {number} */
Count;
}
export class OnboardingStatus {
/** @param {{TenantName?:string,PropertyTerm?:string,Steps?:OnboardingStep[],TotalSteps?:number,DoneSteps?:number,RequiredTotal?:number,RequiredDone?:number,PercentComplete?:number,IsComplete?:boolean,Dismissed?:boolean,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
TenantName;
/** @type {string} */
PropertyTerm;
/** @type {OnboardingStep[]} */
Steps = [];
/** @type {number} */
TotalSteps;
/** @type {number} */
DoneSteps;
/** @type {number} */
RequiredTotal;
/** @type {number} */
RequiredDone;
/** @type {number} */
PercentComplete;
/** @type {boolean} */
IsComplete;
/** @type {boolean} */
Dismissed;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class DismissOnboardingRequest {
/** @param {{Dismissed?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Dismissed;
}
JavaScript DismissOnboardingRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/onboarding/dismiss HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Dismissed: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
TenantName: String,
PropertyTerm: String,
Steps:
[
{
Key: String,
Chapter: String,
Title: String,
Why: String,
HelpHtml: String,
IconHtml: String,
CtaLabel: String,
CtaRoute: String,
Required: False,
State: 0,
Done: False,
AutoDetected: False,
Count: 0
}
],
TotalSteps: 0,
DoneSteps: 0,
RequiredTotal: 0,
RequiredDone: 0,
PercentComplete: 0,
IsComplete: False,
Dismissed: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}