| 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 .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"TenantName":"String","PropertyTerm":"String","Steps":[{"Key":"String","Chapter":"String","Title":"String","Why":"String","HelpHtml":"String","Icon":"String","CtaLabel":"String","CtaRoute":"String","Required":false,"State":0,"Done":false,"AutoDetected":false,"Count":0,"Requires":["String"],"DetectsCount":false,"LockKey":"String","Locked":{"Reason":"String","FeatureKey":"String","FeatureName":"String","ModuleKey":"String","ModuleName":"String","ExpiresAt":"0001-01-01T00:00:00.0000000","RequestedAt":"0001-01-01T00:00:00.0000000"},"InTrial":false,"TrialEndsAt":"0001-01-01T00:00:00.0000000"}],"TotalSteps":0,"DoneSteps":0,"SatisfiedSteps":0,"RequiredTotal":0,"RequiredDone":0,"PercentComplete":0,"IsComplete":false,"Dismissed":false,"Chapters":[{"Name":"String","Color":"String","Total":0,"Satisfied":0,"Full":false,"Progress":"String","LockReason":"String"}],"DriverServices":[{"Key":"String","Mode":"String","Name":"String","What":"String","Allowed":false,"Enabled":false,"InPack":false,"Adds":["String"],"GoScreens":"String","Fleet":false,"InFlight":0}],"DriverServicesOn":false,"ModulesOn":0,"ModulesSkipped":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}