Trendsic Platform Service

<back to all web services

GetWorkspaceModulesRequest

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ModuleLimit:
    meter_key: Optional[str] = None
    used: Optional[int] = None
    allowance: Optional[int] = None
    is_reached: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkspaceModuleFeature:
    key: Optional[str] = None
    name: Optional[str] = None
    enabled: bool = False
    in_pack: bool = False
    group: Optional[str] = None
    description: Optional[str] = None
    is_on: bool = False
    entitled: bool = False
    reason: Optional[str] = None
    module_key: Optional[str] = None
    module_name: Optional[str] = None
    module_status: Optional[str] = None
    module_expires_at: Optional[datetime.datetime] = None
    limit: Optional[ModuleLimit] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkspaceModule:
    key: Optional[str] = None
    name: Optional[str] = None
    letter: Optional[str] = None
    color: Optional[str] = None
    question: Optional[str] = None
    description: Optional[str] = None
    features: List[WorkspaceModuleFeature] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkspaceRequestMark:
    kind: Optional[str] = None
    key: Optional[str] = None
    features: List[str] = field(default_factory=list)
    requested_at: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkspaceModulesResponse:
    modules: List[WorkspaceModule] = field(default_factory=list)
    pack_name: Optional[str] = None
    requests: List[WorkspaceRequestMark] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetWorkspaceModulesRequest:
    pass

Python GetWorkspaceModulesRequest DTOs

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
		}
	}
}