Trendsic Platform Service

<back to all web services

GetWorkspaceModulesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/workspace/modules
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class GetWorkspaceModulesRequest
    {
        
    }

    public static class WorkspaceModulesResponse
    {
        public ArrayList<WorkspaceModule> Modules = new ArrayList<WorkspaceModule>();
        public String PackName = null;
        public ArrayList<WorkspaceRequestMark> Requests = new ArrayList<WorkspaceRequestMark>();
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<WorkspaceModule> getModules() { return Modules; }
        public WorkspaceModulesResponse setModules(ArrayList<WorkspaceModule> value) { this.Modules = value; return this; }
        public String getPackName() { return PackName; }
        public WorkspaceModulesResponse setPackName(String value) { this.PackName = value; return this; }
        public ArrayList<WorkspaceRequestMark> getRequests() { return Requests; }
        public WorkspaceModulesResponse setRequests(ArrayList<WorkspaceRequestMark> value) { this.Requests = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public WorkspaceModulesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class WorkspaceModule
    {
        public String Key = null;
        public String Name = null;
        public String Letter = null;
        public String Color = null;
        public String Question = null;
        public String Description = null;
        public ArrayList<WorkspaceModuleFeature> Features = new ArrayList<WorkspaceModuleFeature>();
        
        public String getKey() { return Key; }
        public WorkspaceModule setKey(String value) { this.Key = value; return this; }
        public String getName() { return Name; }
        public WorkspaceModule setName(String value) { this.Name = value; return this; }
        public String getLetter() { return Letter; }
        public WorkspaceModule setLetter(String value) { this.Letter = value; return this; }
        public String getColor() { return Color; }
        public WorkspaceModule setColor(String value) { this.Color = value; return this; }
        public String getQuestion() { return Question; }
        public WorkspaceModule setQuestion(String value) { this.Question = value; return this; }
        public String getDescription() { return Description; }
        public WorkspaceModule setDescription(String value) { this.Description = value; return this; }
        public ArrayList<WorkspaceModuleFeature> getFeatures() { return Features; }
        public WorkspaceModule setFeatures(ArrayList<WorkspaceModuleFeature> value) { this.Features = value; return this; }
    }

    public static class WorkspaceModuleFeature
    {
        public String Key = null;
        public String Name = null;
        public Boolean Enabled = null;
        public Boolean InPack = null;
        public String Group = null;
        public String Description = null;
        public Boolean IsOn = null;
        public Boolean Entitled = null;
        public String Reason = null;
        public String ModuleKey = null;
        public String ModuleName = null;
        public String ModuleStatus = null;
        public Date ModuleExpiresAt = null;
        public ModuleLimit Limit = null;
        
        public String getKey() { return Key; }
        public WorkspaceModuleFeature setKey(String value) { this.Key = value; return this; }
        public String getName() { return Name; }
        public WorkspaceModuleFeature setName(String value) { this.Name = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public WorkspaceModuleFeature setEnabled(Boolean value) { this.Enabled = value; return this; }
        public Boolean isInPack() { return InPack; }
        public WorkspaceModuleFeature setInPack(Boolean value) { this.InPack = value; return this; }
        public String getGroup() { return Group; }
        public WorkspaceModuleFeature setGroup(String value) { this.Group = value; return this; }
        public String getDescription() { return Description; }
        public WorkspaceModuleFeature setDescription(String value) { this.Description = value; return this; }
        public Boolean getIsOn() { return IsOn; }
        public WorkspaceModuleFeature setIsOn(Boolean value) { this.IsOn = value; return this; }
        public Boolean isEntitled() { return Entitled; }
        public WorkspaceModuleFeature setEntitled(Boolean value) { this.Entitled = value; return this; }
        public String getReason() { return Reason; }
        public WorkspaceModuleFeature setReason(String value) { this.Reason = value; return this; }
        public String getModuleKey() { return ModuleKey; }
        public WorkspaceModuleFeature setModuleKey(String value) { this.ModuleKey = value; return this; }
        public String getModuleName() { return ModuleName; }
        public WorkspaceModuleFeature setModuleName(String value) { this.ModuleName = value; return this; }
        public String getModuleStatus() { return ModuleStatus; }
        public WorkspaceModuleFeature setModuleStatus(String value) { this.ModuleStatus = value; return this; }
        public Date getModuleExpiresAt() { return ModuleExpiresAt; }
        public WorkspaceModuleFeature setModuleExpiresAt(Date value) { this.ModuleExpiresAt = value; return this; }
        public ModuleLimit getLimit() { return Limit; }
        public WorkspaceModuleFeature setLimit(ModuleLimit value) { this.Limit = value; return this; }
    }

    public static class ModuleLimit
    {
        public String MeterKey = null;
        public Long Used = null;
        public Integer Allowance = null;
        public Boolean IsReached = null;
        
        public String getMeterKey() { return MeterKey; }
        public ModuleLimit setMeterKey(String value) { this.MeterKey = value; return this; }
        public Long getUsed() { return Used; }
        public ModuleLimit setUsed(Long value) { this.Used = value; return this; }
        public Integer getAllowance() { return Allowance; }
        public ModuleLimit setAllowance(Integer value) { this.Allowance = value; return this; }
        public Boolean getIsReached() { return IsReached; }
        public ModuleLimit setIsReached(Boolean value) { this.IsReached = value; return this; }
    }

    public static class WorkspaceRequestMark
    {
        public String Kind = null;
        public String Key = null;
        public ArrayList<String> Features = new ArrayList<String>();
        public Date RequestedAt = null;
        
        public String getKind() { return Kind; }
        public WorkspaceRequestMark setKind(String value) { this.Kind = value; return this; }
        public String getKey() { return Key; }
        public WorkspaceRequestMark setKey(String value) { this.Key = value; return this; }
        public ArrayList<String> getFeatures() { return Features; }
        public WorkspaceRequestMark setFeatures(ArrayList<String> value) { this.Features = value; return this; }
        public Date getRequestedAt() { return RequestedAt; }
        public WorkspaceRequestMark setRequestedAt(Date value) { this.RequestedAt = value; return this; }
    }

}

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