| GET | /v1/onboarding/status |
|---|
export class OnboardingStep
{
public Key: string;
public Chapter: string;
public Title: string;
public Why: string;
public HelpHtml: string;
public IconHtml: string;
public CtaLabel: string;
public CtaRoute: string;
public Required: boolean;
public State: number;
public Done: boolean;
public AutoDetected: boolean;
public Count: number;
public constructor(init?: Partial<OnboardingStep>) { (Object as any).assign(this, init); }
}
export class OnboardingStatus
{
public TenantName: string;
public PropertyTerm: string;
public Steps: OnboardingStep[] = [];
public TotalSteps: number;
public DoneSteps: number;
public RequiredTotal: number;
public RequiredDone: number;
public PercentComplete: number;
public IsComplete: boolean;
public Dismissed: boolean;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<OnboardingStatus>) { (Object as any).assign(this, init); }
}
export class GetOnboardingStatusRequest
{
public constructor(init?: Partial<GetOnboardingStatusRequest>) { (Object as any).assign(this, init); }
}
TypeScript GetOnboardingStatusRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
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"}}}