Trendsic Platform Service

<back to all web services

DismissOnboardingRequest

Requires Authentication
The following routes are available for this service:
POST/v1/onboarding/dismiss
"use strict";
export class OnboardingStep {
    /** @param {{Key?:string,Chapter?:string,Title?:string,Why?:string,HelpHtml?:string,IconHtml?:string,CtaLabel?:string,CtaRoute?:string,Required?:boolean,State?:number,Done?:boolean,AutoDetected?:boolean,Count?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Chapter;
    /** @type {string} */
    Title;
    /** @type {string} */
    Why;
    /** @type {string} */
    HelpHtml;
    /** @type {string} */
    IconHtml;
    /** @type {string} */
    CtaLabel;
    /** @type {string} */
    CtaRoute;
    /** @type {boolean} */
    Required;
    /** @type {number} */
    State;
    /** @type {boolean} */
    Done;
    /** @type {boolean} */
    AutoDetected;
    /** @type {number} */
    Count;
}
export class OnboardingStatus {
    /** @param {{TenantName?:string,PropertyTerm?:string,Steps?:OnboardingStep[],TotalSteps?:number,DoneSteps?:number,RequiredTotal?:number,RequiredDone?:number,PercentComplete?:number,IsComplete?:boolean,Dismissed?:boolean,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} */
    RequiredTotal;
    /** @type {number} */
    RequiredDone;
    /** @type {number} */
    PercentComplete;
    /** @type {boolean} */
    IsComplete;
    /** @type {boolean} */
    Dismissed;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DismissOnboardingRequest {
    /** @param {{Dismissed?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Dismissed;
}

JavaScript DismissOnboardingRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

<DismissOnboardingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Dismissed>false</Dismissed>
</DismissOnboardingRequest>

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>