Trendsic Platform Service

GetOnboardingStatusRequest

The following routes are available for this service:
GET	/v1/onboarding/status

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetOnboardingStatusRequest
{
}

open class OnboardingStatus
{
    open var TenantName:String? = null
    open var PropertyTerm:String? = null
    open var Steps:ArrayList<OnboardingStep> = ArrayList<OnboardingStep>()
    open var TotalSteps:Int? = null
    open var DoneSteps:Int? = null
    open var SatisfiedSteps:Int? = null
    open var RequiredTotal:Int? = null
    open var RequiredDone:Int? = null
    open var PercentComplete:Int? = null
    open var IsComplete:Boolean? = null
    open var Dismissed:Boolean? = null
    open var Chapters:ArrayList<OnboardingChapter> = ArrayList<OnboardingChapter>()
    open var DriverServices:ArrayList<DispatchModuleView> = ArrayList<DispatchModuleView>()
    open var DriverServicesOn:Boolean? = null
    open var ModulesOn:Int? = null
    open var ModulesSkipped:Int? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class OnboardingStep
{
    open var Key:String? = null
    open var Chapter:String? = null
    open var Title:String? = null
    open var Why:String? = null
    open var HelpHtml:String? = null
    open var Icon:String? = null
    open var CtaLabel:String? = null
    open var CtaRoute:String? = null
    open var Required:Boolean? = null
    open var State:Int? = null
    open var Done:Boolean? = null
    open var AutoDetected:Boolean? = null
    open var Count:Int? = null
    open var Requires:ArrayList<String> = ArrayList<String>()
    open var DetectsCount:Boolean? = null
    open var LockKey:String? = null
    open var Locked:OnboardingLock? = null
    open var InTrial:Boolean? = null
    open var TrialEndsAt:Date? = null
}

open class OnboardingLock
{
    open var Reason:String? = null
    open var FeatureKey:String? = null
    open var FeatureName:String? = null
    open var ModuleKey:String? = null
    open var ModuleName:String? = null
    open var ExpiresAt:Date? = null
    open var RequestedAt:Date? = null
}

open class OnboardingChapter
{
    open var Name:String? = null
    open var Color:String? = null
    open var Total:Int? = null
    open var Satisfied:Int? = null
    open var Full:Boolean? = null
    open var Progress:String? = null
    open var LockReason:String? = null
}

open class DispatchModuleView
{
    open var Key:String? = null
    open var Mode:String? = null
    open var Name:String? = null
    open var What:String? = null
    open var Allowed:Boolean? = null
    open var Enabled:Boolean? = null
    open var InPack:Boolean? = null
    open var Adds:ArrayList<String> = ArrayList<String>()
    open var GoScreens:String? = null
    open var Fleet:Boolean? = null
    open var InFlight:Int? = null
}

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