Thema "Re: Betreff: Returns from an API request change order." in Getting started programming with the Viessmann API

Returns from an API request change order.

JueBag — Fri, 02 Jul 2021 10:55:14 GMT

I'm using the (new) API for a couple of days now with such a request:

"https://api.viessmann.com/iot/v1/equipment/installations/"+ installationID +"/gateways/" +gatewaySerial + "/devices/0/features?regex=heating.(sensors.temperature.outside%7Cdhw.(oneTimeCharge%7Csensors.temperature.hotWaterStorage%7Cpumps.circulation))%7Cventilation.operating.programs.active"

Why does the order of data entries in the return change? ( That happened this morning July 2nd between 03:00 and 11:00 UTC +2).

The sequence in the returned string was and still is not inline with the request, also the number of data entries is 5 instead of 4.

Betreff: Returns from an API request change order.

CustomerCareMichael — Mon, 05 Jul 2021 15:00:12 GMT

Hi @JueBag,

could you please share the response that you receive from the request?

In general, my first assumption is that the feature request is not accounting for the order of the features. To have a more robust implementation, I would recommend anaylsing feature names instead of the order of the features.

However, I will check with the development teams to make sure, how the device features is ordered within the response.

Betreff: Returns from an API request change order.

JueBag — Mon, 05 Jul 2021 16:05:00 GMT

@CustomerCareMichael Thanks for the reply.

My actually used request in JavaScript is.

var headers = [];
headers["Authorization"] = "Bearer "+ token;
var url ="https://api.viessmann.com/iot/v1/equipment/installations/"+ installationID +"/gateways/" +gatewaySerial + "/devices/0/features?regex=heating.(sensors.temperature.outside%7Cdhw.(oneTimeCharge%7Csensors.temperature.hotWaterStorage%7Cpumps.circulation))%7Cventilation.operating.(programs.active)";
var returnvalue = HTTP.sendHttpGetRequest(url, headers, 10*1000);

returnvalue = JSON.parse(returnvalue);

Yes, that is a request for 5 data-points, so the number is and was correct.

I would have expected the order:

Outside Temperature
OneTimeCharge
HotWaterStorageTemp
HotWaterCirculationPump
VentilationProgtramsActive

The return I'm getting actually is:

( see attached file API Return.pdf).

The order in there is

Outside Temperature
HotWaterStarageTemp
HotWaterCirculationPump
VentilationProgtramsActive
OneTimeCharge

As for the actual usage, I changed my code in order to evaluate each JSON array element by feature.

Re: Betreff: Returns from an API request change order.

CustomerCareMichael — Fri, 13 Aug 2021 12:20:03 GMT

@JueBag for completeness: There is no defined order in the features within the response. So you need to evaluate the arrays in the JSON like you already are doing.