| GET | /v1/onboarding/status |
|---|
"use strict";
export class OnboardingLock {
/** @param {{Reason?:string,FeatureKey?:string,FeatureName?:string,ModuleKey?:string,ModuleName?:string,ExpiresAt?:string,RequestedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Reason;
/** @type {string} */
FeatureKey;
/** @type {string} */
FeatureName;
/** @type {string} */
ModuleKey;
/** @type {string} */
ModuleName;
/** @type {?string} */
ExpiresAt;
/** @type {?string} */
RequestedAt;
}
export class OnboardingStep {
/** @param {{Key?:string,Chapter?:string,Title?:string,Why?:string,HelpHtml?:string,Icon?:string,CtaLabel?:string,CtaRoute?:string,Required?:boolean,State?:number,Done?:boolean,AutoDetected?:boolean,Count?:number,Requires?:string[],DetectsCount?:boolean,LockKey?:string,Locked?:OnboardingLock,InTrial?:boolean,TrialEndsAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Chapter;
/** @type {string} */
Title;
/** @type {string} */
Why;
/** @type {string} */
HelpHtml;
/** @type {string} */
Icon;
/** @type {string} */
CtaLabel;
/** @type {string} */
CtaRoute;
/** @type {boolean} */
Required;
/** @type {number} */
State;
/** @type {boolean} */
Done;
/** @type {boolean} */
AutoDetected;
/** @type {number} */
Count;
/** @type {string[]} */
Requires = [];
/** @type {boolean} */
DetectsCount;
/** @type {string} */
LockKey;
/** @type {OnboardingLock} */
Locked;
/** @type {boolean} */
InTrial;
/** @type {?string} */
TrialEndsAt;
}
export class OnboardingChapter {
/** @param {{Name?:string,Color?:string,Total?:number,Satisfied?:number,Full?:boolean,Progress?:string,LockReason?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Color;
/** @type {number} */
Total;
/** @type {number} */
Satisfied;
/** @type {boolean} */
Full;
/** @type {string} */
Progress;
/** @type {string} */
LockReason;
}
export class DispatchModuleView {
/** @param {{Key?:string,Mode?:string,Name?:string,What?:string,Allowed?:boolean,Enabled?:boolean,InPack?:boolean,Adds?:string[],GoScreens?:string,Fleet?:boolean,InFlight?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Mode;
/** @type {string} */
Name;
/** @type {string} */
What;
/** @type {boolean} */
Allowed;
/** @type {boolean} */
Enabled;
/** @type {boolean} */
InPack;
/** @type {string[]} */
Adds = [];
/** @type {string} */
GoScreens;
/** @type {boolean} */
Fleet;
/** @type {number} */
InFlight;
}
export class OnboardingStatus {
/** @param {{TenantName?:string,PropertyTerm?:string,Steps?:OnboardingStep[],TotalSteps?:number,DoneSteps?:number,SatisfiedSteps?:number,RequiredTotal?:number,RequiredDone?:number,PercentComplete?:number,IsComplete?:boolean,Dismissed?:boolean,Chapters?:OnboardingChapter[],DriverServices?:DispatchModuleView[],DriverServicesOn?:boolean,ModulesOn?:number,ModulesSkipped?:number,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} */
SatisfiedSteps;
/** @type {number} */
RequiredTotal;
/** @type {number} */
RequiredDone;
/** @type {number} */
PercentComplete;
/** @type {boolean} */
IsComplete;
/** @type {boolean} */
Dismissed;
/** @type {OnboardingChapter[]} */
Chapters = [];
/** @type {DispatchModuleView[]} */
DriverServices = [];
/** @type {boolean} */
DriverServicesOn;
/** @type {number} */
ModulesOn;
/** @type {number} */
ModulesSkipped;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetOnboardingStatusRequest {
constructor(init) { Object.assign(this, init) }
}
JavaScript GetOnboardingStatusRequest 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.
GET /v1/onboarding/status HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
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,
Icon: String,
CtaLabel: String,
CtaRoute: String,
Required: False,
State: 0,
Done: False,
AutoDetected: False,
Count: 0,
Requires:
[
String
],
DetectsCount: False,
LockKey: String,
Locked:
{
Reason: String,
FeatureKey: String,
FeatureName: String,
ModuleKey: String,
ModuleName: String,
ExpiresAt: 0001-01-01,
RequestedAt: 0001-01-01
},
InTrial: False,
TrialEndsAt: 0001-01-01
}
],
TotalSteps: 0,
DoneSteps: 0,
SatisfiedSteps: 0,
RequiredTotal: 0,
RequiredDone: 0,
PercentComplete: 0,
IsComplete: False,
Dismissed: False,
Chapters:
[
{
Name: String,
Color: String,
Total: 0,
Satisfied: 0,
Full: False,
Progress: String,
LockReason: String
}
],
DriverServices:
[
{
Key: String,
Mode: String,
Name: String,
What: String,
Allowed: False,
Enabled: False,
InPack: False,
Adds:
[
String
],
GoScreens: String,
Fleet: False,
InFlight: 0
}
],
DriverServicesOn: False,
ModulesOn: 0,
ModulesSkipped: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}