Trendsic Platform Service

<back to all web services

GetMyTerminologyRequest

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

public class GetMyTerminologyRequest : IGet, Codable
{
    required public init(){}
}

public class GetMyTerminologyResponse : Codable
{
    public var packCode:String
    public var terms:[String:String] = [:]
    public var features:[String:Bool] = [:]
    public var outOfPack:[String] = []
    public var workspaceSetupCompleted:Bool
    public var sandbox:Bool
    public var entitled:[String:Bool] = [:]
    public var reasons:[String:String] = [:]
    public var chosen:[String:Bool] = [:]
    public var featureModules:[String:String] = [:]
    public var modules:[String:TenantPlanModule] = [:]

    required public init(){}
}

public class TenantPlanModule : Codable
{
    public var name:String
    public var status:String
    public var expiresAt:Date?
    public var meterKey:String
    public var used:Int?
    public var allowance:Int?

    required public init(){}
}


Swift GetMyTerminologyRequest 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/me/terminology HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PackCode: String,
	Terms: 
	{
		String: String
	},
	Features: 
	{
		String: False
	},
	OutOfPack: 
	[
		String
	],
	WorkspaceSetupCompleted: False,
	Sandbox: False,
	Entitled: 
	{
		String: False
	},
	Reasons: 
	{
		String: String
	},
	Chosen: 
	{
		String: False
	},
	FeatureModules: 
	{
		String: String
	},
	Modules: 
	{
		String: 
		{
			Name: String,
			Status: String,
			ExpiresAt: 0001-01-01,
			MeterKey: String,
			Used: 0,
			Allowance: 0
		}
	}
}