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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetWorkspaceModulesRequest
{
}

open class WorkspaceModulesResponse
{
    open var Modules:ArrayList<WorkspaceModule> = ArrayList<WorkspaceModule>()
    open var PackName:String? = null
    open var Requests:ArrayList<WorkspaceRequestMark> = ArrayList<WorkspaceRequestMark>()
    open var ResponseStatus:ResponseStatus? = null
}

open class WorkspaceModule
{
    open var Key:String? = null
    open var Name:String? = null
    open var Letter:String? = null
    open var Color:String? = null
    open var Question:String? = null
    open var Description:String? = null
    open var Features:ArrayList<WorkspaceModuleFeature> = ArrayList<WorkspaceModuleFeature>()
}

open class WorkspaceModuleFeature
{
    open var Key:String? = null
    open var Name:String? = null
    open var Enabled:Boolean? = null
    open var InPack:Boolean? = null
    open var Group:String? = null
    open var Description:String? = null
    open var IsOn:Boolean? = null
    open var Entitled:Boolean? = null
    open var Reason:String? = null
    open var ModuleKey:String? = null
    open var ModuleName:String? = null
    open var ModuleStatus:String? = null
    open var ModuleExpiresAt:Date? = null
    open var Limit:ModuleLimit? = null
}

open class ModuleLimit
{
    open var MeterKey:String? = null
    open var Used:Long? = null
    open var Allowance:Int? = null
    open var IsReached:Boolean? = null
}

open class WorkspaceRequestMark
{
    open var Kind:String? = null
    open var Key:String? = null
    open var Features:ArrayList<String> = ArrayList<String>()
    open var RequestedAt:Date? = null
}

Kotlin GetWorkspaceModulesRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
					Limit: 
					{
						MeterKey: String,
						Used: 0,
						Allowance: 0,
						IsReached: True
					}
				}
			]
		}
	],
	PackName: String,
	Requests: 
	[
		{
			Kind: String,
			Key: String,
			Features: 
			[
				String
			],
			RequestedAt: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}