Trendsic Platform Service

SetOnboardingStepRequest

The following routes are available for this service:
POST	/v1/onboarding/step

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


open class SetOnboardingStepRequest
{
    open var StepKey:String? = null
    open var State:Int? = null
}

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

Kotlin SetOnboardingStepRequest DTOs

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.

POST /v1/onboarding/step HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	StepKey: String,
	State: 0
}

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,
			IconHtml: String,
			CtaLabel: String,
			CtaRoute: String,
			Required: False,
			State: 0,
			Done: False,
			AutoDetected: False,
			Count: 0
		}
	],
	TotalSteps: 0,
	DoneSteps: 0,
	RequiredTotal: 0,
	RequiredDone: 0,
	PercentComplete: 0,
	IsComplete: False,
	Dismissed: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}