Trendsic Platform Service

<back to all web services

SetOnboardingStepRequest

Requires Authentication
The following routes are available for this service:
POST/v1/onboarding/step
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 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 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 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 IconHtml { 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 partial class SetOnboardingStepRequest
    {
        public virtual string StepKey { get; set; }
        public virtual int State { get; set; }
    }

}

C# SetOnboardingStepRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/onboarding/step HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"StepKey":"String","State":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}