Trendsic Platform Service

<back to all web services

GetOnboardingStatusRequest

Requires Authentication
The following routes are available for this service:
GET/v1/onboarding/status
OnboardingStatus Parameters:
NameParameterData TypeRequiredDescription
TenantNameformstringNo
PropertyTermformstringNo
StepsformList<OnboardingStep>No
TotalStepsformintNo
DoneStepsformintNo
SatisfiedStepsformintNo
RequiredTotalformintNo
RequiredDoneformintNo
PercentCompleteformintNo
IsCompleteformboolNo
DismissedformboolNo
ChaptersformList<OnboardingChapter>No
DriverServicesformList<DispatchModuleView>No
DriverServicesOnformboolNo
ModulesOnformintNo
ModulesSkippedformintNo
ResponseStatusformResponseStatusNo
OnboardingStep Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ChapterformstringNo
TitleformstringNo
WhyformstringNo
HelpHtmlformstringNo
IconformstringNo
CtaLabelformstringNo
CtaRouteformstringNo
RequiredformboolNo
StateformintNo
DoneformboolNo
AutoDetectedformboolNo
CountformintNo
RequiresformList<string>No
DetectsCountformboolNo
LockKeyformstringNo
LockedformOnboardingLockNo
InTrialformboolNo
TrialEndsAtformDateTime?No
OnboardingLock Parameters:
NameParameterData TypeRequiredDescription
ReasonformstringNo
FeatureKeyformstringNo
FeatureNameformstringNo
ModuleKeyformstringNo
ModuleNameformstringNo
ExpiresAtformDateTime?No
RequestedAtformDateTime?No
OnboardingChapter Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ColorformstringNo
TotalformintNo
SatisfiedformintNo
FullformboolNo
ProgressformstringNo
LockReasonformstringNo
DispatchModuleView Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ModeformstringNo
NameformstringNo
WhatformstringNo
AllowedformboolNo
EnabledformboolNo
InPackformboolNo
AddsformList<string>No
GoScreensformstringNo
FleetformboolNo
InFlightformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}