Requests

Detailed information on how to invoke the API is available in the specification section.

For Sandbox environment, several MPxNs are available to test the following endpoints (see Sandbox MPxNs).

Retrieve Consented MPxNs

Customer API resource that allow a customer to obtain a list of all his consented properties.

Endpoint GET Retrieve-Consented-MPxNs

This sandbox endpoint presents the same definition and behaviour of the live GET Retrieve-Consented-MPxNs endpoint (see Retrieve Consented MPxNs).

The validations described in the Authentication section will apply.

Retrieve Available Utilities

Customer API resource that allow a customer to obtain a list of the utilities (electricity and/or gas) with associated smart meters in one of his consented properties.

In the Sandbox environment, several MPxNs will be available to test the Consent process (see Sandbox MPxNs).

Endpoint GET Retrieve-Available-Utilities

This sandbox endpoint presents the same definition and behaviour of the live GET Retrieve-Available-Utilities endpoint (see Retrieve Available Utilities).

The validations described in the Authentication section will apply.

Retrieve Reading Types

Customer API resource that allow a customer to obtain a list of types of data (consumption, production, tariff) available for a specific utility (electricity or gas) in one of his consented properties.

Endpoint GET Retrieve-Reading-Types

This sandbox endpoint presents the same definition and behaviour of the live GET Retrieve-Reading-Types endpoint (see Retrieve Reading Types).

The validations described in the Authentication section will apply.

Set Meter Update Frequency

This sandbox endpoint presents the same definition and behaviour of the live PUT set-meter-update-frequency endpoint (see Set meter update frequency).

The validations described in the Authentication section will apply.

Retrieve MPxN availability

Customer API resource that allow a customer to verify if a HAN, identified by one of its MPxNs, and its Devices are accessible through one of the SMSOs (Secure or DCC).

In the Sandbox environment, several MPxNs will be available to test the Consent process (see Sandbox MPxNs).

Endpoint GET Retrieve-MPxN-availability

This sandbox endpoint presents the same definition and behaviour of the live GET Retrieve-MPxN-availability endpoint (see Retrieve MPxN availability).

The validations described in the Authentication section will apply.

Retrieve Data Update Frequencies

Customer API resource that allow a customer to obtain the values of the data update frequency for the utility types in one of their consented HANs, specifically, the frequency of update of the import and export data for electricity meters and import data for gas meters.

In the Sandbox environment, several MPxNs will be available to test the Consent process (see Sandbox MPxNs).

Endpoint GET Retrieve-Data-Update-Frequencies

This sandbox endpoint presents the same definition and behaviour of the live GET Retrieve-Data-Update-Frequencies endpoint (see Retrieve Data Update Frequencies).

The validations described in the Authentication section will apply.

Retrieve Data for Reading Type

Customer API resource that allow a customer to obtain data (consumption, production or tariff) available for a specific utility (electricity or gas) in one of his consented properties.

In the Sandbox environment, several MPxNs will be available to test the Consent process (see Sandbox MPxNs).

Endpoint GET Retrieve-Data-for-Reading-Type

This sandbox endpoint presents the same definition and behaviour of the live GET Retrieve-Data-for-Reading-Type endpoint (see Retrieve Data for Reading Type).

The validations described in the Authentication section will apply.

Set Defaults

Customer API resource that allow a customer to set their defaults in consented HANs for getting historic data and frequency of update of data for the electricity and gas meters.

Endpoint PUT Set-Defaults

This sandbox endpoint presents the same definition and behaviour of the live PUT Set-Defaults endpoint (see Set Defaults).

The validations described in the Authentication section will apply.

Reset Update Frequencies for all consented HANs

Customer API resource that allow a customer to set their defaults and force the change of update frequencies (for electricity and gas meters) for all the already consented HANs.

Endpoint PUT Reset-Update-Frequencies-for-all-consented-HANs

This sandbox endpoint presents the same definition and behaviour of the live PUT Reset-Update-Frequencies-for-all-consented-HANs (see Reset Update Frequencies for all consented HANs).

The validations described in the Authentication section will apply.

Read Inventory

Customer API resource that returns DCC’s device inventory (device data and WAN matrix) associated with the given MPxN, Device ID or UPRN by searching n3rgy data database. When the information is outdated the API will update it against the DCC inventory.

The request will return an URI in order to access the data in JSON format.

Endpoint POST Read-Inventory

This sandbox endpoint presents the same definition and behaviour of the live POST Read-Inventory (see Read Inventory), except for the check-firmware parameter which will not work and returns an error.

The validations described in the Authentication section will apply.

In the Sandbox environment, several mpxns/uprns/deviceIds are available to test the read inventory process (see Sandbox Read Inventory).