| POST | /v1/onboarding/step |
|---|
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 SetOnboardingStepRequest() =
member val StepKey:String = null with get,set
member val State:Int32 = new Int32() with get,set
F# SetOnboardingStepRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"StepKey":"String","State":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}