Trendsic Platform Service

GetOnboardingStatusRequest

The following routes are available for this service:
GET	/v1/onboarding/status


export class OnboardingLock
{
    public Reason: string;
    public FeatureKey: string;
    public FeatureName: string;
    public ModuleKey: string;
    public ModuleName: string;
    public ExpiresAt?: string;
    public RequestedAt?: string;

    public constructor(init?: Partial<OnboardingLock>) { (Object as any).assign(this, init); }
}

export class OnboardingStep
{
    public Key: string;
    public Chapter: string;
    public Title: string;
    public Why: string;
    public HelpHtml: string;
    public Icon: string;
    public CtaLabel: string;
    public CtaRoute: string;
    public Required: boolean;
    public State: number;
    public Done: boolean;
    public AutoDetected: boolean;
    public Count: number;
    public Requires: string[] = [];
    public DetectsCount: boolean;
    public LockKey: string;
    public Locked: OnboardingLock;
    public InTrial: boolean;
    public TrialEndsAt?: string;

    public constructor(init?: Partial<OnboardingStep>) { (Object as any).assign(this, init); }
}

export class OnboardingChapter
{
    public Name: string;
    public Color: string;
    public Total: number;
    public Satisfied: number;
    public Full: boolean;
    public Progress: string;
    public LockReason: string;

    public constructor(init?: Partial<OnboardingChapter>) { (Object as any).assign(this, init); }
}

export class DispatchModuleView
{
    public Key: string;
    public Mode: string;
    public Name: string;
    public What: string;
    public Allowed: boolean;
    public Enabled: boolean;
    public InPack: boolean;
    public Adds: string[] = [];
    public GoScreens: string;
    public Fleet: boolean;
    public InFlight: number;

    public constructor(init?: Partial<DispatchModuleView>) { (Object as any).assign(this, init); }
}

export class OnboardingStatus
{
    public TenantName: string;
    public PropertyTerm: string;
    public Steps: OnboardingStep[] = [];
    public TotalSteps: number;
    public DoneSteps: number;
    public SatisfiedSteps: number;
    public RequiredTotal: number;
    public RequiredDone: number;
    public PercentComplete: number;
    public IsComplete: boolean;
    public Dismissed: boolean;
    public Chapters: OnboardingChapter[] = [];
    public DriverServices: DispatchModuleView[] = [];
    public DriverServicesOn: boolean;
    public ModulesOn: number;
    public ModulesSkipped: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<OnboardingStatus>) { (Object as any).assign(this, init); }
}

export class GetOnboardingStatusRequest
{

    public constructor(init?: Partial<GetOnboardingStatusRequest>) { (Object as any).assign(this, init); }
}

TypeScript GetOnboardingStatusRequest 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/onboarding/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","RequestedAt":"0001-01-01T00:00:00.0000000"},"InTrial":false,"TrialEndsAt":"0001-01-01T00:00:00.0000000"}],"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"}}}