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.*


open class GetWorkspaceModulesRequest
{
}

open class WorkspaceModulesResponse
{
    open var Modules:ArrayList<WorkspaceModule> = ArrayList<WorkspaceModule>()
    open var PackName:String? = null
    open var Requests:ArrayList<WorkspaceRequestMark> = ArrayList<WorkspaceRequestMark>()
    open var ResponseStatus:ResponseStatus? = null
}

open class WorkspaceModule
{
    open var Key:String? = null
    open var Name:String? = null
    open var Letter:String? = null
    open var Color:String? = null
    open var Question:String? = null
    open var Description:String? = null
    open var Features:ArrayList<WorkspaceModuleFeature> = ArrayList<WorkspaceModuleFeature>()
}

open class WorkspaceModuleFeature
{
    open var Key:String? = null
    open var Name:String? = null
    open var Enabled:Boolean? = null
    open var InPack:Boolean? = null
    open var Group:String? = null
    open var Description:String? = null
    open var IsOn:Boolean? = null
    open var Entitled:Boolean? = null
    open var Reason:String? = null
    open var ModuleKey:String? = null
    open var ModuleName:String? = null
    open var ModuleStatus:String? = null
    open var ModuleExpiresAt:Date? = null
    open var Limit:ModuleLimit? = null
}

open class ModuleLimit
{
    open var MeterKey:String? = null
    open var Used:Long? = null
    open var Allowance:Int? = null
    open var IsReached:Boolean? = null
}

open class WorkspaceRequestMark
{
    open var Kind:String? = null
    open var Key:String? = null
    open var Features:ArrayList<String> = ArrayList<String>()
    open var RequestedAt:Date? = null
}

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