| GET | /v1/onboarding/status |
|---|
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<OnboardingStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Chapters>
<OnboardingChapter>
<Color>String</Color>
<Full>false</Full>
<LockReason>String</LockReason>
<Name>String</Name>
<Progress>String</Progress>
<Satisfied>0</Satisfied>
<Total>0</Total>
</OnboardingChapter>
</Chapters>
<Dismissed>false</Dismissed>
<DoneSteps>0</DoneSteps>
<DriverServices>
<DispatchModuleView>
<Adds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Adds>
<Allowed>false</Allowed>
<Enabled>false</Enabled>
<Fleet>false</Fleet>
<GoScreens>String</GoScreens>
<InFlight>0</InFlight>
<InPack>false</InPack>
<Key>String</Key>
<Mode>String</Mode>
<Name>String</Name>
<What>String</What>
</DispatchModuleView>
</DriverServices>
<DriverServicesOn>false</DriverServicesOn>
<IsComplete>false</IsComplete>
<ModulesOn>0</ModulesOn>
<ModulesSkipped>0</ModulesSkipped>
<PercentComplete>0</PercentComplete>
<PropertyTerm>String</PropertyTerm>
<RequiredDone>0</RequiredDone>
<RequiredTotal>0</RequiredTotal>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SatisfiedSteps>0</SatisfiedSteps>
<Steps>
<OnboardingStep>
<AutoDetected>false</AutoDetected>
<Chapter>String</Chapter>
<Count>0</Count>
<CtaLabel>String</CtaLabel>
<CtaRoute>String</CtaRoute>
<DetectsCount>false</DetectsCount>
<Done>false</Done>
<HelpHtml>String</HelpHtml>
<Icon>String</Icon>
<InTrial>false</InTrial>
<Key>String</Key>
<LockKey>String</LockKey>
<Locked>
<ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
<FeatureKey>String</FeatureKey>
<FeatureName>String</FeatureName>
<ModuleKey>String</ModuleKey>
<ModuleName>String</ModuleName>
<Reason>String</Reason>
<RequestedAt>0001-01-01T00:00:00</RequestedAt>
</Locked>
<Required>false</Required>
<Requires xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Requires>
<State>0</State>
<Title>String</Title>
<TrialEndsAt>0001-01-01T00:00:00</TrialEndsAt>
<Why>String</Why>
</OnboardingStep>
</Steps>
<TenantName>String</TenantName>
<TotalSteps>0</TotalSteps>
</OnboardingStatus>