Trendsic Platform Service

<back to all web services

DismissOnboardingRequest

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DismissOnboardingRequest
    {
        public virtual bool Dismissed { get; set; }
    }

    public partial class DispatchModuleView
    {
        public virtual string Key { get; set; }
        public virtual string Mode { get; set; }
        public virtual string Name { get; set; }
        public virtual string What { get; set; }
        public virtual bool Allowed { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual bool InPack { get; set; }
        public virtual List<string> Adds { get; set; } = [];
        public virtual string GoScreens { get; set; }
        public virtual bool Fleet { get; set; }
        public virtual int InFlight { get; set; }
    }

    public partial class OnboardingChapter
    {
        public virtual string Name { get; set; }
        public virtual string Color { get; set; }
        public virtual int Total { get; set; }
        public virtual int Satisfied { get; set; }
        public virtual bool Full { get; set; }
        public virtual string Progress { get; set; }
        public virtual string LockReason { get; set; }
    }

    public partial class OnboardingLock
    {
        public virtual string Reason { get; set; }
        public virtual string FeatureKey { get; set; }
        public virtual string FeatureName { get; set; }
        public virtual string ModuleKey { get; set; }
        public virtual string ModuleName { get; set; }
        public virtual DateTime? ExpiresAt { get; set; }
        public virtual DateTime? RequestedAt { get; set; }
    }

    public partial class OnboardingStatus
    {
        public virtual string TenantName { get; set; }
        public virtual string PropertyTerm { get; set; }
        public virtual List<OnboardingStep> Steps { get; set; } = [];
        public virtual int TotalSteps { get; set; }
        public virtual int DoneSteps { get; set; }
        public virtual int SatisfiedSteps { get; set; }
        public virtual int RequiredTotal { get; set; }
        public virtual int RequiredDone { get; set; }
        public virtual int PercentComplete { get; set; }
        public virtual bool IsComplete { get; set; }
        public virtual bool Dismissed { get; set; }
        public virtual List<OnboardingChapter> Chapters { get; set; } = [];
        public virtual List<DispatchModuleView> DriverServices { get; set; } = [];
        public virtual bool DriverServicesOn { get; set; }
        public virtual int ModulesOn { get; set; }
        public virtual int ModulesSkipped { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class OnboardingStep
    {
        public virtual string Key { get; set; }
        public virtual string Chapter { get; set; }
        public virtual string Title { get; set; }
        public virtual string Why { get; set; }
        public virtual string HelpHtml { get; set; }
        public virtual string Icon { get; set; }
        public virtual string CtaLabel { get; set; }
        public virtual string CtaRoute { get; set; }
        public virtual bool Required { get; set; }
        public virtual int State { get; set; }
        public virtual bool Done { get; set; }
        public virtual bool AutoDetected { get; set; }
        public virtual int Count { get; set; }
        public virtual List<string> Requires { get; set; } = [];
        public virtual bool DetectsCount { get; set; }
        public virtual string LockKey { get; set; }
        public virtual OnboardingLock Locked { get; set; }
        public virtual bool InTrial { get; set; }
        public virtual DateTime? TrialEndsAt { get; set; }
    }

}

C# DismissOnboardingRequest DTOs

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>