search

Synchronize Buildings and Devices

hashtag

hashtag
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.

hashtag
Building Data Structure

Following example depicts a data structure of a building located in Dresden, with a couple of connected devices, with dual tariff.

{
  "id": "66d07a7fd51e3528aa5673ba",
  "customerId": "656730be2bc9719e6e5ed51d",
  "customerBuildingId": "99900000C048ADA6",
  "zip": "01067",
  "city": "Dresden",
  "countryCode": "DE",
  "timeZoneId": "Europe/Berlin",
  "geolocation": {
    "lat": 47.2383918762207,
    "lon": 8.284913063049316
  },
  "registrationTimestamp": 1645630735,
  "activationTimestamp": 1645640000,
  "isEarlyAdopter": false,
  "userIds": [
    "user2547865"
  ],
  "disabledNotifications": [
    {
      "ruleId": "63fb7ac54978916150dc5572",
      "userId": "user2547865"
    }
  ],
  "inactiveRules": [],
  "devices": [
    {
      "id": "656830efc4515778b1ce4f2f",
      "type": "CAR",
      "name": "John's Car",
      "product_name": "Device Link Car",
      "createdAt": 1701327087,
      "updatedAt": 1724896211,
    },
    {
      "id": "621660e410c1012648d7bed2",
      "type": "CAR_CHARGER",
      "name": "easee Home",
      "product_name": "easee Home",
      "createdAt": 1645633761,
      "updatedAt": 1724936865
    }
  ],
  "settings": {
    "tariff": {
      "type": "DUAL",
      "minPrice": "0.296",
      "maxPrice": "0.385",
      "currency": "EUR",
      "dual": {
        "lowTariff": {
          "mondayStartTime": "19:00",
          "mondayEndTime": "07:00",
          "tuesdayStartTime": "19:00",
          "tuesdayEndTime": "07:00",
          "wednesdayStartTime": "19:00",
          "wednesdayEndTime": "07:00",
          "thursdayStartTime": "19:00",
          "thursdayEndTime": "07:00",
          "fridayStartTime": "19:00",
          "fridayEndTime": "07:00",
          "saturdayStartTime": "00:00",
          "saturdayEndTime": "07:00",
          "sundayStartTime": "00:00",
          "sundayEndTime": "07:00"
        }
      }
    }
  },
  "properties": {}
}

hashtag
Data Structure Attributes

Attribute Name
Description

id

The building ID on MOOST side (is generated when inserting a new building)

customerId

The ID of the customer (cannot be set or changed)

customerBuildingId

The building ID on customer side

zip

Postal code

city

Name of the city

countryCode

Country Code, https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2arrow-up-right

timeZoneId

The time zone id of the building, https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesarrow-up-right This is automatically added by MOOST if not provided (and if provided, it would be verified).

geolocation

The geo location of the building.

https://en.wikipedia.org/wiki/ISO_6709arrow-up-right

This is automatically added by MOOST if not provided.

registrationTimestamp

Time (Epoch Time in seconds (UTC)) when the building was registered on customer side.

activationTimestamp

Time (Epoch Time in seconds (UTC)) when the building was added to MOOST Recommender Platform. This time is automatically added by MOOST when inserting a new building.

deactivatedTimestamp

If building has been deregistered, and shall no longer receive notifications, then this attribute is set, and contains Epoch Time in seconds (UTC)

isEarlyAdopter

If building is marked as early adopters, then he/she also receives notifications of rules marked for "Early Adopter" (these are typically new designed rules which shall be tested on a small user (aka building) base.

devices

List of devices. Each device mainly contains following attributes

userIds

A list of users may be attached to a building.

If present, push notifications can be can be disabled for individual users instead of for the entire building.

disabledNotifications

If userIds are attached to the building, this attribute may contain a list of disabled rules for a set us users,

inactiveRules

This attribute contains a list of disabled rules for this building.

settings.tariff

You may add tariff data of a building. If dual or dynamic tariff settings are defined, then MOOST is able to generate additional tariff related events. The tariff sub-structures are explained in table cells below. Remark: attributes "currency", "minPrice" and "maxPrice" are optional, and are "per kWh" based.

Single tariff settings

Dual tariff settings: defines the low-tariff time for a whole week.

Dynamic tariff settings: defines the dynamic tariff slices for the next couple of hours (typically for 1 - 2 days)

Remark: when reading building data, there might be additional attributes set, such as profile or geolocation. These fields are calculated by MOOST and is not to be modified by the customer.

hashtag
Load Buildings

hashtag
Get all buildings

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
activeOnlybooleanOptionalDefault: false
Responses
get
/buildings/v1
200

OK

hashtag
Example with CURL

hashtag
Load a Building

hashtag
Get a building

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
customerBuildingIdstringRequired

Select specified building.

Pattern: ^[a-zA-Z0-9:._-]{1,100}$
Responses
get
/buildings/{customerBuildingId}/v1
200

OK

hashtag
Example with CURL

hashtag
Add a Building

hashtag
Create a building

post

Creates a new building. When in EXCLUDE mode and no activeRules are provided it will add all existing rules of the customer to the activeRules of the building.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
rulesOperatorExcludebooleanOptional
kwpnumber · floatOptional
idstringOptional
customerBuildingIdstringRequiredPattern: ^[a-zA-Z0-9:._-]{1,100}$
customerIdstringRequiredPattern: ^[a-zA-Z0-9]{24}$
zipstringRequiredPattern: ^[A-Z0-9 -]{3,10}$
citystringRequiredPattern: ^.{1,100}$
countryCodestringRequiredPattern: ^[A-Z]{2}$
timeZoneIdstringOptionalPattern: ^[a-zA-Z0-9/_+-]{1,32}$
rulesOperatorstring · enumOptionalPossible values:
inactiveRulesstring[]Optional
activeRulesstring[]Optional
deactivatedTimestampinteger · int64Optional
activationTimestampinteger · int64Optional
registrationTimestampinteger · int64Optional
customerSubscriptionNamestringOptional
isEarlyAdopterbooleanOptional
userIdsstring[]Optional
isEnergyGenerationAvailablebooleanOptional
kWpnumber · floatOptional
Responses
post
/buildings/v1

hashtag
Example with CURL

hashtag
Adjust a Building

hashtag
Update a building

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
rulesOperatorExcludebooleanOptional
kwpnumber · floatOptional
idstringOptional
customerBuildingIdstringRequiredPattern: ^[a-zA-Z0-9:._-]{1,100}$
customerIdstringRequiredPattern: ^[a-zA-Z0-9]{24}$
zipstringRequiredPattern: ^[A-Z0-9 -]{3,10}$
citystringRequiredPattern: ^.{1,100}$
countryCodestringRequiredPattern: ^[A-Z]{2}$
timeZoneIdstringOptionalPattern: ^[a-zA-Z0-9/_+-]{1,32}$
rulesOperatorstring · enumOptionalPossible values:
inactiveRulesstring[]Optional
activeRulesstring[]Optional
deactivatedTimestampinteger · int64Optional
activationTimestampinteger · int64Optional
registrationTimestampinteger · int64Optional
customerSubscriptionNamestringOptional
isEarlyAdopterbooleanOptional
userIdsstring[]Optional
isEnergyGenerationAvailablebooleanOptional
kWpnumber · floatOptional
Responses
put
/buildings/v1

hashtag
Example with CURL

hashtag
Delete a Building

hashtag
Delete a building

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
customerBuildingIdstringRequired

Delete specified building.

Responses
delete
/buildings/{customerBuildingId}/v1
No content

hashtag
Example with CURL

hashtag
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.

hashtag
Update Devices of a Building

hashtag
Attach a set of devices to a building

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
customerBuildingIdstringRequired

Set devices of specified building.

Pattern: ^[a-zA-Z0-9:._-]{1,100}$
Bodyobject[]
idstringRequiredPattern: ^[a-zA-Z0-9:._-]{3,64}$
typestring · enumRequiredPossible values:
vendor_namestringRequiredPattern: ^.{1,100}$
namestringRequiredPattern: ^.{1,100}$
product_namestringRequiredPattern: ^.{1,100}$
metadatastringOptionalPattern: ^.{0,1000}$
createdAtinteger · int64Optional
updatedAtinteger · int64Optional
socnumber · floatOptional
chargingTargetSocnumber · floatOptional
chargingTargetSocTimestampinteger · int64Optional
chargingModeinteger · int32Optional
capacitynumber · floatOptional
Responses
put
/buildings/{customerBuildingId}/devices/v1
No content

hashtag
Example with CURL

PreviousRequest Access TokenNextDevice Types

Last updated