Synchronize Buildings and Devices

Synchronize Buildings

Make sure all buildings, which shall be taken into consideration by the MOOST Recommender Platform, are synchronized to MOOST. I.e. new buildings shall be created, and changed building states shall be updated (incl. deactivation and reactivation) via MOOST API.

Load Buildings

Get all buildings

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

Authorization

bearerAuth

Response

200

OK

Body

application/json

idstring

customerBuildingId*string

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

customerId*string

Pattern: ^[a-zA-Z0-9]{24}$

zipstring

Pattern: ^[A-Z0-9 -]{3,10}$

citystring

Pattern: ^.{1,100}$

countryCodestring

Pattern: ^[A-Z]{2}$

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

registrationTimestampinteger (int64)

customerSubscriptionNamestring

isEarlyAdopterboolean

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": "text",
    "customerBuildingId": "text",
    "customerId": "text",
    "zip": "text",
    "city": "text",
    "countryCode": "text",
    "devices": [
      {
        "id": "text",
        "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"
    ],
    "customerSubscriptionName": "text",
    "isEarlyAdopter": false
  }
]

Example with CURL

# make sure ACCESS_TOKEN is set and valid (see "Request Access Token")
curl -X GET "https://api.moost.io/buildings/v1" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

Load a Building

Get a building

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

Authorization

bearerAuth

Path parameters

customerBuildingId*string

Select specified building.

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

Response

200

OK

Body

application/json

idstring

customerBuildingId*string

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

customerId*string

Pattern: ^[a-zA-Z0-9]{24}$

zipstring

Pattern: ^[A-Z0-9 -]{3,10}$

citystring

Pattern: ^.{1,100}$

countryCodestring

Pattern: ^[A-Z]{2}$

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

registrationTimestampinteger (int64)

customerSubscriptionNamestring

isEarlyAdopterboolean

profileProfile (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "customerBuildingId": "text",
  "customerId": "text",
  "zip": "text",
  "city": "text",
  "countryCode": "text",
  "devices": [
    {
      "id": "text",
      "type": "APPLIANCE",
      "vendor_name": "text",
      "product_name": "text",
      "metadata": "text",
      "soc": 0,
      "chargingTargetSoc": 0,
      "capacity": 0
    }
  ],
  "settings": {
    "tariff": {
      "type": "SINGLE",
      "minPrice": 0,
      "maxPrice": 0,
      "currency": "text",
      "dual": {
        "lowTariff": {
          "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"
        }
      },
      "dynamic": {
        "tariffs": [
          {
            "price": 0
          }
        ]
      }
    }
  },
  "geolocation": {
    "lat": 0,
    "lon": 0
  },
  "inactiveRules": [
    "text"
  ],
  "customerSubscriptionName": "text",
  "isEarlyAdopter": false,
  "profile": {
    "multiPersonScore": 0,
    "ecologicalScore": 0,
    "economicalScore": 0,
    "selfSufficiencyScore": 0
  }
}

Example with CURL

curl -X GET "https://api.moost.io/buildings/999000009C54AEDC/v1" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

Add a Building

Create a building

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

Authorization

bearerAuth

Body

application/json

idstring

customerBuildingId*string

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

customerId*string

Pattern: ^[a-zA-Z0-9]{24}$

zipstring

Pattern: ^[A-Z0-9 -]{3,10}$

citystring

Pattern: ^.{1,100}$

countryCodestring

Pattern: ^[A-Z]{2}$

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

registrationTimestampinteger (int64)

customerSubscriptionNamestring

isEarlyAdopterboolean

profileProfile (object)

Response

201409

Success. Building created.

Body

application/json

idstring

customerBuildingId*string

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

customerId*string

Pattern: ^[a-zA-Z0-9]{24}$

zipstring

Pattern: ^[A-Z0-9 -]{3,10}$

citystring

Pattern: ^.{1,100}$

countryCodestring

Pattern: ^[A-Z]{2}$

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

registrationTimestampinteger (int64)

customerSubscriptionNamestring

isEarlyAdopterboolean

profileProfile (object)

Request

JavaScriptCurlPython

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

Response

201

{
  "id": "text",
  "customerBuildingId": "text",
  "customerId": "text",
  "zip": "text",
  "city": "text",
  "countryCode": "text",
  "devices": [
    {
      "id": "text",
      "type": "APPLIANCE",
      "vendor_name": "text",
      "product_name": "text",
      "metadata": "text",
      "soc": 0,
      "chargingTargetSoc": 0,
      "capacity": 0
    }
  ],
  "settings": {
    "tariff": {
      "type": "SINGLE",
      "minPrice": 0,
      "maxPrice": 0,
      "currency": "text",
      "dual": {
        "lowTariff": {
          "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"
        }
      },
      "dynamic": {
        "tariffs": [
          {
            "price": 0
          }
        ]
      }
    }
  },
  "geolocation": {
    "lat": 0,
    "lon": 0
  },
  "inactiveRules": [
    "text"
  ],
  "customerSubscriptionName": "text",
  "isEarlyAdopter": false,
  "profile": {
    "multiPersonScore": 0,
    "ecologicalScore": 0,
    "economicalScore": 0,
    "selfSufficiencyScore": 0
  }
}

Example with CURL

curl -X POST "https://api.moost.io/buildings/v1" \
     -H  "Authorization: Bearer $ACCESS_TOKEN" \
     -H  "Content-Type: application/json" \
     -d "{\"customerBuildingId\":\"999000009C54AAAB\",\"customerId\":\"656730be2bc9719e6e5ed51d\",\"zip\":\"8010\",\"city\":\"Graz\",\"countryCode\":\"AT\",\"devices\":[],\"settings\":{\"lowTariffHourSetting\":{\"mondayStartTime\":\"20:00\",\"mondayEndTime\":\"07:00\",\"tuesdayStartTime\":\"20:00\",\"tuesdayEndTime\":\"07:00\",\"wednesdayStartTime\":\"20:00\",\"wednesdayEndTime\":\"07:00\",\"thursdayStartTime\":\"20:00\",\"thursdayEndTime\":\"07:00\",\"fridayStartTime\":\"20:00\",\"fridayEndTime\":\"07:00\",\"saturdayStartTime\":\"13:00\",\"saturdayEndTime\":\"07:00\",\"sundayStartTime\":\"00:00\",\"sundayEndTime\":\"07:00\"}},\"registrationTimestamp\":1549971011,\"customerSubscriptionName\":\"Premium\"}"

Adjust a Building

Update a building

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

Authorization

bearerAuth

Body

application/json

idstring

customerBuildingId*string

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

customerId*string

Pattern: ^[a-zA-Z0-9]{24}$

zipstring

Pattern: ^[A-Z0-9 -]{3,10}$

citystring

Pattern: ^.{1,100}$

countryCodestring

Pattern: ^[A-Z]{2}$

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

registrationTimestampinteger (int64)

customerSubscriptionNamestring

isEarlyAdopterboolean

profileProfile (object)

Response

200404

Success. Building updated.

Body

application/json

idstring

customerBuildingId*string

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

customerId*string

Pattern: ^[a-zA-Z0-9]{24}$

zipstring

Pattern: ^[A-Z0-9 -]{3,10}$

citystring

Pattern: ^.{1,100}$

countryCodestring

Pattern: ^[A-Z]{2}$

devicesarray of Device (object)

settingsSettings (object)

geolocationGeolocation (object)

inactiveRulesarray of string

deactivatedTimestampinteger (int64)

registrationTimestampinteger (int64)

customerSubscriptionNamestring

isEarlyAdopterboolean

profileProfile (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "customerBuildingId": "text",
  "customerId": "text",
  "zip": "text",
  "city": "text",
  "countryCode": "text",
  "devices": [
    {
      "id": "text",
      "type": "APPLIANCE",
      "vendor_name": "text",
      "product_name": "text",
      "metadata": "text",
      "soc": 0,
      "chargingTargetSoc": 0,
      "capacity": 0
    }
  ],
  "settings": {
    "tariff": {
      "type": "SINGLE",
      "minPrice": 0,
      "maxPrice": 0,
      "currency": "text",
      "dual": {
        "lowTariff": {
          "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"
        }
      },
      "dynamic": {
        "tariffs": [
          {
            "price": 0
          }
        ]
      }
    }
  },
  "geolocation": {
    "lat": 0,
    "lon": 0
  },
  "inactiveRules": [
    "text"
  ],
  "customerSubscriptionName": "text",
  "isEarlyAdopter": false,
  "profile": {
    "multiPersonScore": 0,
    "ecologicalScore": 0,
    "economicalScore": 0,
    "selfSufficiencyScore": 0
  }
}

Example with CURL

curl -X PUT "https://api.moost.io/buildings/v1" \
     -H  "Authorization: Bearer $ACCESS_TOKEN" \
     -H  "Content-Type: application/json" \
     -d "{\"customerBuildingId\":\"999000009C54AAAA\",\"customerId\":\"656730be2bc9719e6e5ed51d\",\"zip\":\"8020\",\"city\":\"Graz\",\"countryCode\":\"AT\",\"devices\":[],\"settings\":{\"lowTariffHourSetting\":{\"mondayStartTime\":\"20:00\",\"mondayEndTime\":\"07:00\",\"tuesdayStartTime\":\"20:00\",\"tuesdayEndTime\":\"07:00\",\"wednesdayStartTime\":\"20:00\",\"wednesdayEndTime\":\"07:00\",\"thursdayStartTime\":\"20:00\",\"thursdayEndTime\":\"07:00\",\"fridayStartTime\":\"20:00\",\"fridayEndTime\":\"07:00\",\"saturdayStartTime\":\"13:00\",\"saturdayEndTime\":\"07:00\",\"sundayStartTime\":\"00:00\",\"sundayEndTime\":\"07:00\"}},\"registrationTimestamp\":1549971011,\"customerSubscriptionName\":\"Premium\"}"

Delete a Building

Delete a building

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

Authorization

bearerAuth

Path parameters

customerBuildingId*string

Delete specified building.

Response

200404

Success. Building deleted.

Request

JavaScriptCurlPython

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

Example with CURL

curl -X DELETE "https://api.moost.io/buildings/999000009C54AAAB/v1" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

Synchronize Devices of Buildings

Make sure that devices of buildings, which shall be taken into consideration by MOOST Recommender Platform, are synchronized to MOOST via MOOST API.

Remark: it is also possible to manage the devices via the upper mentioned building API's.

Update Devices of a Building

Attach a set of devices to a building

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

Authorization

bearerAuth

Path parameters

customerBuildingId*string

Set devices of specified building.

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

Body

application/json

id*string

Pattern: ^[a-zA-Z0-9:._-]{3,64}$

typeenum

APPLIANCEBATTERYCARCAR_CHARGERENERGY_MEASUREMENTGATEWAYHEAT_PUMPINPUT_DEVICEINVERTERMOOSTSMART_METERSMART_PLUGSWITCHTHERMOSTATTHERMAL_ZONETHERMAL_STORAGEWATER_HEATERWALL_TABLET

vendor_name*string

Pattern: ^.{1,100}$

product_name*string

Pattern: ^.{1,100}$

metadatastring

Pattern: ^.{0,1000}$

createdAtinteger (int64)

updatedAtinteger (int64)

socnumber (float)

chargingTargetSocnumber (float)

chargingTargetSocTimestampinteger (int64)

chargingModeinteger (int32)

capacitynumber (float)

Response

200404

Success. Devices updated.

Request

JavaScriptCurlPython

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

Example with CURL

curl -X PUT "https://api.moost.io/buildings/999000009C54AAAA/devices/v1" \
    -H  "Authorization: Bearer $ACCESS_TOKEN" \
    -H  "Content-Type: application/json"  \
    -d "[{\"id\": \"17306deb97e0f94609f13e22\", \"type\": \"CAR\", \"vendor_name\": \"Device Link Car\", \"product_name\": \"Device Link Car\", \"createdAt\": 1702981099,\"updatedAt\": 1707135597}, {\"id\": \"1730da2d6e14aa3701e65105\", \"type\": \"HEAT_PUMP\", \"vendor_name\": \"SG Ready Switch\", \"product_name\": \"SG Ready Switch\", \"createdAt\": 1665915437,\"updatedAt\": 1707124897}, {\"id\": \"173042c71376cf79c2dc8bde\", \"type\": \"BATTERY\", \"vendor_name\": \"TWICE Hexagon\", \"product_name\": \"TWICE Hexagon\", \"createdAt\": 1697727175,\"updatedAt\": 1707144323}, {\"id\": \"173062ba52ae9f481a010aa9\", \"type\": \"CAR_CHARGER\", \"vendor_name\": \"easee Home\", \"product_name\": \"easee Home\", \"createdAt\": 1617388218,\"updatedAt\": 1707144356}]"