GET GetSettings

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

SettingsRepository
NameDescriptionTypeAdditional information
successful

boolean

None.

message

string

None.

data

Collection of Settings

None.

Response Formats

application/json, text/json

Sample:
{
  "successful": true,
  "message": "sample string 2",
  "data": [
    {
      "settingId": 1,
      "settingCode": "sample string 2",
      "settingValue": "sample string 3"
    },
    {
      "settingId": 1,
      "settingCode": "sample string 2",
      "settingValue": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<SettingsRepository xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Services">
  <data>
    <Settings>
      <settingCode>sample string 2</settingCode>
      <settingId>1</settingId>
      <settingValue>sample string 3</settingValue>
    </Settings>
    <Settings>
      <settingCode>sample string 2</settingCode>
      <settingId>1</settingId>
      <settingValue>sample string 3</settingValue>
    </Settings>
  </data>
  <message>sample string 2</message>
  <successful>true</successful>
</SettingsRepository>