GET api/SatellitePluginSettings?verbose={verbose}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
verbose

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of SatellitePluginSetting
NameDescriptionTypeAdditional information
SatellitePluginSettingId

integer

None.

Value

string

None.

SatellitePluginId

integer

Required

SettingId

integer

Required

Setting

Setting

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SatellitePluginSettingId": 1,
    "Value": "sample string 2",
    "SatellitePluginId": 3,
    "SettingId": 4,
    "Setting": {
      "SettingId": 1,
      "Name": "sample string 2",
      "Key": "sample string 3",
      "Default": "sample string 4",
      "IsAdvanced": true
    }
  },
  {
    "SatellitePluginSettingId": 1,
    "Value": "sample string 2",
    "SatellitePluginId": 3,
    "SettingId": 4,
    "Setting": {
      "SettingId": 1,
      "Name": "sample string 2",
      "Key": "sample string 3",
      "Default": "sample string 4",
      "IsAdvanced": true
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfSatellitePluginSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Starship.WebAPI.Models">
  <SatellitePluginSetting>
    <SatellitePluginId>3</SatellitePluginId>
    <SatellitePluginSettingId>1</SatellitePluginSettingId>
    <Setting>
      <Default>sample string 4</Default>
      <IsAdvanced>true</IsAdvanced>
      <Key>sample string 3</Key>
      <Name>sample string 2</Name>
      <SettingId>1</SettingId>
    </Setting>
    <SettingId>4</SettingId>
    <Value>sample string 2</Value>
  </SatellitePluginSetting>
  <SatellitePluginSetting>
    <SatellitePluginId>3</SatellitePluginId>
    <SatellitePluginSettingId>1</SatellitePluginSettingId>
    <Setting>
      <Default>sample string 4</Default>
      <IsAdvanced>true</IsAdvanced>
      <Key>sample string 3</Key>
      <Name>sample string 2</Name>
      <SettingId>1</SettingId>
    </Setting>
    <SettingId>4</SettingId>
    <Value>sample string 2</Value>
  </SatellitePluginSetting>
</ArrayOfSatellitePluginSetting>