Trendsic Platform Service

<back to all web services

SetOnboardingStepRequest

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 SetOnboardingStepRequest implements IConvertible
{
    String? StepKey;
    int? State;

    SetOnboardingStepRequest({this.StepKey,this.State});
    SetOnboardingStepRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

    getTypeName() => "SetOnboardingStepRequest";
    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>[]),
    'SetOnboardingStepRequest': TypeInfo(TypeOf.Class, create:() => SetOnboardingStepRequest()),
});

Dart SetOnboardingStepRequest DTOs

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

<SetOnboardingStepRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <State>0</State>
  <StepKey>String</StepKey>
</SetOnboardingStepRequest>

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>