| POST | /v1/onboarding/dismiss |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OnboardingStep:
key: Optional[str] = None
chapter: Optional[str] = None
title: Optional[str] = None
why: Optional[str] = None
help_html: Optional[str] = None
icon_html: Optional[str] = None
cta_label: Optional[str] = None
cta_route: Optional[str] = None
required: bool = False
state: int = 0
done: bool = False
auto_detected: bool = False
count: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OnboardingStatus:
tenant_name: Optional[str] = None
property_term: Optional[str] = None
steps: List[OnboardingStep] = field(default_factory=list)
total_steps: int = 0
done_steps: int = 0
required_total: int = 0
required_done: int = 0
percent_complete: int = 0
is_complete: bool = False
dismissed: bool = False
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DismissOnboardingRequest:
dismissed: bool = False
Python 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,
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
}
}
}