To ensure identification of Smartvatten devices and water meters within Smartvatten platform and API, we have established the following guidelines for IDs recognition and management:
IDs available at the Smartvatten API:
ID: The ID is assigned when a Smartvatten device is linked to a premise and remains unchanged thereafter. Typically, this ID matches the Meter Serial. If the Meter Serial is unavailable, the Device ID is used instead. It is not recommended to use this as the primary identifier when building the integration.
Device ID: This is the unique identification number for the Smartvatten device. It remains constant unless the physical Smartvatten device is replaced. We recommend using the Device ID as the primary identifier.
Meter Serial: This refers exclusively to the serial number of the water meter. It should not be used for any other purpose. The customer is obliged to provide the meter serial numbers to Smartvatten. Only Smartvatten can add or edit this information.
Custom ID: As the name suggests, this is a customizable identification number for each water meter, intended for use by customers or partners for their own purposes. Customers can modify this ID in the Smartvatten HUB.
External ID: This serves as an identification number for the premise within a customer or partner's system or platform. This is particularly useful when customers or partners utilize building identification numbers within their own platforms. Only Smartvatten can add or edit this information.
When utilizing the Smartvatten API, up-to-date list of the meters is always available at the /data/meters endpoint. When integrating to Smartvatten API, it is highly recommended to query this endpoint regularly, e.g. weekly, to keep up to the possible changes in the IDs.