Trendsic Platform Service

<back to all web services

DismissOnboardingRequest

Requires Authentication
The following routes are available for this service:
POST/v1/onboarding/dismiss
DismissOnboardingRequest Parameters:
NameParameterData TypeRequiredDescription
DismissedbodyboolNo
OnboardingStatus Parameters:
NameParameterData TypeRequiredDescription
TenantNameformstringNo
PropertyTermformstringNo
StepsformList<OnboardingStep>No
TotalStepsformintNo
DoneStepsformintNo
RequiredTotalformintNo
RequiredDoneformintNo
PercentCompleteformintNo
IsCompleteformboolNo
DismissedformboolNo
ResponseStatusformResponseStatusNo
OnboardingStep Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ChapterformstringNo
TitleformstringNo
WhyformstringNo
HelpHtmlformstringNo
IconHtmlformstringNo
CtaLabelformstringNo
CtaRouteformstringNo
RequiredformboolNo
StateformintNo
DoneformboolNo
AutoDetectedformboolNo
CountformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/onboarding/dismiss HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Dismissed":false}
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"}}}