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 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 GetMyTerminologyRequest(IGet):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TenantPlanModule:
    name: Optional[str] = None
    status: Optional[str] = None
    expires_at: Optional[datetime.datetime] = None
    meter_key: Optional[str] = None
    used: Optional[int] = None
    allowance: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetMyTerminologyResponse:
    pack_code: Optional[str] = None
    terms: Dict[str, str] = field(default_factory=dict)
    features: Dict[str, bool] = field(default_factory=dict)
    out_of_pack: List[str] = field(default_factory=list)
    workspace_setup_completed: bool = False
    sandbox: bool = False
    entitled: Dict[str, bool] = field(default_factory=dict)
    reasons: Dict[str, str] = field(default_factory=dict)
    chosen: Dict[str, bool] = field(default_factory=dict)
    feature_modules: Dict[str, str] = field(default_factory=dict)
    modules: Dict[str, TenantPlanModule] = field(default_factory=dict)

Python GetMyTerminologyRequest DTOs

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetMyTerminologyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Chosen xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>false</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
  </Chosen>
  <Entitled xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>false</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
  </Entitled>
  <FeatureModules xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </FeatureModules>
  <Features xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringboolean>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>false</d2p1:Value>
    </d2p1:KeyValueOfstringboolean>
  </Features>
  <Modules xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringTenantPlanModulezI6_P42Kz>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <Allowance>0</Allowance>
        <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
        <MeterKey>String</MeterKey>
        <Name>String</Name>
        <Status>String</Status>
        <Used>0</Used>
      </d2p1:Value>
    </d2p1:KeyValueOfstringTenantPlanModulezI6_P42Kz>
  </Modules>
  <OutOfPack xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OutOfPack>
  <PackCode>String</PackCode>
  <Reasons xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Reasons>
  <Sandbox>false</Sandbox>
  <Terms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Terms>
  <WorkspaceSetupCompleted>false</WorkspaceSetupCompleted>
</GetMyTerminologyResponse>