| 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 OnboardingLock:
reason: Optional[str] = None
feature_key: Optional[str] = None
feature_name: Optional[str] = None
module_key: Optional[str] = None
module_name: Optional[str] = None
expires_at: Optional[datetime.datetime] = None
requested_at: Optional[datetime.datetime] = None
@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: 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
requires: List[str] = field(default_factory=list)
detects_count: bool = False
lock_key: Optional[str] = None
locked: Optional[OnboardingLock] = None
in_trial: bool = False
trial_ends_at: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OnboardingChapter:
name: Optional[str] = None
color: Optional[str] = None
total: int = 0
satisfied: int = 0
full: bool = False
progress: Optional[str] = None
lock_reason: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchModuleView:
key: Optional[str] = None
mode: Optional[str] = None
name: Optional[str] = None
what: Optional[str] = None
allowed: bool = False
enabled: bool = False
in_pack: bool = False
adds: List[str] = field(default_factory=list)
go_screens: Optional[str] = None
fleet: bool = False
in_flight: 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
satisfied_steps: int = 0
required_total: int = 0
required_done: int = 0
percent_complete: int = 0
is_complete: bool = False
dismissed: bool = False
chapters: List[OnboardingChapter] = field(default_factory=list)
driver_services: List[DispatchModuleView] = field(default_factory=list)
driver_services_on: bool = False
modules_on: int = 0
modules_skipped: int = 0
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<DismissOnboardingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Dismissed>false</Dismissed>
</DismissOnboardingRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<OnboardingStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Chapters>
<OnboardingChapter>
<Color>String</Color>
<Full>false</Full>
<LockReason>String</LockReason>
<Name>String</Name>
<Progress>String</Progress>
<Satisfied>0</Satisfied>
<Total>0</Total>
</OnboardingChapter>
</Chapters>
<Dismissed>false</Dismissed>
<DoneSteps>0</DoneSteps>
<DriverServices>
<DispatchModuleView>
<Adds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Adds>
<Allowed>false</Allowed>
<Enabled>false</Enabled>
<Fleet>false</Fleet>
<GoScreens>String</GoScreens>
<InFlight>0</InFlight>
<InPack>false</InPack>
<Key>String</Key>
<Mode>String</Mode>
<Name>String</Name>
<What>String</What>
</DispatchModuleView>
</DriverServices>
<DriverServicesOn>false</DriverServicesOn>
<IsComplete>false</IsComplete>
<ModulesOn>0</ModulesOn>
<ModulesSkipped>0</ModulesSkipped>
<PercentComplete>0</PercentComplete>
<PropertyTerm>String</PropertyTerm>
<RequiredDone>0</RequiredDone>
<RequiredTotal>0</RequiredTotal>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SatisfiedSteps>0</SatisfiedSteps>
<Steps>
<OnboardingStep>
<AutoDetected>false</AutoDetected>
<Chapter>String</Chapter>
<Count>0</Count>
<CtaLabel>String</CtaLabel>
<CtaRoute>String</CtaRoute>
<DetectsCount>false</DetectsCount>
<Done>false</Done>
<HelpHtml>String</HelpHtml>
<Icon>String</Icon>
<InTrial>false</InTrial>
<Key>String</Key>
<LockKey>String</LockKey>
<Locked>
<ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
<FeatureKey>String</FeatureKey>
<FeatureName>String</FeatureName>
<ModuleKey>String</ModuleKey>
<ModuleName>String</ModuleName>
<Reason>String</Reason>
<RequestedAt>0001-01-01T00:00:00</RequestedAt>
</Locked>
<Required>false</Required>
<Requires xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Requires>
<State>0</State>
<Title>String</Title>
<TrialEndsAt>0001-01-01T00:00:00</TrialEndsAt>
<Why>String</Why>
</OnboardingStep>
</Steps>
<TenantName>String</TenantName>
<TotalSteps>0</TotalSteps>
</OnboardingStatus>