Trendsic Platform Service

<back to all web services

DismissOnboardingRequest

Requires Authentication
The following routes are available for this service:
POST/v1/onboarding/dismiss
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DismissOnboardingRequest
            Public Overridable Property Dismissed As Boolean
        End Class

        Public Partial Class OnboardingStatus
            Public Overridable Property TenantName As String
            Public Overridable Property PropertyTerm As String
            Public Overridable Property Steps As List(Of OnboardingStep) = New List(Of OnboardingStep)
            Public Overridable Property TotalSteps As Integer
            Public Overridable Property DoneSteps As Integer
            Public Overridable Property RequiredTotal As Integer
            Public Overridable Property RequiredDone As Integer
            Public Overridable Property PercentComplete As Integer
            Public Overridable Property IsComplete As Boolean
            Public Overridable Property Dismissed As Boolean
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class OnboardingStep
            Public Overridable Property Key As String
            Public Overridable Property Chapter As String
            Public Overridable Property Title As String
            Public Overridable Property Why As String
            Public Overridable Property HelpHtml As String
            Public Overridable Property IconHtml As String
            Public Overridable Property CtaLabel As String
            Public Overridable Property CtaRoute As String
            Public Overridable Property Required As Boolean
            Public Overridable Property State As Integer
            Public Overridable Property Done As Boolean
            Public Overridable Property AutoDetected As Boolean
            Public Overridable Property Count As Integer
        End Class
    End Namespace
End Namespace

VB.NET DismissOnboardingRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"Dismissed":false}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}