Trendsic Platform Service

<back to all web services

GetOnboardingStatusRequest

Requires Authentication
The following routes are available for this service:
GET/v1/onboarding/status
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type OnboardingStep() = 
        member val Key:String = null with get,set
        member val Chapter:String = null with get,set
        member val Title:String = null with get,set
        member val Why:String = null with get,set
        member val HelpHtml:String = null with get,set
        member val IconHtml:String = null with get,set
        member val CtaLabel:String = null with get,set
        member val CtaRoute:String = null with get,set
        member val Required:Boolean = new Boolean() with get,set
        member val State:Int32 = new Int32() with get,set
        member val Done:Boolean = new Boolean() with get,set
        member val AutoDetected:Boolean = new Boolean() with get,set
        member val Count:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type OnboardingStatus() = 
        member val TenantName:String = null with get,set
        member val PropertyTerm:String = null with get,set
        member val Steps:ResizeArray<OnboardingStep> = new ResizeArray<OnboardingStep>() with get,set
        member val TotalSteps:Int32 = new Int32() with get,set
        member val DoneSteps:Int32 = new Int32() with get,set
        member val RequiredTotal:Int32 = new Int32() with get,set
        member val RequiredDone:Int32 = new Int32() with get,set
        member val PercentComplete:Int32 = new Int32() with get,set
        member val IsComplete:Boolean = new Boolean() with get,set
        member val Dismissed:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetOnboardingStatusRequest() = 
        class end

F# GetOnboardingStatusRequest 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.

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