Trendsic Platform Service

<back to all web services

DismissOnboardingRequest

Requires Authentication
The following routes are available for this service:
POST/v1/onboarding/dismiss
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

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Dismissed":false}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","RequestedAt":"0001-01-01T00:00:00.0000000"},"InTrial":false,"TrialEndsAt":"0001-01-01T00:00:00.0000000"}],"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"}}}