FolderSettings

Add or edit a folder or a meter. To add a new folder use and empty ID

post/folder/settings/{id}

Request

  • Base URL: https://api.smart-me.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.smart-me.com/folder/settings/{id}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token)
    • HTTP basic

Path parameters

idstring uuid required

The ID of the folder or meter to edit. Use and empty ID to add a new folder

Request body

namestring nullable

The Name of the folder or meter

descriptionstring nullable

The Description of the folder or meter

folderType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 1000 | 1001 | 1002 | 20001
<p>Members: </p><ul><li><i>0</i> - Folder</li><li><i>1</i> - Location</li><li><i>2</i> - Factory</li><li><i>3</i> - House</li><li><i>4</i> - Office</li><li><i>5</i> - Machine</li><li><i>6</i> - VirtualMeter</li><li><i>7</i> - ElecticityFolder</li><li><i>8</i> - WaterFolder</li><li><i>9</i> - HeatFolder</li><li><i>10</i> - GasFolder</li><li><i>11</i> - TemperatureFolder</li><li><i>12</i> - Sun</li><li><i>13</i> - Light</li><li><i>14</i> - Ice</li><li><i>15</i> - Sofa</li><li><i>16</i> - Food</li><li><i>17</i> - Coffee</li><li><i>18</i> - Car</li><li><i>19</i> - ChargingStation</li><li><i>1000</i> - Meter</li><li><i>1001</i> - User</li><li><i>1002</i> - Trash</li><li><i>20001</i> - Virtual PV Meter (Used for the Senero Project)</li></ul>
serialNumberinteger

The serial number (meter only)

enableboolean nullable

Flag if the meter is enabled (folder not supported yet)

valueCorrectionnumber double nullable

The value correction on this meter

valueCorrectionParentFoldernumber double nullable

The value correction on all parent folders. but not on the meter itself

parentFolderIdstring uuid nullable

The parent folder ID of this item

visualizationNamestring nullable

The name of the visualization of the folder

visualizationType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13
<p>Members: </p><ul><li><i>0</i> - It's a standard visualization (tiles)</li><li><i>1</i> - It's a simple energy flow (3 meters)</li><li><i>2</i> - The Electricy, Heat and Water view (3 meters)</li><li><i>3</i> - The simple virtual tariffs (1 Folder)</li><li><i>4</i> - House with multiple items (1 house, n items)</li><li><i>5</i> - The Electricy, Heat and Water view (3 meters) with a comparision to 3 refernece meters</li><li><i>6</i> - The Heat, Water temperature view (3 meters) with a comparision to 2 refernece meters</li><li><i>7</i> - The Electricy, Heat and Water view (3 meters) with a comparision to 3 refernece meters in a clean design</li><li><i>8</i> - House with multiple items (1 house, n items) in a clean design</li><li><i>9</i> - The Visualization of a virtual battery</li><li><i>10</i> - A Grid and a Solar meter and the calculation of the self-sufficiency rate and the self-consumption rate</li><li><i>11</i> - A consumpiton and production monitoring.</li><li><i>12</i> - An overview of all pico charging stations of the account (no parameters)</li><li><i>13</i> - The energy and financial performance of a ZEV (grid meter, 1-5 solar meters, 0-3 battery meters)</li></ul>

Response

OK

idstring uuid nullable

The id of the folder menu item

namestring nullable

The Name of the item

descriptionstring nullable

The Description of the folder

folderType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 1000 | 1001 | 1002 | 20001
<p>Members: </p><ul><li><i>0</i> - Folder</li><li><i>1</i> - Location</li><li><i>2</i> - Factory</li><li><i>3</i> - House</li><li><i>4</i> - Office</li><li><i>5</i> - Machine</li><li><i>6</i> - VirtualMeter</li><li><i>7</i> - ElecticityFolder</li><li><i>8</i> - WaterFolder</li><li><i>9</i> - HeatFolder</li><li><i>10</i> - GasFolder</li><li><i>11</i> - TemperatureFolder</li><li><i>12</i> - Sun</li><li><i>13</i> - Light</li><li><i>14</i> - Ice</li><li><i>15</i> - Sofa</li><li><i>16</i> - Food</li><li><i>17</i> - Coffee</li><li><i>18</i> - Car</li><li><i>19</i> - ChargingStation</li><li><i>1000</i> - Meter</li><li><i>1001</i> - User</li><li><i>1002</i> - Trash</li><li><i>20001</i> - Virtual PV Meter (Used for the Senero Project)</li></ul>
iconstring nullable

The path to the Icon of this folder

userIdstring nullable

The ID of the user of this folder (only for foldertype user)

meterSerialNumberstring nullable

The serial number if the folder menu item is a meter. Serial number is handled as a string, as javascript on client side cannot handle long integers properly.

Changes

No recorded changes to this operation across all 1 revision of this API.