End-user data
Unique & mandatory data
The following minimum information need to always be specified and be unique across the NET2GRID INSIGHT Platform in order to create an account:
labelpartner
(will be associated with all the end-user's installations if not overwritten in the installation definition.labelpartner
is set & configured on Platform level and applies to account and installation level.)- Customer_info object:
Email address
(unique per account)External account id
(unique account identifier)- contant_info object:
firstname
lastname
- Installation_info object:
External installation id
(unique installation identifier)
Data that unlocks functionality
postal_code
&country_code
, if available, automatically enable:- the NET2GRID Weather API (which is utilized to enrich the accuracy of the space heating disaggregation algorithms of households),
- as well as the Solar production estimation.
street_no
&house_no
(and optionally thesuffix
) are required for Customers & end-users utilizing the EDSN datahub integration.- service_type is an important field on installation level provisioning that specifies the nature of the EnergyAI & services (availability of specific functionalities & features). If not set,
labelpartner
configuration & the defaultservice type
will be used.
If the service type is BR-LR-* or BR-HR-* (meaning that the data is loaded in batches via a datahub integration or via file exchange), then
external_meter_id
should always be provided. If it has not been provided, then a relevant error, along with a message will be thrown by the Account Management API.
Other data
meter_input_method
: The input type of the data to the NET2GRID Insight Platform which may have one of the 2 following values:DEVICE
: When hardware is used to report data.IMPORT
: When file imports, a datahub integration or anything else is in place where NET2GRID Insight Platform gets data from, in batches.
create_verified_user
:- It is recommended that this flag is set to
false
in order for an end-user to verify their e-mail later on during the registration process via the CE-API. - By setting this flag to
true
then the e-mail verification process can be skipped; this is the recommended approach only for e-mails that have already been verified to the customers' CRM systems.
- It is recommended that this flag is set to
SSO Flow prerequisite
In order to enable the Introspection SSO flow through the CE-API, the external_authentication_provider_id
, which is on account level, should be provided during the provisioning phase.
Updated 10 months ago