Trendsic Platform Service

GetOnboardingStatusRequest

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

import Foundation
import ServiceStack

public class GetOnboardingStatusRequest : Codable
{
    required public init(){}
}

public class OnboardingStatus : Codable
{
    public var tenantName:String
    public var propertyTerm:String
    public var steps:[OnboardingStep] = []
    public var totalSteps:Int
    public var doneSteps:Int
    public var satisfiedSteps:Int
    public var requiredTotal:Int
    public var requiredDone:Int
    public var percentComplete:Int
    public var isComplete:Bool
    public var dismissed:Bool
    public var chapters:[OnboardingChapter] = []
    public var driverServices:[DispatchModuleView] = []
    public var driverServicesOn:Bool
    public var modulesOn:Int
    public var modulesSkipped:Int
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class OnboardingStep : Codable
{
    public var key:String
    public var chapter:String
    public var title:String
    public var why:String
    public var helpHtml:String
    public var icon:String
    public var ctaLabel:String
    public var ctaRoute:String
    public var required:Bool
    public var state:Int
    public var done:Bool
    public var autoDetected:Bool
    public var count:Int
    public var requires:[String] = []
    public var detectsCount:Bool
    public var lockKey:String
    public var locked:OnboardingLock
    public var inTrial:Bool
    public var trialEndsAt:Date?

    required public init(){}
}

public class OnboardingLock : Codable
{
    public var reason:String
    public var featureKey:String
    public var featureName:String
    public var moduleKey:String
    public var moduleName:String
    public var expiresAt:Date?
    public var requestedAt:Date?

    required public init(){}
}

public class OnboardingChapter : Codable
{
    public var name:String
    public var color:String
    public var total:Int
    public var satisfied:Int
    public var full:Bool
    public var progress:String
    public var lockReason:String

    required public init(){}
}

public class DispatchModuleView : Codable
{
    public var key:String
    public var mode:String
    public var name:String
    public var what:String
    public var allowed:Bool
    public var enabled:Bool
    public var inPack:Bool
    public var adds:[String] = []
    public var goScreens:String
    public var fleet:Bool
    public var inFlight:Int

    required public init(){}
}

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