Thema "Betreff: HowTo send a command via the API ? Or what is the correct syntax?" in Getting started programming with the Viessmann API

HowTo send a command via the API ? Or what is the correct syntax?

JueBag — Fri, 25 Jun 2021 17:13:55 GMT

I'm trying to send a command via the API, for example I want to activate the feature "oneTimeCharge".

I tried to send such POST request:

https://api.viessmann-platform.io/iot/v1/equipment/installations/My-Installation_ID/gateways/My-Gateway_Serial/devices/0/features/heating.dhw.oneTimeCharge/commands/activate

Sending the above with a valid Bearer Token does return:

{

"viErrorId": "req-06063841ce214195b3fa08643a51cd60",

"statusCode": 422,

"errorType": "VALIDATION_ERROR",

"message": "VALIDATION_ERROR",

"validationErrors": [

{

"path": [

"commandBody"

"type": "any.invalid",

"message": "invalid value, most likely wrong format"

}

"extendedPayload": {

"commandBody": "EMPTY_MODEL"

}

or with the header Content-Type="application/x-www-form-urlencoded"

{

"viErrorId": "req-25befbaad52e473c921fe9a0e8439be7",

"statusCode": 500,

"errorType": "INTERNAL_ERROR",

"message": "Internal server error"

}

Where is my mistake?

Betreff: HowTo send a command via the API ? Or what is the correct syntax?

andreas13 — Sat, 26 Jun 2021 18:57:23 GMT

Did you use POST and "Content-Type: application/json"? In this case params is "{}" of course.

Betreff: HowTo send a command via the API ? Or what is the correct syntax?

JueBag — Sun, 27 Jun 2021 09:22:02 GMT

Thanks for the answer.

I did use POST and tried it also with the header Content-Type application/json.

So far I did not put in any PARAMS for the POST request, using just the url as posted above.

The result is always as the above posted (first) error message.

I'm using POSTMAN to test-send such messages.

Betreff: HowTo send a command via the API ? Or what is the correct syntax?

phildaub23 — Mon, 28 Jun 2021 06:54:44 GMT

You need to send a json request payload with every command. This is also true for commands with "empty" parameters, so you need to send just an empty json object. Also, make sure to have the correct request payload mime type, i.e. the "Content-Type" header has to be "application/json". Postman sets this header automatically for you if you enter a request payload and select "raw" and "json" from the two dropdown boxes like shown in the attached screenshot:

Betreff: HowTo send a command via the API ? Or what is the correct syntax?

JueBag — Mon, 05 Jul 2021 15:39:29 GMT

The problem was solved by @phildaub23 while the Developer part of the forum was created!

I used a.) a wrong URL (https://api.viessmann-platform.io...instead of https://api.viessmann.com..

and b.) missed the empty body ("{}") part.

In JavaScript that looks like.

headers["Authorization"] = "Bearer "+ token;
var url ="https://api.viessmann.com/iot/v1/equipment/installations/"+ installationID +"/gateways/" +gatewaySerial + "/devices/0/features/heating.dhw.oneTimeCharge/commands/activate";
//logger.info("url: {}", url);
var returnvalue = HTTP.sendHttpPostRequest(url,"application/json", "{}",headers,2*1000);