Buildings

Before sending any events related to buildings, it is crucial to send all available buildings to the platform. This step enables the system to have complete information about the buildings and their attributes, allowing for accurate recommendations.

Example JSON

{
  "id": "e75ff537-fee4-4153-bc5d-be4bc5726dd8",
  "customerBuildingId": "12345",
  "zip": "12345",
  "countryCode": "DE",
  "city": "Berlin",
  "settings": {},
  "devices": [
    {
      "id": "cb16399f-af20-428e-ad2f-69380f9f07a2",
      "location": "Garage",
      "type": "Wallbox",
      "vendor_name": "KEBA",
      "product_name": "KEBA Wallbox P30c",
      "metadata": {},
      "createdAt": 1608299956,
      "updatedAt": 1608299956
    }
  ]
}

API

GEThttps://api.moost.io/buildings/v1

Query parameters

Response

200

OK

Body

application/json

idObjectId (object)

customerBuildingId*string

customerId*string

zipstring

citystring

countryCodestring

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

Request

JavaScriptCurl

const response = await fetch('https://api.moost.io/buildings/v1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": {
      "date": "2024-05-08T03:46:18.201Z"
    },
    "customerBuildingId": "text",
    "customerId": "text",
    "zip": "text",
    "city": "text",
    "countryCode": "text",
    "devices": [
      {
        "id": "text",
        "location": "LIVING_ROOM",
        "type": "APPLIANCE",
        "vendor_name": "text",
        "product_name": "text",
        "metadata": "text",
        "soc": 0,
        "chargingTargetSoc": 0
      }
    ],
    "settings": {
      "lowTariffHourSetting": {
        "mondayStartTime": "text",
        "mondayEndTime": "text",
        "tuesdayStartTime": "text",
        "tuesdayEndTime": "text",
        "wednesdayStartTime": "text",
        "wednesdayEndTime": "text",
        "thursdayStartTime": "text",
        "thursdayEndTime": "text",
        "fridayStartTime": "text",
        "fridayEndTime": "text",
        "saturdayStartTime": "text",
        "saturdayEndTime": "text",
        "sundayStartTime": "text",
        "sundayEndTime": "text"
      }
    },
    "geolocation": {
      "lat": 0,
      "lon": 0
    },
    "inactiveRules": [
      "text"
    ]
  }
]

POSThttps://api.moost.io/buildings/v1

Body

application/json

idObjectId (object)

customerBuildingId*string

customerId*string

zipstring

citystring

countryCodestring

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

Response

201

Created

Body

application/json

idObjectId (object)

customerBuildingId*string

customerId*string

zipstring

citystring

countryCodestring

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

Request

JavaScriptCurl

const response = await fetch('https://api.moost.io/buildings/v1', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerBuildingId": "text",
      "customerId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": {
    "date": "2024-05-08T03:46:18.201Z"
  },
  "customerBuildingId": "text",
  "customerId": "text",
  "zip": "text",
  "city": "text",
  "countryCode": "text",
  "devices": [
    {
      "id": "text",
      "location": "LIVING_ROOM",
      "type": "APPLIANCE",
      "vendor_name": "text",
      "product_name": "text",
      "metadata": "text",
      "soc": 0,
      "chargingTargetSoc": 0
    }
  ],
  "settings": {
    "lowTariffHourSetting": {
      "mondayStartTime": "text",
      "mondayEndTime": "text",
      "tuesdayStartTime": "text",
      "tuesdayEndTime": "text",
      "wednesdayStartTime": "text",
      "wednesdayEndTime": "text",
      "thursdayStartTime": "text",
      "thursdayEndTime": "text",
      "fridayStartTime": "text",
      "fridayEndTime": "text",
      "saturdayStartTime": "text",
      "saturdayEndTime": "text",
      "sundayStartTime": "text",
      "sundayEndTime": "text"
    }
  },
  "geolocation": {
    "lat": 0,
    "lon": 0
  },
  "inactiveRules": [
    "text"
  ]
}

GEThttps://api.moost.io/buildings/{buildingId}/v1

Path parameters

buildingId*ObjectId (object)

Response

200

OK

Body

application/json

idObjectId (object)

customerBuildingId*string

customerId*string

zipstring

citystring

countryCodestring

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

Request

JavaScriptCurl

const response = await fetch('https://api.moost.io/buildings/{buildingId}/v1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": {
    "date": "2024-05-08T03:46:18.201Z"
  },
  "customerBuildingId": "text",
  "customerId": "text",
  "zip": "text",
  "city": "text",
  "countryCode": "text",
  "devices": [
    {
      "id": "text",
      "location": "LIVING_ROOM",
      "type": "APPLIANCE",
      "vendor_name": "text",
      "product_name": "text",
      "metadata": "text",
      "soc": 0,
      "chargingTargetSoc": 0
    }
  ],
  "settings": {
    "lowTariffHourSetting": {
      "mondayStartTime": "text",
      "mondayEndTime": "text",
      "tuesdayStartTime": "text",
      "tuesdayEndTime": "text",
      "wednesdayStartTime": "text",
      "wednesdayEndTime": "text",
      "thursdayStartTime": "text",
      "thursdayEndTime": "text",
      "fridayStartTime": "text",
      "fridayEndTime": "text",
      "saturdayStartTime": "text",
      "saturdayEndTime": "text",
      "sundayStartTime": "text",
      "sundayEndTime": "text"
    }
  },
  "geolocation": {
    "lat": 0,
    "lon": 0
  },
  "inactiveRules": [
    "text"
  ]
}

DELETEhttps://api.moost.io/buildings/{buildingId}/v1

Path parameters

buildingId*ObjectId (object)

Response

200

OK

Request

JavaScriptCurl

const response = await fetch('https://api.moost.io/buildings/{buildingId}/v1', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

GEThttps://api.moost.io/buildings/{customerBuildingId}/devices/v1

Path parameters

customerBuildingId*string

Response

200

OK

Body

application/json

id*string

locationenum

LIVING_ROOMKITCHENBEDROOMMASTER_BEDROOMTOILETTESHOWERBATHOFFICEOTHER

typeenum

APPLIANCEBATTERYCARCAR_CHARGERENERGY_MEASUREMENTGATEWAYGENERATORHEAT_PUMPINPUT_DEVICEINVERTERMOOSTSMART_METERSMART_PLUGSENSORSWITCHTHERMOSTATWATER_HEATERWALL_TABLET

vendor_name*string

product_name*string

metadatastring

createdAtinteger (int64)

updatedAtinteger (int64)

socnumber (float)

chargingTargetSocnumber (float)

chargingTargetSocTimestampinteger (int64)

chargingModeinteger (int32)

heatPumpModeinteger (int32)

Request

JavaScriptCurl

const response = await fetch('https://api.moost.io/buildings/{customerBuildingId}/devices/v1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "location": "LIVING_ROOM",
    "type": "APPLIANCE",
    "vendor_name": "text",
    "product_name": "text",
    "metadata": "text",
    "soc": 0,
    "chargingTargetSoc": 0
  }
]

POSThttps://api.moost.io/buildings/{customerBuildingId}/devices/v1

Path parameters

customerBuildingId*string

Body

application/json

id*string

locationenum

LIVING_ROOMKITCHENBEDROOMMASTER_BEDROOMTOILETTESHOWERBATHOFFICEOTHER

typeenum

APPLIANCEBATTERYCARCAR_CHARGERENERGY_MEASUREMENTGATEWAYGENERATORHEAT_PUMPINPUT_DEVICEINVERTERMOOSTSMART_METERSMART_PLUGSENSORSWITCHTHERMOSTATWATER_HEATERWALL_TABLET

vendor_name*string

product_name*string

metadatastring

createdAtinteger (int64)

updatedAtinteger (int64)

socnumber (float)

chargingTargetSocnumber (float)

chargingTargetSocTimestampinteger (int64)

chargingModeinteger (int32)

heatPumpModeinteger (int32)

Response

201

Created

Request

JavaScriptCurl

const response = await fetch('https://api.moost.io/buildings/{customerBuildingId}/devices/v1', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "product_name": "text",
        "vendor_name": "text"
      }
    ]),
});
const data = await response.json();

GEThttps://api.moost.io/buildings/customer-building-id/{customerBuildingId}/v1

Path parameters

customerBuildingId*string

Query parameters

Response

200

OK

Body

application/json

idObjectId (object)

customerBuildingId*string

customerId*string

zipstring

citystring

countryCodestring

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

Request

JavaScriptCurl

const response = await fetch('https://api.moost.io/buildings/customer-building-id/{customerBuildingId}/v1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": {
    "date": "2024-05-08T03:46:18.201Z"
  },
  "customerBuildingId": "text",
  "customerId": "text",
  "zip": "text",
  "city": "text",
  "countryCode": "text",
  "devices": [
    {
      "id": "text",
      "location": "LIVING_ROOM",
      "type": "APPLIANCE",
      "vendor_name": "text",
      "product_name": "text",
      "metadata": "text",
      "soc": 0,
      "chargingTargetSoc": 0
    }
  ],
  "settings": {
    "lowTariffHourSetting": {
      "mondayStartTime": "text",
      "mondayEndTime": "text",
      "tuesdayStartTime": "text",
      "tuesdayEndTime": "text",
      "wednesdayStartTime": "text",
      "wednesdayEndTime": "text",
      "thursdayStartTime": "text",
      "thursdayEndTime": "text",
      "fridayStartTime": "text",
      "fridayEndTime": "text",
      "saturdayStartTime": "text",
      "saturdayEndTime": "text",
      "sundayStartTime": "text",
      "sundayEndTime": "text"
    }
  },
  "geolocation": {
    "lat": 0,
    "lon": 0
  },
  "inactiveRules": [
    "text"
  ]
}