Introduction

This is a step-by-step guide to attach EED-related IDs to properties and units. This enables the built-in module of facilioo to fetch the actual data from the measurement service provider using the attached ID.

Terminology

• AttributeGroupType (Static data): An attribute group will have one of these types. For this Use Case, we will use "Allgemein" with the ID 1. This ID is the same for everyone and won’t change.
• AttributeGroup: These are the actual groups attached to a property or unit. On creation, an externalId can be provided, to be later able to access it via your own ID.
• Attribute (Static data): These are possible attributes that can be set in a given attribute group. We will use the attribute "MessdienstleisterID" with the ID 1437. As the attribute group, this is the same for everyone and won’t change. These are built-in in facilioo.
• AttributeValue: These are the actual values attached to an attribute group, which is attached to a unit/property. For each entity, an attribute group and an attribute value have to be created.

Approach

1. Authentication: Generate an access token with the given credentials.
2. Property/Unit ID: Identify whether the given information is meant for a property or unit. Obtain the correct entity in facilioo by your external ID.
3. Create AttributeGroup
   1. Insert propertyId or unitId
   2. Set name to "EED" (this is not a hard requirement, but highly recommended)
   3. Attach your externalId, to identify your group later on. There you can use whatever internal ID you use to exactly identify this entity. Facilioo will not use this value itself.
   4. Set typeId to 1 ("Allgemein")
4. Save the id from the response or obtain it via the /api/attribute-groups/search endpoint using your external ID.
5. Create AttributeValue
   1. Insert obtained ID from the step before in attributeGroupId
   2. Set attributeId to 1437 ("MessdienstleisterID")
   3. Insert the meter number from the measurement service provider as value

📘

Validation

After completing these steps, you should be able to see the attached information in facilioo as shown in the image at the top.

🚧

Reoccuring Creations

Since these are collections types, ensure beforehand, that the attribute group and the value do not already exist, and if so, update the existing entities accordingly, instead of attaching new ones. Therefore, use the respective PATCH endpoints for the entities to update.

Batching

The creation of multiple entities at once is possible using the batch endpoints for creating AttributeGroup and AttributeValue.

❗️

WIP

A step-by-step approach for batch creation is currently in the making.

Troubleshooting

Attribute not found when creating an attribute value

In general, the attribute required for this use case ("MessdienstleisterId") has the ID 1437. If this isn't the case, you can use the /api/attributes/search endpoint to search for the proper ID. Be sure to check for partyId === null, because otherwise you could end up choosing an individual-made attribute by the property management with the same name by accident, instead of the facilioo built-in one. If there are no matches, do not hesitate to raise a question here.