Trendsic Platform Service

DismissOnboardingRequest

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


export class OnboardingLock
{
    public Reason: string;
    public FeatureKey: string;
    public FeatureName: string;
    public ModuleKey: string;
    public ModuleName: string;
    public ExpiresAt?: string;
    public RequestedAt?: string;

    public constructor(init?: Partial<OnboardingLock>) { (Object as any).assign(this, init); }
}

export class OnboardingStep
{
    public Key: string;
    public Chapter: string;
    public Title: string;
    public Why: string;
    public HelpHtml: string;
    public Icon: string;
    public CtaLabel: string;
    public CtaRoute: string;
    public Required: boolean;
    public State: number;
    public Done: boolean;
    public AutoDetected: boolean;
    public Count: number;
    public Requires: string[] = [];
    public DetectsCount: boolean;
    public LockKey: string;
    public Locked: OnboardingLock;
    public InTrial: boolean;
    public TrialEndsAt?: string;

    public constructor(init?: Partial<OnboardingStep>) { (Object as any).assign(this, init); }
}

export class OnboardingChapter
{
    public Name: string;
    public Color: string;
    public Total: number;
    public Satisfied: number;
    public Full: boolean;
    public Progress: string;
    public LockReason: string;

    public constructor(init?: Partial<OnboardingChapter>) { (Object as any).assign(this, init); }
}

export class DispatchModuleView
{
    public Key: string;
    public Mode: string;
    public Name: string;
    public What: string;
    public Allowed: boolean;
    public Enabled: boolean;
    public InPack: boolean;
    public Adds: string[] = [];
    public GoScreens: string;
    public Fleet: boolean;
    public InFlight: number;

    public constructor(init?: Partial<DispatchModuleView>) { (Object as any).assign(this, init); }
}

export class OnboardingStatus
{
    public TenantName: string;
    public PropertyTerm: string;
    public Steps: OnboardingStep[] = [];
    public TotalSteps: number;
    public DoneSteps: number;
    public SatisfiedSteps: number;
    public RequiredTotal: number;
    public RequiredDone: number;
    public PercentComplete: number;
    public IsComplete: boolean;
    public Dismissed: boolean;
    public Chapters: OnboardingChapter[] = [];
    public DriverServices: DispatchModuleView[] = [];
    public DriverServicesOn: boolean;
    public ModulesOn: number;
    public ModulesSkipped: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<OnboardingStatus>) { (Object as any).assign(this, init); }
}

export class DismissOnboardingRequest
{
    public Dismissed: boolean;

    public constructor(init?: Partial<DismissOnboardingRequest>) { (Object as any).assign(this, init); }
}

TypeScript DismissOnboardingRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>