Trendsic Platform Service

<back to all web services

GetWorkspaceModulesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/workspace/modules
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 GetWorkspaceModulesRequest
        End Class

        Public Partial Class ModuleLimit
            Public Overridable Property MeterKey As String
            Public Overridable Property Used As Long?
            Public Overridable Property Allowance As Integer?
            Public Overridable Property IsReached As Boolean
        End Class

        Public Partial Class WorkspaceModule
            Public Overridable Property Key As String
            Public Overridable Property Name As String
            Public Overridable Property Letter As String
            Public Overridable Property Color As String
            Public Overridable Property Question As String
            Public Overridable Property Description As String
            Public Overridable Property Features As List(Of WorkspaceModuleFeature) = New List(Of WorkspaceModuleFeature)
        End Class

        Public Partial Class WorkspaceModuleFeature
            Public Overridable Property Key As String
            Public Overridable Property Name As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property InPack As Boolean
            Public Overridable Property Group As String
            Public Overridable Property Description As String
            Public Overridable Property IsOn As Boolean
            Public Overridable Property Entitled As Boolean
            Public Overridable Property Reason As String
            Public Overridable Property ModuleKey As String
            Public Overridable Property ModuleName As String
            Public Overridable Property ModuleStatus As String
            Public Overridable Property ModuleExpiresAt As Date?
            Public Overridable Property Limit As ModuleLimit
        End Class

        Public Partial Class WorkspaceModulesResponse
            Public Overridable Property Modules As List(Of WorkspaceModule) = New List(Of WorkspaceModule)
            Public Overridable Property PackName As String
            Public Overridable Property Requests As List(Of WorkspaceRequestMark) = New List(Of WorkspaceRequestMark)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class WorkspaceRequestMark
            Public Overridable Property Kind As String
            Public Overridable Property Key As String
            Public Overridable Property Features As List(Of String) = New List(Of String)
            Public Overridable Property RequestedAt As Date
        End Class
    End Namespace
End Namespace

VB.NET GetWorkspaceModulesRequest DTOs

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.

GET /v1/workspace/modules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Modules":[{"Key":"String","Name":"String","Letter":"String","Color":"String","Question":"String","Description":"String","Features":[{"Key":"String","Name":"String","Enabled":false,"InPack":false,"Group":"String","Description":"String","IsOn":false,"Entitled":false,"Reason":"String","ModuleKey":"String","ModuleName":"String","ModuleStatus":"String","ModuleExpiresAt":"0001-01-01T00:00:00.0000000","Limit":{"MeterKey":"String","Used":0,"Allowance":0,"IsReached":true}}]}],"PackName":"String","Requests":[{"Kind":"String","Key":"String","Features":["String"],"RequestedAt":"0001-01-01T00:00:00.0000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}