Trendsic Platform Service

<back to all web services

GetOnboardingStatusRequest

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetOnboardingStatusRequest
{
}

open class OnboardingStatus
{
    open var TenantName:String? = null
    open var PropertyTerm:String? = null
    open var Steps:ArrayList<OnboardingStep> = ArrayList<OnboardingStep>()
    open var TotalSteps:Int? = null
    open var DoneSteps:Int? = null
    open var SatisfiedSteps:Int? = null
    open var RequiredTotal:Int? = null
    open var RequiredDone:Int? = null
    open var PercentComplete:Int? = null
    open var IsComplete:Boolean? = null
    open var Dismissed:Boolean? = null
    open var Chapters:ArrayList<OnboardingChapter> = ArrayList<OnboardingChapter>()
    open var DriverServices:ArrayList<DispatchModuleView> = ArrayList<DispatchModuleView>()
    open var DriverServicesOn:Boolean? = null
    open var ModulesOn:Int? = null
    open var ModulesSkipped:Int? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class OnboardingStep
{
    open var Key:String? = null
    open var Chapter:String? = null
    open var Title:String? = null
    open var Why:String? = null
    open var HelpHtml:String? = null
    open var Icon:String? = null
    open var CtaLabel:String? = null
    open var CtaRoute:String? = null
    open var Required:Boolean? = null
    open var State:Int? = null
    open var Done:Boolean? = null
    open var AutoDetected:Boolean? = null
    open var Count:Int? = null
    open var Requires:ArrayList<String> = ArrayList<String>()
    open var DetectsCount:Boolean? = null
    open var LockKey:String? = null
    open var Locked:OnboardingLock? = null
    open var InTrial:Boolean? = null
    open var TrialEndsAt:Date? = null
}

open class OnboardingLock
{
    open var Reason:String? = null
    open var FeatureKey:String? = null
    open var FeatureName:String? = null
    open var ModuleKey:String? = null
    open var ModuleName:String? = null
    open var ExpiresAt:Date? = null
    open var RequestedAt:Date? = null
}

open class OnboardingChapter
{
    open var Name:String? = null
    open var Color:String? = null
    open var Total:Int? = null
    open var Satisfied:Int? = null
    open var Full:Boolean? = null
    open var Progress:String? = null
    open var LockReason:String? = null
}

open class DispatchModuleView
{
    open var Key:String? = null
    open var Mode:String? = null
    open var Name:String? = null
    open var What:String? = null
    open var Allowed:Boolean? = null
    open var Enabled:Boolean? = null
    open var InPack:Boolean? = null
    open var Adds:ArrayList<String> = ArrayList<String>()
    open var GoScreens:String? = null
    open var Fleet:Boolean? = null
    open var InFlight:Int? = null
}

Kotlin GetOnboardingStatusRequest DTOs

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