Trendsic Platform Service

<back to all web services

GetWorkspaceModulesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/workspace/modules
import Foundation
import ServiceStack

public class GetWorkspaceModulesRequest : Codable
{
    required public init(){}
}

public class WorkspaceModulesResponse : Codable
{
    public var modules:[WorkspaceModule] = []
    public var packName:String
    public var requests:[WorkspaceRequestMark] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class WorkspaceModule : Codable
{
    public var key:String
    public var name:String
    public var letter:String
    public var color:String
    public var question:String
    public var Description:String
    public var features:[WorkspaceModuleFeature] = []

    required public init(){}
}

public class WorkspaceModuleFeature : Codable
{
    public var key:String
    public var name:String
    public var enabled:Bool
    public var inPack:Bool
    public var group:String
    public var Description:String
    public var isOn:Bool
    public var entitled:Bool
    public var reason:String
    public var moduleKey:String
    public var moduleName:String
    public var moduleStatus:String
    public var moduleExpiresAt:Date?
    public var limit:ModuleLimit

    required public init(){}
}

public class ModuleLimit : Codable
{
    public var meterKey:String
    public var used:Int?
    public var allowance:Int?
    public var isReached:Bool

    required public init(){}
}

public class WorkspaceRequestMark : Codable
{
    public var kind:String
    public var key:String
    public var features:[String] = []
    public var requestedAt:Date

    required public init(){}
}


Swift GetWorkspaceModulesRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}