| 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 SatisfiedSteps = null;
public Integer RequiredTotal = null;
public Integer RequiredDone = null;
public Integer PercentComplete = null;
public Boolean IsComplete = null;
public Boolean Dismissed = null;
public ArrayList<OnboardingChapter> Chapters = new ArrayList<OnboardingChapter>();
public ArrayList<DispatchModuleView> DriverServices = new ArrayList<DispatchModuleView>();
public Boolean DriverServicesOn = null;
public Integer ModulesOn = null;
public Integer ModulesSkipped = 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 getSatisfiedSteps() { return SatisfiedSteps; }
public OnboardingStatus setSatisfiedSteps(Integer value) { this.SatisfiedSteps = 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 ArrayList<OnboardingChapter> getChapters() { return Chapters; }
public OnboardingStatus setChapters(ArrayList<OnboardingChapter> value) { this.Chapters = value; return this; }
public ArrayList<DispatchModuleView> getDriverServices() { return DriverServices; }
public OnboardingStatus setDriverServices(ArrayList<DispatchModuleView> value) { this.DriverServices = value; return this; }
public Boolean isDriverServicesOn() { return DriverServicesOn; }
public OnboardingStatus setDriverServicesOn(Boolean value) { this.DriverServicesOn = value; return this; }
public Integer getModulesOn() { return ModulesOn; }
public OnboardingStatus setModulesOn(Integer value) { this.ModulesOn = value; return this; }
public Integer getModulesSkipped() { return ModulesSkipped; }
public OnboardingStatus setModulesSkipped(Integer value) { this.ModulesSkipped = 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 Icon = 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 ArrayList<String> Requires = new ArrayList<String>();
public Boolean DetectsCount = null;
public String LockKey = null;
public OnboardingLock Locked = null;
public Boolean InTrial = null;
public Date TrialEndsAt = 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 getIcon() { return Icon; }
public OnboardingStep setIcon(String value) { this.Icon = 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; }
public ArrayList<String> getRequires() { return Requires; }
public OnboardingStep setRequires(ArrayList<String> value) { this.Requires = value; return this; }
public Boolean isDetectsCount() { return DetectsCount; }
public OnboardingStep setDetectsCount(Boolean value) { this.DetectsCount = value; return this; }
public String getLockKey() { return LockKey; }
public OnboardingStep setLockKey(String value) { this.LockKey = value; return this; }
public OnboardingLock getLocked() { return Locked; }
public OnboardingStep setLocked(OnboardingLock value) { this.Locked = value; return this; }
public Boolean isInTrial() { return InTrial; }
public OnboardingStep setInTrial(Boolean value) { this.InTrial = value; return this; }
public Date getTrialEndsAt() { return TrialEndsAt; }
public OnboardingStep setTrialEndsAt(Date value) { this.TrialEndsAt = value; return this; }
}
public static class OnboardingLock
{
public String Reason = null;
public String FeatureKey = null;
public String FeatureName = null;
public String ModuleKey = null;
public String ModuleName = null;
public Date ExpiresAt = null;
public Date RequestedAt = null;
public String getReason() { return Reason; }
public OnboardingLock setReason(String value) { this.Reason = value; return this; }
public String getFeatureKey() { return FeatureKey; }
public OnboardingLock setFeatureKey(String value) { this.FeatureKey = value; return this; }
public String getFeatureName() { return FeatureName; }
public OnboardingLock setFeatureName(String value) { this.FeatureName = value; return this; }
public String getModuleKey() { return ModuleKey; }
public OnboardingLock setModuleKey(String value) { this.ModuleKey = value; return this; }
public String getModuleName() { return ModuleName; }
public OnboardingLock setModuleName(String value) { this.ModuleName = value; return this; }
public Date getExpiresAt() { return ExpiresAt; }
public OnboardingLock setExpiresAt(Date value) { this.ExpiresAt = value; return this; }
public Date getRequestedAt() { return RequestedAt; }
public OnboardingLock setRequestedAt(Date value) { this.RequestedAt = value; return this; }
}
public static class OnboardingChapter
{
public String Name = null;
public String Color = null;
public Integer Total = null;
public Integer Satisfied = null;
public Boolean Full = null;
public String Progress = null;
public String LockReason = null;
public String getName() { return Name; }
public OnboardingChapter setName(String value) { this.Name = value; return this; }
public String getColor() { return Color; }
public OnboardingChapter setColor(String value) { this.Color = value; return this; }
public Integer getTotal() { return Total; }
public OnboardingChapter setTotal(Integer value) { this.Total = value; return this; }
public Integer getSatisfied() { return Satisfied; }
public OnboardingChapter setSatisfied(Integer value) { this.Satisfied = value; return this; }
public Boolean isFull() { return Full; }
public OnboardingChapter setFull(Boolean value) { this.Full = value; return this; }
public String getProgress() { return Progress; }
public OnboardingChapter setProgress(String value) { this.Progress = value; return this; }
public String getLockReason() { return LockReason; }
public OnboardingChapter setLockReason(String value) { this.LockReason = value; return this; }
}
public static class DispatchModuleView
{
public String Key = null;
public String Mode = null;
public String Name = null;
public String What = null;
public Boolean Allowed = null;
public Boolean Enabled = null;
public Boolean InPack = null;
public ArrayList<String> Adds = new ArrayList<String>();
public String GoScreens = null;
public Boolean Fleet = null;
public Integer InFlight = null;
public String getKey() { return Key; }
public DispatchModuleView setKey(String value) { this.Key = value; return this; }
public String getMode() { return Mode; }
public DispatchModuleView setMode(String value) { this.Mode = value; return this; }
public String getName() { return Name; }
public DispatchModuleView setName(String value) { this.Name = value; return this; }
public String getWhat() { return What; }
public DispatchModuleView setWhat(String value) { this.What = value; return this; }
public Boolean isAllowed() { return Allowed; }
public DispatchModuleView setAllowed(Boolean value) { this.Allowed = value; return this; }
public Boolean isEnabled() { return Enabled; }
public DispatchModuleView setEnabled(Boolean value) { this.Enabled = value; return this; }
public Boolean isInPack() { return InPack; }
public DispatchModuleView setInPack(Boolean value) { this.InPack = value; return this; }
public ArrayList<String> getAdds() { return Adds; }
public DispatchModuleView setAdds(ArrayList<String> value) { this.Adds = value; return this; }
public String getGoScreens() { return GoScreens; }
public DispatchModuleView setGoScreens(String value) { this.GoScreens = value; return this; }
public Boolean isFleet() { return Fleet; }
public DispatchModuleView setFleet(Boolean value) { this.Fleet = value; return this; }
public Integer getInFlight() { return InFlight; }
public DispatchModuleView setInFlight(Integer value) { this.InFlight = 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
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,
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
}
}
}