Skip to content

Latest commit

 

History

History
102 lines (65 loc) · 2.77 KB

KioskIotApi.md

File metadata and controls

102 lines (65 loc) · 2.77 KB

Flipdish.KioskIotApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
getKioskIotConnection POST /api/v1.0/kioskiot/connect
queryTelemetrySeries POST /api/v1.0/{appId}/kioskiot/timeseries/query

getKioskIotConnection

RestApiResultKioskIotConnectionParameters getKioskIotConnection()

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.KioskIotApi();
apiInstance.getKioskIotConnection((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

RestApiResultKioskIotConnectionParameters

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace

queryTelemetrySeries

RestApiResultTelemetrySeriesResult queryTelemetrySeries(appId, queryParams)

Example

import Flipdish from '@flipdish/api-client-javascript';
let defaultClient = Flipdish.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new Flipdish.KioskIotApi();
let appId = "appId_example"; // String | 
let queryParams = new Flipdish.TelemetrySeriesQueryParameters(); // TelemetrySeriesQueryParameters | 
apiInstance.queryTelemetrySeries(appId, queryParams, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
appId String
queryParams TelemetrySeriesQueryParameters

Return type

RestApiResultTelemetrySeriesResult

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml, Data, Message, ErrorCode, StackTrace