Trendsic Platform Service

<back to all web services

GetOnboardingStatusRequest

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 DispatchModuleView
            Public Overridable Property Key As String
            Public Overridable Property Mode As String
            Public Overridable Property Name As String
            Public Overridable Property What As String
            Public Overridable Property Allowed As Boolean
            Public Overridable Property Enabled As Boolean
            Public Overridable Property InPack As Boolean
            Public Overridable Property Adds As List(Of String) = New List(Of String)
            Public Overridable Property GoScreens As String
            Public Overridable Property Fleet As Boolean
            Public Overridable Property InFlight As Integer
        End Class

        Public Partial Class GetOnboardingStatusRequest
        End Class

        Public Partial Class OnboardingChapter
            Public Overridable Property Name As String
            Public Overridable Property Color As String
            Public Overridable Property Total As Integer
            Public Overridable Property Satisfied As Integer
            Public Overridable Property Full As Boolean
            Public Overridable Property Progress As String
            Public Overridable Property LockReason As String
        End Class

        Public Partial Class OnboardingLock
            Public Overridable Property Reason As String
            Public Overridable Property FeatureKey As String
            Public Overridable Property FeatureName As String
            Public Overridable Property ModuleKey As String
            Public Overridable Property ModuleName As String
            Public Overridable Property ExpiresAt As Date?
            Public Overridable Property RequestedAt As Date?
        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 SatisfiedSteps 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 Chapters As List(Of OnboardingChapter) = New List(Of OnboardingChapter)
            Public Overridable Property DriverServices As List(Of DispatchModuleView) = New List(Of DispatchModuleView)
            Public Overridable Property DriverServicesOn As Boolean
            Public Overridable Property ModulesOn As Integer
            Public Overridable Property ModulesSkipped As Integer
            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 Icon 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
            Public Overridable Property Requires As List(Of String) = New List(Of String)
            Public Overridable Property DetectsCount As Boolean
            Public Overridable Property LockKey As String
            Public Overridable Property Locked As OnboardingLock
            Public Overridable Property InTrial As Boolean
            Public Overridable Property TrialEndsAt As Date?
        End Class
    End Namespace
End Namespace

VB.NET GetOnboardingStatusRequest DTOs

GET /v1/onboarding/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TenantName: String,
	PropertyTerm: String,
	Steps: 
	[
		{
			Key: String,
			Chapter: String,
			Title: String,
			Why: String,
			HelpHtml: String,
			Icon: String,
			CtaLabel: String,
			CtaRoute: String,
			Required: False,
			State: 0,
			Done: False,
			AutoDetected: False,
			Count: 0,
			Requires: 
			[
				String
			],
			DetectsCount: False,
			LockKey: String,
			Locked: 
			{
				Reason: String,
				FeatureKey: String,
				FeatureName: String,
				ModuleKey: String,
				ModuleName: String,
				ExpiresAt: 0001-01-01,
				RequestedAt: 0001-01-01
			},
			InTrial: False,
			TrialEndsAt: 0001-01-01
		}
	],
	TotalSteps: 0,
	DoneSteps: 0,
	SatisfiedSteps: 0,
	RequiredTotal: 0,
	RequiredDone: 0,
	PercentComplete: 0,
	IsComplete: False,
	Dismissed: False,
	Chapters: 
	[
		{
			Name: String,
			Color: String,
			Total: 0,
			Satisfied: 0,
			Full: False,
			Progress: String,
			LockReason: String
		}
	],
	DriverServices: 
	[
		{
			Key: String,
			Mode: String,
			Name: String,
			What: String,
			Allowed: False,
			Enabled: False,
			InPack: False,
			Adds: 
			[
				String
			],
			GoScreens: String,
			Fleet: False,
			InFlight: 0
		}
	],
	DriverServicesOn: False,
	ModulesOn: 0,
	ModulesSkipped: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}