SIWIAT Out App – JSON

API and SDK Documentation

Version 1.0.0.

This is a description for the Out App „JSON“ for the SIWIAT App-Box. This specification complies with the JSON App version 1.0.3 (Oct 2016)

Channels

getChannels

Get all available channels of the SIWIAT App-Box

/getchannels
Usage and SDK Samples
curl -X get "http://[IP-ADDRESS-OF-YOUR-APP-BOX]/websites/ab/index.php/json/api/getchannels"
var  = require('');

var api = new .ChannelsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChannelsResponse(callback);
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\ChannelsApi();

try {
    $result = $api_instance->getChannelsResponse();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChannelsApi->getChannelsResponse: ', $e->getMessage(), PHP_EOL;
}
Parameters
Response

Status: 200 – Success

Schema:

Values

getValues

Get channel values by the {valueid(s)}

/getvalues
Usage and SDK Samples
curl -X get "http://[IP-ADDRESS-OF-YOUR-APP-BOX]/websites/ab/index.php/json/api/getvalues?valueids=91-1"
var  = require('');

var api = new .ValuesApi()

var valueids = valueids_example; // {String} The value id of a channel


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getValuesResponse(valueids, callback);
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new io.swagger.client\Api\ValuesApi();
$valueids = valueids_example; // String | The value id of a channel

try {
    $result = $api_instance->getValuesResponse($valueids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValuesApi->getValuesResponse: ', $e->getMessage(), PHP_EOL;
}
Parameters
NameDescription
valueid(s)string
The value id of a channel or more value ids seperated by ‚,‘.
Required

 

Response

Status: 200 – Success

Schema:



Fragen? Wir helfen gerne weiter!Zum Kontaktformular