Trendsic Platform Service

GetWorkspaceModulesRequest

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


export class ModuleLimit
{
    public MeterKey: string;
    public Used?: number;
    public Allowance?: number;
    public IsReached: boolean;

    public constructor(init?: Partial<ModuleLimit>) { (Object as any).assign(this, init); }
}

export class WorkspaceModuleFeature
{
    public Key: string;
    public Name: string;
    public Enabled: boolean;
    public InPack: boolean;
    public Group: string;
    public Description: string;
    public IsOn: boolean;
    public Entitled: boolean;
    public Reason: string;
    public ModuleKey: string;
    public ModuleName: string;
    public ModuleStatus: string;
    public ModuleExpiresAt?: string;
    public Limit: ModuleLimit;

    public constructor(init?: Partial<WorkspaceModuleFeature>) { (Object as any).assign(this, init); }
}

export class WorkspaceModule
{
    public Key: string;
    public Name: string;
    public Letter: string;
    public Color: string;
    public Question: string;
    public Description: string;
    public Features: WorkspaceModuleFeature[] = [];

    public constructor(init?: Partial<WorkspaceModule>) { (Object as any).assign(this, init); }
}

export class WorkspaceRequestMark
{
    public Kind: string;
    public Key: string;
    public Features: string[] = [];
    public RequestedAt: string;

    public constructor(init?: Partial<WorkspaceRequestMark>) { (Object as any).assign(this, init); }
}

export class WorkspaceModulesResponse
{
    public Modules: WorkspaceModule[] = [];
    public PackName: string;
    public Requests: WorkspaceRequestMark[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<WorkspaceModulesResponse>) { (Object as any).assign(this, init); }
}

export class GetWorkspaceModulesRequest
{

    public constructor(init?: Partial<GetWorkspaceModulesRequest>) { (Object as any).assign(this, init); }
}

TypeScript GetWorkspaceModulesRequest 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/workspace/modules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkspaceModulesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Modules>
    <WorkspaceModule>
      <Color>String</Color>
      <Description>String</Description>
      <Features>
        <WorkspaceModuleFeature>
          <Description>String</Description>
          <Enabled>false</Enabled>
          <Entitled>false</Entitled>
          <Group>String</Group>
          <InPack>false</InPack>
          <IsOn>false</IsOn>
          <Key>String</Key>
          <Limit>
            <Allowance>0</Allowance>
            <MeterKey>String</MeterKey>
            <Used>0</Used>
          </Limit>
          <ModuleExpiresAt>0001-01-01T00:00:00</ModuleExpiresAt>
          <ModuleKey>String</ModuleKey>
          <ModuleName>String</ModuleName>
          <ModuleStatus>String</ModuleStatus>
          <Name>String</Name>
          <Reason>String</Reason>
        </WorkspaceModuleFeature>
      </Features>
      <Key>String</Key>
      <Letter>String</Letter>
      <Name>String</Name>
      <Question>String</Question>
    </WorkspaceModule>
  </Modules>
  <PackName>String</PackName>
  <Requests>
    <WorkspaceRequestMark>
      <Features xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Features>
      <Key>String</Key>
      <Kind>String</Kind>
      <RequestedAt>0001-01-01T00:00:00</RequestedAt>
    </WorkspaceRequestMark>
  </Requests>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</WorkspaceModulesResponse>