Trendsic Platform Service

GetOnboardingStatusRequest

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

**OnboardingStatus** Parameters:
Name	Parameter	Data Type	Required
TenantName	form	string	No
PropertyTerm	form	string	No
Steps	form	List<OnboardingStep>	No
TotalSteps	form	int	No
DoneSteps	form	int	No
SatisfiedSteps	form	int	No
RequiredTotal	form	int	No
RequiredDone	form	int	No
PercentComplete	form	int	No
IsComplete	form	bool	No
Dismissed	form	bool	No
Chapters	form	List<OnboardingChapter>	No
DriverServices	form	List<DispatchModuleView>	No
DriverServicesOn	form	bool	No
ModulesOn	form	int	No
ModulesSkipped	form	int	No
ResponseStatus	form	ResponseStatus	No

**OnboardingStep** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Chapter	form	string	No
Title	form	string	No
Why	form	string	No
HelpHtml	form	string	No
Icon	form	string	No
CtaLabel	form	string	No
CtaRoute	form	string	No
Required	form	bool	No
State	form	int	No
Done	form	bool	No
AutoDetected	form	bool	No
Count	form	int	No
Requires	form	List<string>	No
DetectsCount	form	bool	No
LockKey	form	string	No
Locked	form	OnboardingLock	No
InTrial	form	bool	No
TrialEndsAt	form	DateTime?	No

**OnboardingLock** Parameters:
Name	Parameter	Data Type	Required
Reason	form	string	No
FeatureKey	form	string	No
FeatureName	form	string	No
ModuleKey	form	string	No
ModuleName	form	string	No
ExpiresAt	form	DateTime?	No
RequestedAt	form	DateTime?	No

**OnboardingChapter** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Color	form	string	No
Total	form	int	No
Satisfied	form	int	No
Full	form	bool	No
Progress	form	string	No
LockReason	form	string	No

**DispatchModuleView** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Mode	form	string	No
Name	form	string	No
What	form	string	No
Allowed	form	bool	No
Enabled	form	bool	No
InPack	form	bool	No
Adds	form	List<string>	No
GoScreens	form	string	No
Fleet	form	bool	No
InFlight	form	int	No

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