Trendsic Platform Service

<back to all web services

DismissOnboardingRequest

Requires Authentication
The following routes are available for this service:
POST/v1/onboarding/dismiss
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class DismissOnboardingRequest
    {
        public Boolean Dismissed = null;
        
        public Boolean isDismissed() { return Dismissed; }
        public DismissOnboardingRequest setDismissed(Boolean value) { this.Dismissed = value; return this; }
    }

    public static class OnboardingStatus
    {
        public String TenantName = null;
        public String PropertyTerm = null;
        public ArrayList<OnboardingStep> Steps = new ArrayList<OnboardingStep>();
        public Integer TotalSteps = null;
        public Integer DoneSteps = null;
        public Integer RequiredTotal = null;
        public Integer RequiredDone = null;
        public Integer PercentComplete = null;
        public Boolean IsComplete = null;
        public Boolean Dismissed = null;
        public ResponseStatus ResponseStatus = null;
        
        public String getTenantName() { return TenantName; }
        public OnboardingStatus setTenantName(String value) { this.TenantName = value; return this; }
        public String getPropertyTerm() { return PropertyTerm; }
        public OnboardingStatus setPropertyTerm(String value) { this.PropertyTerm = value; return this; }
        public ArrayList<OnboardingStep> getSteps() { return Steps; }
        public OnboardingStatus setSteps(ArrayList<OnboardingStep> value) { this.Steps = value; return this; }
        public Integer getTotalSteps() { return TotalSteps; }
        public OnboardingStatus setTotalSteps(Integer value) { this.TotalSteps = value; return this; }
        public Integer getDoneSteps() { return DoneSteps; }
        public OnboardingStatus setDoneSteps(Integer value) { this.DoneSteps = value; return this; }
        public Integer getRequiredTotal() { return RequiredTotal; }
        public OnboardingStatus setRequiredTotal(Integer value) { this.RequiredTotal = value; return this; }
        public Integer getRequiredDone() { return RequiredDone; }
        public OnboardingStatus setRequiredDone(Integer value) { this.RequiredDone = value; return this; }
        public Integer getPercentComplete() { return PercentComplete; }
        public OnboardingStatus setPercentComplete(Integer value) { this.PercentComplete = value; return this; }
        public Boolean getIsComplete() { return IsComplete; }
        public OnboardingStatus setIsComplete(Boolean value) { this.IsComplete = value; return this; }
        public Boolean isDismissed() { return Dismissed; }
        public OnboardingStatus setDismissed(Boolean value) { this.Dismissed = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public OnboardingStatus setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class OnboardingStep
    {
        public String Key = null;
        public String Chapter = null;
        public String Title = null;
        public String Why = null;
        public String HelpHtml = null;
        public String IconHtml = null;
        public String CtaLabel = null;
        public String CtaRoute = null;
        public Boolean Required = null;
        public Integer State = null;
        public Boolean Done = null;
        public Boolean AutoDetected = null;
        public Integer Count = null;
        
        public String getKey() { return Key; }
        public OnboardingStep setKey(String value) { this.Key = value; return this; }
        public String getChapter() { return Chapter; }
        public OnboardingStep setChapter(String value) { this.Chapter = value; return this; }
        public String getTitle() { return Title; }
        public OnboardingStep setTitle(String value) { this.Title = value; return this; }
        public String getWhy() { return Why; }
        public OnboardingStep setWhy(String value) { this.Why = value; return this; }
        public String getHelpHtml() { return HelpHtml; }
        public OnboardingStep setHelpHtml(String value) { this.HelpHtml = value; return this; }
        public String getIconHtml() { return IconHtml; }
        public OnboardingStep setIconHtml(String value) { this.IconHtml = value; return this; }
        public String getCtaLabel() { return CtaLabel; }
        public OnboardingStep setCtaLabel(String value) { this.CtaLabel = value; return this; }
        public String getCtaRoute() { return CtaRoute; }
        public OnboardingStep setCtaRoute(String value) { this.CtaRoute = value; return this; }
        public Boolean isRequired() { return Required; }
        public OnboardingStep setRequired(Boolean value) { this.Required = value; return this; }
        public Integer getState() { return State; }
        public OnboardingStep setState(Integer value) { this.State = value; return this; }
        public Boolean isDone() { return Done; }
        public OnboardingStep setDone(Boolean value) { this.Done = value; return this; }
        public Boolean isAutoDetected() { return AutoDetected; }
        public OnboardingStep setAutoDetected(Boolean value) { this.AutoDetected = value; return this; }
        public Integer getCount() { return Count; }
        public OnboardingStep setCount(Integer value) { this.Count = value; return this; }
    }

}

Java DismissOnboardingRequest 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/dismiss HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Dismissed: False
}
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
		}
	}
}