| 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 .xml suffix or ?format=xml
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: application/xml
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">
<Dismissed>false</Dismissed>
<DoneSteps>0</DoneSteps>
<IsComplete>false</IsComplete>
<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>
<Steps>
<OnboardingStep>
<AutoDetected>false</AutoDetected>
<Chapter>String</Chapter>
<Count>0</Count>
<CtaLabel>String</CtaLabel>
<CtaRoute>String</CtaRoute>
<Done>false</Done>
<HelpHtml>String</HelpHtml>
<IconHtml>String</IconHtml>
<Key>String</Key>
<Required>false</Required>
<State>0</State>
<Title>String</Title>
<Why>String</Why>
</OnboardingStep>
</Steps>
<TenantName>String</TenantName>
<TotalSteps>0</TotalSteps>
</OnboardingStatus>