Trendsic Platform Service

<back to all web services

DismissOnboardingRequest

import 'package:servicestack/servicestack.dart';

class OnboardingStep implements IConvertible
{
    String? Key;
    String? Chapter;
    String? Title;
    String? Why;
    String? HelpHtml;
    String? IconHtml;
    String? CtaLabel;
    String? CtaRoute;
    bool? Required;
    int? State;
    bool? Done;
    bool? AutoDetected;
    int? Count;

    OnboardingStep({this.Key,this.Chapter,this.Title,this.Why,this.HelpHtml,this.IconHtml,this.CtaLabel,this.CtaRoute,this.Required,this.State,this.Done,this.AutoDetected,this.Count});
    OnboardingStep.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        Chapter = json['Chapter'];
        Title = json['Title'];
        Why = json['Why'];
        HelpHtml = json['HelpHtml'];
        IconHtml = json['IconHtml'];
        CtaLabel = json['CtaLabel'];
        CtaRoute = json['CtaRoute'];
        Required = json['Required'];
        State = json['State'];
        Done = json['Done'];
        AutoDetected = json['AutoDetected'];
        Count = json['Count'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'Chapter': Chapter,
        'Title': Title,
        'Why': Why,
        'HelpHtml': HelpHtml,
        'IconHtml': IconHtml,
        'CtaLabel': CtaLabel,
        'CtaRoute': CtaRoute,
        'Required': Required,
        'State': State,
        'Done': Done,
        'AutoDetected': AutoDetected,
        'Count': Count
    };

    getTypeName() => "OnboardingStep";
    TypeContext? context = _ctx;
}

class OnboardingStatus implements IConvertible
{
    String? TenantName;
    String? PropertyTerm;
    List<OnboardingStep>? Steps = [];
    int? TotalSteps;
    int? DoneSteps;
    int? RequiredTotal;
    int? RequiredDone;
    int? PercentComplete;
    bool? IsComplete;
    bool? Dismissed;
    ResponseStatus? ResponseStatus;

    OnboardingStatus({this.TenantName,this.PropertyTerm,this.Steps,this.TotalSteps,this.DoneSteps,this.RequiredTotal,this.RequiredDone,this.PercentComplete,this.IsComplete,this.Dismissed,this.ResponseStatus});
    OnboardingStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TenantName = json['TenantName'];
        PropertyTerm = json['PropertyTerm'];
        Steps = JsonConverters.fromJson(json['Steps'],'List<OnboardingStep>',context!);
        TotalSteps = json['TotalSteps'];
        DoneSteps = json['DoneSteps'];
        RequiredTotal = json['RequiredTotal'];
        RequiredDone = json['RequiredDone'];
        PercentComplete = json['PercentComplete'];
        IsComplete = json['IsComplete'];
        Dismissed = json['Dismissed'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TenantName': TenantName,
        'PropertyTerm': PropertyTerm,
        'Steps': JsonConverters.toJson(Steps,'List<OnboardingStep>',context!),
        'TotalSteps': TotalSteps,
        'DoneSteps': DoneSteps,
        'RequiredTotal': RequiredTotal,
        'RequiredDone': RequiredDone,
        'PercentComplete': PercentComplete,
        'IsComplete': IsComplete,
        'Dismissed': Dismissed,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "OnboardingStatus";
    TypeContext? context = _ctx;
}

class DismissOnboardingRequest implements IConvertible
{
    bool? Dismissed;

    DismissOnboardingRequest({this.Dismissed});
    DismissOnboardingRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Dismissed = json['Dismissed'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Dismissed': Dismissed
    };

    getTypeName() => "DismissOnboardingRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'OnboardingStep': TypeInfo(TypeOf.Class, create:() => OnboardingStep()),
    'OnboardingStatus': TypeInfo(TypeOf.Class, create:() => OnboardingStatus()),
    'List<OnboardingStep>': TypeInfo(TypeOf.Class, create:() => <OnboardingStep>[]),
    'DismissOnboardingRequest': TypeInfo(TypeOf.Class, create:() => DismissOnboardingRequest()),
});

Dart DismissOnboardingRequest DTOs

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

{
	Dismissed: False
}

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
		}
	}
}