| POST | /v1/onboarding/step |
|---|
import Foundation
import ServiceStack
public class SetOnboardingStepRequest : Codable
{
public var stepKey:String
public var state:Int
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 requiredTotal:Int
public var requiredDone:Int
public var percentComplete:Int
public var isComplete:Bool
public var dismissed:Bool
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 iconHtml: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
required public init(){}
}
Swift SetOnboardingStepRequest 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.
POST /v1/onboarding/step HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"StepKey":"String","State":0}
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","IconHtml":"String","CtaLabel":"String","CtaRoute":"String","Required":false,"State":0,"Done":false,"AutoDetected":false,"Count":0}],"TotalSteps":0,"DoneSteps":0,"RequiredTotal":0,"RequiredDone":0,"PercentComplete":0,"IsComplete":false,"Dismissed":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}