| GET | /v1/onboarding/status |
|---|
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 GetOnboardingStatusRequest
{
}
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; }
}
}
C# GetOnboardingStatusRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/onboarding/status HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}