Trendsic Platform Service

<back to all web services

GetOnboardingStatusRequest

"use strict";
export class OnboardingLock {
    /** @param {{Reason?:string,FeatureKey?:string,FeatureName?:string,ModuleKey?:string,ModuleName?:string,ExpiresAt?:string,RequestedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Reason;
    /** @type {string} */
    FeatureKey;
    /** @type {string} */
    FeatureName;
    /** @type {string} */
    ModuleKey;
    /** @type {string} */
    ModuleName;
    /** @type {?string} */
    ExpiresAt;
    /** @type {?string} */
    RequestedAt;
}
export class OnboardingStep {
    /** @param {{Key?:string,Chapter?:string,Title?:string,Why?:string,HelpHtml?:string,Icon?:string,CtaLabel?:string,CtaRoute?:string,Required?:boolean,State?:number,Done?:boolean,AutoDetected?:boolean,Count?:number,Requires?:string[],DetectsCount?:boolean,LockKey?:string,Locked?:OnboardingLock,InTrial?:boolean,TrialEndsAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Chapter;
    /** @type {string} */
    Title;
    /** @type {string} */
    Why;
    /** @type {string} */
    HelpHtml;
    /** @type {string} */
    Icon;
    /** @type {string} */
    CtaLabel;
    /** @type {string} */
    CtaRoute;
    /** @type {boolean} */
    Required;
    /** @type {number} */
    State;
    /** @type {boolean} */
    Done;
    /** @type {boolean} */
    AutoDetected;
    /** @type {number} */
    Count;
    /** @type {string[]} */
    Requires = [];
    /** @type {boolean} */
    DetectsCount;
    /** @type {string} */
    LockKey;
    /** @type {OnboardingLock} */
    Locked;
    /** @type {boolean} */
    InTrial;
    /** @type {?string} */
    TrialEndsAt;
}
export class OnboardingChapter {
    /** @param {{Name?:string,Color?:string,Total?:number,Satisfied?:number,Full?:boolean,Progress?:string,LockReason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Color;
    /** @type {number} */
    Total;
    /** @type {number} */
    Satisfied;
    /** @type {boolean} */
    Full;
    /** @type {string} */
    Progress;
    /** @type {string} */
    LockReason;
}
export class DispatchModuleView {
    /** @param {{Key?:string,Mode?:string,Name?:string,What?:string,Allowed?:boolean,Enabled?:boolean,InPack?:boolean,Adds?:string[],GoScreens?:string,Fleet?:boolean,InFlight?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Mode;
    /** @type {string} */
    Name;
    /** @type {string} */
    What;
    /** @type {boolean} */
    Allowed;
    /** @type {boolean} */
    Enabled;
    /** @type {boolean} */
    InPack;
    /** @type {string[]} */
    Adds = [];
    /** @type {string} */
    GoScreens;
    /** @type {boolean} */
    Fleet;
    /** @type {number} */
    InFlight;
}
export class OnboardingStatus {
    /** @param {{TenantName?:string,PropertyTerm?:string,Steps?:OnboardingStep[],TotalSteps?:number,DoneSteps?:number,SatisfiedSteps?:number,RequiredTotal?:number,RequiredDone?:number,PercentComplete?:number,IsComplete?:boolean,Dismissed?:boolean,Chapters?:OnboardingChapter[],DriverServices?:DispatchModuleView[],DriverServicesOn?:boolean,ModulesOn?:number,ModulesSkipped?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TenantName;
    /** @type {string} */
    PropertyTerm;
    /** @type {OnboardingStep[]} */
    Steps = [];
    /** @type {number} */
    TotalSteps;
    /** @type {number} */
    DoneSteps;
    /** @type {number} */
    SatisfiedSteps;
    /** @type {number} */
    RequiredTotal;
    /** @type {number} */
    RequiredDone;
    /** @type {number} */
    PercentComplete;
    /** @type {boolean} */
    IsComplete;
    /** @type {boolean} */
    Dismissed;
    /** @type {OnboardingChapter[]} */
    Chapters = [];
    /** @type {DispatchModuleView[]} */
    DriverServices = [];
    /** @type {boolean} */
    DriverServicesOn;
    /** @type {number} */
    ModulesOn;
    /** @type {number} */
    ModulesSkipped;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetOnboardingStatusRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript GetOnboardingStatusRequest DTOs

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">
  <Chapters>
    <OnboardingChapter>
      <Color>String</Color>
      <Full>false</Full>
      <LockReason>String</LockReason>
      <Name>String</Name>
      <Progress>String</Progress>
      <Satisfied>0</Satisfied>
      <Total>0</Total>
    </OnboardingChapter>
  </Chapters>
  <Dismissed>false</Dismissed>
  <DoneSteps>0</DoneSteps>
  <DriverServices>
    <DispatchModuleView>
      <Adds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Adds>
      <Allowed>false</Allowed>
      <Enabled>false</Enabled>
      <Fleet>false</Fleet>
      <GoScreens>String</GoScreens>
      <InFlight>0</InFlight>
      <InPack>false</InPack>
      <Key>String</Key>
      <Mode>String</Mode>
      <Name>String</Name>
      <What>String</What>
    </DispatchModuleView>
  </DriverServices>
  <DriverServicesOn>false</DriverServicesOn>
  <IsComplete>false</IsComplete>
  <ModulesOn>0</ModulesOn>
  <ModulesSkipped>0</ModulesSkipped>
  <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>
  <SatisfiedSteps>0</SatisfiedSteps>
  <Steps>
    <OnboardingStep>
      <AutoDetected>false</AutoDetected>
      <Chapter>String</Chapter>
      <Count>0</Count>
      <CtaLabel>String</CtaLabel>
      <CtaRoute>String</CtaRoute>
      <DetectsCount>false</DetectsCount>
      <Done>false</Done>
      <HelpHtml>String</HelpHtml>
      <Icon>String</Icon>
      <InTrial>false</InTrial>
      <Key>String</Key>
      <LockKey>String</LockKey>
      <Locked>
        <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
        <FeatureKey>String</FeatureKey>
        <FeatureName>String</FeatureName>
        <ModuleKey>String</ModuleKey>
        <ModuleName>String</ModuleName>
        <Reason>String</Reason>
        <RequestedAt>0001-01-01T00:00:00</RequestedAt>
      </Locked>
      <Required>false</Required>
      <Requires xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Requires>
      <State>0</State>
      <Title>String</Title>
      <TrialEndsAt>0001-01-01T00:00:00</TrialEndsAt>
      <Why>String</Why>
    </OnboardingStep>
  </Steps>
  <TenantName>String</TenantName>
  <TotalSteps>0</TotalSteps>
</OnboardingStatus>