Trendsic Platform Service

<back to all web services

GetWorkspaceModulesRequest

"use strict";
export class ModuleLimit {
    /** @param {{MeterKey?:string,Used?:number,Allowance?:number,IsReached?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    MeterKey;
    /** @type {?number} */
    Used;
    /** @type {?number} */
    Allowance;
    /** @type {boolean} */
    IsReached;
}
export class WorkspaceModuleFeature {
    /** @param {{Key?:string,Name?:string,Enabled?:boolean,InPack?:boolean,Group?:string,Description?:string,IsOn?:boolean,Entitled?:boolean,Reason?:string,ModuleKey?:string,ModuleName?:string,ModuleStatus?:string,ModuleExpiresAt?:string,Limit?:ModuleLimit}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    Enabled;
    /** @type {boolean} */
    InPack;
    /** @type {string} */
    Group;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    IsOn;
    /** @type {boolean} */
    Entitled;
    /** @type {string} */
    Reason;
    /** @type {string} */
    ModuleKey;
    /** @type {string} */
    ModuleName;
    /** @type {string} */
    ModuleStatus;
    /** @type {?string} */
    ModuleExpiresAt;
    /** @type {ModuleLimit} */
    Limit;
}
export class WorkspaceModule {
    /** @param {{Key?:string,Name?:string,Letter?:string,Color?:string,Question?:string,Description?:string,Features?:WorkspaceModuleFeature[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Name;
    /** @type {string} */
    Letter;
    /** @type {string} */
    Color;
    /** @type {string} */
    Question;
    /** @type {string} */
    Description;
    /** @type {WorkspaceModuleFeature[]} */
    Features = [];
}
export class WorkspaceRequestMark {
    /** @param {{Kind?:string,Key?:string,Features?:string[],RequestedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {string} */
    Key;
    /** @type {string[]} */
    Features = [];
    /** @type {string} */
    RequestedAt;
}
export class WorkspaceModulesResponse {
    /** @param {{Modules?:WorkspaceModule[],PackName?:string,Requests?:WorkspaceRequestMark[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkspaceModule[]} */
    Modules = [];
    /** @type {string} */
    PackName;
    /** @type {WorkspaceRequestMark[]} */
    Requests = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetWorkspaceModulesRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript GetWorkspaceModulesRequest DTOs

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>