GET api/PluginSettings

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PluginSetting

Name	Type	Additional information
PluginSettingId	integer	None.
PluginId	integer	Required
SettingId	integer	Required
IsRequired	boolean	None.
Setting	Setting	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PluginSettingId": 1,
    "PluginId": 2,
    "SettingId": 3,
    "IsRequired": true,
    "Setting": {
      "SettingId": 1,
      "Name": "sample string 2",
      "Key": "sample string 3",
      "Default": "sample string 4",
      "IsAdvanced": true
    }
  },
  {
    "PluginSettingId": 1,
    "PluginId": 2,
    "SettingId": 3,
    "IsRequired": true,
    "Setting": {
      "SettingId": 1,
      "Name": "sample string 2",
      "Key": "sample string 3",
      "Default": "sample string 4",
      "IsAdvanced": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfPluginSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Starship.WebAPI.Models">
  <PluginSetting>
    <IsRequired>true</IsRequired>
    <PluginId>2</PluginId>
    <PluginSettingId>1</PluginSettingId>
    <Setting>
      <Default>sample string 4</Default>
      <IsAdvanced>true</IsAdvanced>
      <Key>sample string 3</Key>
      <Name>sample string 2</Name>
      <SettingId>1</SettingId>
    </Setting>
    <SettingId>3</SettingId>
  </PluginSetting>
  <PluginSetting>
    <IsRequired>true</IsRequired>
    <PluginId>2</PluginId>
    <PluginSettingId>1</PluginSettingId>
    <Setting>
      <Default>sample string 4</Default>
      <IsAdvanced>true</IsAdvanced>
      <Key>sample string 3</Key>
      <Name>sample string 2</Name>
      <SettingId>1</SettingId>
    </Setting>
    <SettingId>3</SettingId>
  </PluginSetting>
</ArrayOfPluginSetting>