Trendsic Platform Service

GetWorkspaceModulesRequest

The following routes are available for this service:
GET,OPTIONS	/v1/workspace/modules

**WorkspaceModulesResponse** Parameters:
Name	Parameter	Data Type	Required
Modules	form	List<WorkspaceModule>	No
PackName	form	string	No
Requests	form	List<WorkspaceRequestMark>	No
ResponseStatus	form	ResponseStatus	No

**WorkspaceModule** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Name	form	string	No
Letter	form	string	No
Color	form	string	No
Question	form	string	No
Description	form	string	No
Features	form	List<WorkspaceModuleFeature>	No

**WorkspaceModuleFeature** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Name	form	string	No
Enabled	form	bool	No
InPack	form	bool	No
Group	form	string	No
Description	form	string	No
IsOn	form	bool	No
Entitled	form	bool	No
Reason	form	string	No
ModuleKey	form	string	No
ModuleName	form	string	No
ModuleStatus	form	string	No
ModuleExpiresAt	form	DateTime?	No
Limit	form	ModuleLimit	No

**ModuleLimit** Parameters:
Name	Parameter	Data Type	Required
MeterKey	form	string	No
Used	form	long?	No
Allowance	form	int?	No
IsReached	form	bool	No

**WorkspaceRequestMark** Parameters:
Name	Parameter	Data Type	Required
Kind	form	string	No
Key	form	string	No
Features	form	List<string>	No
RequestedAt	form	DateTime	No

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