| GET | /v1/onboarding/status |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantName | form | string | No | |
| PropertyTerm | form | string | No | |
| Steps | form | List<OnboardingStep> | No | |
| TotalSteps | form | int | No | |
| DoneSteps | form | int | No | |
| RequiredTotal | form | int | No | |
| RequiredDone | form | int | No | |
| PercentComplete | form | int | No | |
| IsComplete | form | bool | No | |
| Dismissed | form | bool | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | No | |
| Chapter | form | string | No | |
| Title | form | string | No | |
| Why | form | string | No | |
| HelpHtml | form | string | No | |
| IconHtml | form | string | No | |
| CtaLabel | form | string | No | |
| CtaRoute | form | string | No | |
| Required | form | bool | No | |
| State | form | int | No | |
| Done | form | bool | No | |
| AutoDetected | form | bool | No | |
| Count | form | int | No |
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.
GET /v1/onboarding/status HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/csv
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"}}}