General Information

eKoral Open API gives user full access of eKoral products. API implements OAuth 2.0 grant type client_credentials. Please contact support@ekoral.io to assign a client credentials for your account.

Usage and Example

A pre-requirements are eKoral member account and a controller (eK Core, eK Lite or eK Hub) owned or invited for the account. The calling sequence is:

Get an access token. We implement OAuth 2.0 client credentials authentication method.
Get sid (session id) by calling authenticate API. An eKoral member email and password are required.
With access token and sid, you are free to use the reset of APIs.

Examples

Get access toke

To receive an access token API, user has to POST grant_type=client_credentials with authorization header which is a base64 encoded string from "email:client_credentials"

Javascript example, if email is "fred@gmail.com" and client credential is "jC9TYr"

> Buffer.from("fred@gmail.com:jC9TYr").toString("base64")
'ZnJlZEBnbWFpbC5jb206akM5VFly'

API example

% curl https://api.ekoral.io/token -X POST \
  -d "grant_type=client_credentials" \
  -H "Authorization: Basic ZnJlZEBnbWFpbC5jb206akM5VFly" \
  -H "Content-Type: application/x-www-form-urlencoded"

{
  ""access_token": "51ab376f2355d3358f0881e65026a584adf88d0d",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": true
}

Authenticate

Authenticate is eKoral member logon using email and password hashed by SHA256. Bearer token in Authorization header is the access token.

Javascript example, hash password "jC9TYr"

> crypto.createHash('sha256').update('jC9TYr', 'utf8').digest('hex')
'02dc4b1a749034688526781a7edbc9a4c903bf830d70ae3fc34d41a027603743'

API example

% curl https://api.ekoral.io -X POST \
  -d '{
        "parm": {
          "email": "fred@gmail.com",
          "password": "02dc4b1a749034688526781a7edbc9a4c903bf830d70ae3fc34d41a027603743"
        },
        "name": "authenticate",
        "version": 1
      }' \
  -H "Authorization: Bearer 51ab376f2355d3358f0881e65026a584adf88d0d" \ 
  -H "Content-Type: application/json"


{
  "result": "success",
  "data": {
    "email": "fred@gmail.com",
    "first_name": "Fred",
    "last_name": "While",
    "gender": "male",
    "locale": "en_US",
    "sid": "uxITN_UV-KupgSsvm5KXtZHEh2bY7gr2"
  }
}

Read history raw data

get_server_readings read history raw data from server. History data has 3 data frequencies: 5 minutes, 30 minutes and 60 minutes. Bearer token in Authorization header is the access token. email and sid are mandatory for the API.

API example

% curl https://api.ekoral.io -X POST \
  -d '{
        "name": "get_server_readings",
        "sn": "AH8AAAF141",
        "email": "fred@gmail.com",
        "sid": "uxITN_UV-KupgSsvm5KXtZHEh2bY7gr2",
        "parm": {
            "collection": "aggregate_reading_every_5_minutes",
            "query": {
              "sn": "AH8AAAF141",
              "created": {
                "$gt": 1540874400011
              }
            },
            "sort": {
              "created": -1
            },
            "limit": 10,
            "skip": 0
        }
      }' \
  -H "Authorization: Bearer 51ab376f2355d3358f0881e65026a584adf88d0d" \ 
  -H "Content-Type: application/json"


{
  "result": "success",
  "reason": null,
  "data": [
    {
      "sn": "AH8AAAF141",
      "created": 1594371602087,
      "devices": [
        {
          "id": "1",
          "name": "Water Level 1",
          "type": "WaterLevel",
          "characteristic": "UltrasoundLevel",
          "value": -0.0884538615091337,
          "value1": 17.73289989476579,
          "values": {
            "distance": -0.0884538615091337
          }
        },
        {
          "id": "2",
          "name": "Water Level 2",
          "type": "WaterLevel",
          "characteristic": "UltrasoundLevel",
          "value": null,
          "value1": 16.642859851445504,
          "values": {
            "distance": null
          }
        },
        {
          "id": "3",
          "name": "pH",
          "type": "pH",
          "characteristic": "pH",
          "value": 8.05648950240619,
          "value1": 2523.5595703125,
          "values": {}
        },
        {
          "id": "4",
          "name": "ORP",
          "type": "ORP",
          "characteristic": "ORP",
          "value": 289.1485776124305,
          "value1": 2921.142578125,
          "values": {}
        },
        ...
      ]
    }
  ]
}

Read history aggregated data

API get_server_readings is to get history readings from server. Bearer token in Authorization header is the access token. email and sid are mandatory for the API.

API example

% curl https://api.ekoral.io -X POST \
  -d '{
        "name": "get_server_readings",
        "sn": "AH8AAAF141",
        "email": "fred@gmail.com",
        "sid": "uxITN_UV-KupgSsvm5KXtZHEh2bY7gr2",
        "parm": {
          "sn": "AH8AAAF141",
          "device_id": [
            1,
            3
          ],
          "interval": {
            "unit": "hours",
            "length": 1
          },
          "past": {
            "unit": "hours",
            "length": 24
          }
        }
      }' \
  -H "Authorization: Bearer 51ab376f2355d3358f0881e65026a584adf88d0d" \ 
  -H "Content-Type: application/json"


{
  "result": "success",
  "reason": null,
  "data": [
    {
      "device_id": "1",
      "type": "WaterLevel",
      "characteristic": "UltrasoundLevel",
      "values": [
        {
          "time": 1594270800000,
          "value": -1.699530096651472,
          "value1": 17.73289989476579,
          "svalue": ""
        }
      ]
    },
    ...
    {
      "device_id": "3",
      "type": "pH",
      "characteristic": "pH",
      "values": [
        {
          "time": 1594270800000,
          "value": 8.116641614029739,
          "value1": 2520.1416015625,
          "svalue": ""
        }
      ]
    }
    ...
  ]
}

Get device details in the controller.

API get_device is to get device details from controller. Bearer token in Authorization header is the access token. email and sid are mandatory for the API.

API example

% curl https://api.ekoral.io -X POST \
  -d '{
        "name": "get_device",
        "sn": "AH8AAAF141",
        "email": "fred@gmail.com",
        "sid": "uxITN_UV-KupgSsvm5KXtZHEh2bY7gr2"
      }' \
    -H "Authorization: Bearer 51ab376f2355d3358f0881e65026a584adf88d0d" \ 
    -H "Content-Type: application/json"


{
  "result": "success",
  "request": null,
  "errors": null,
  "data": {
    "devices": [
      {
        "module": "waterlevel1",
        "index": 1,
        "type": "WaterLevel",
        "characteristic": "UltrasoundLevel",
        "value": -1.9513683045849284,
        "value1": 17.73289989476579,
        "svalue": "",
        "values": {
          "distance": -1.9513683045849284
        },
        "supplement": {
          "timestamp": 1580434360799
        },
        "path": "GPIO;68;66",
        "name": "Water Level 1",
        "icon": "",
        "enable": true,
        "start_date": {},
        "boundaries": [],
        "created": 1501135705909,
        "updated": 1594357780052,
        "id": "1",
        "auto": true
      }
    ]
  },
  "rpc_version": 1,
  "eko_version": "2020.7.1",
  "index": 489
}

Application type

Application type means the service provider of eKoral services. They are:

Member application:
The application is eKoral member APIs.
Eko application:
The application is APIs of eK Core, eK Lite and eK Hub.
Peripheral application:
The application is APIs of eK Doser and eK Module.

API List and Scope

Member API (type member)

access
config
- change_password
- close_member
- configure_invitation
- configure_miniboards
- configure_myminiboard
- configure_sns
- configure_sns_setting
- forget_password
- quit_invitation
- signup_contact_email
- signup
- update_member
- chat
- signup
- update_member
  eK Core, eK Hub API (type eko)
access
config
control
- control_device
- control_plan
- diagnose_network
- diagnose_system
  eK Doser, eK Module API (type peripheral)
config
control
- control_dosing
- p_reboot
access

authenticate Schema

http://ekoral.io/schema/authenticate.json

Authenticate eKoral member by email, password, or 3rd party authentication (Facebook, Apple)

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	authenticate.schema.json

authenticate Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	authenticate (this schema)
parm	`object`	Required	No	authenticate (this schema)
version	`const`	Optional	No	authenticate (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"authenticate"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`access_token`	string	Optional
`detail`	object	Optional
`email`		Optional
`first_name`	string	Optional
`identifier`	string,null	Optional
`last_name`	string	Optional
`mobile`	string	Optional
`openid`	string	Optional
`password`	string	Optional
`source`	string	Optional

access_token

access_token

is optional
type: string

access_token Type

string

detail

detail

is optional
type: object

detail Type

object with following properties:

Property	Type	Required

email

email

is optional
type: complex

email Type

Any following options needs to be fulfilled.

Option 1

string

format: email – email address (according to RFC 5322, section 3.4.1)

Option 2

first_name

first_name

is optional
type: string

first_name Type

string

identifier

User identifier in database

identifier

is optional
type: string

identifier Type

string, nullable

last_name

last_name

is optional
type: string

last_name Type

string

mobile

mobile

is optional
type: string

mobile Type

string

openid

openid

is optional
type: string

openid Type

string

password

SHA-256 hash value of password

password

is optional
type: string

password Type

string

source

source

is optional
type: enum

The value of this property must be equal to one of the known values below.

source Known Values

Value	Description
`facebook`
`qq`
`apple`

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

check_app_update Schema

http://ekoral.io/schema/check_app_update.json

Check if new app version is available for update

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	check_app_update.schema.json

check_app_update Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	check_app_update (this schema)
parm	`object`	Required	No	check_app_update (this schema)
version	`const`	Optional	No	check_app_update (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"check_app_update"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`application`	string	Required
`version`	string	Required

application

application id

application

is required
type: string

application Type

string

version

version

is required
type: string

version Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_invitation Schema

http://ekoral.io/schema/get_invitation.json

get_invitation

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_invitation.schema.json

get_invitation Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_invitation (this schema)
parm	`object`	Required	No	get_invitation (this schema)
sid	`string`	Required	No	get_invitation (this schema)
version	`const`	Optional	No	get_invitation (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_invitation"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`sn`	string,array	Optional

sn

sn

is optional
type: multiple

sn Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_miniboards Schema

http://ekoral.io/schema/get_miniboards.json

Get all eK Core or eK Doser, for those are owned or invited by then authenticate member

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_miniboards.schema.json

get_miniboards Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_miniboards (this schema)
sid	`string`	Required	No	get_miniboards (this schema)
version	`const`	Required	No	get_miniboards (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_miniboards"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is required
type: const
defined in this schema

The value of this property must be equal to:

get_reading_history Schema

http://ekoral.io/schema/get_reading_history.json

Read history raw data from server. History data has 3 data frequencies: 5 minutes, 30 minutes and 60 minutes

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_reading_history.schema.json

get_reading_history Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_reading_history (this schema)
parm	`object`	Required	No	get_reading_history (this schema)
sid	`string`	Required	No	get_reading_history (this schema)
version	`const`	Optional	No	get_reading_history (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_reading_history"

parm

parameter object

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`collection`	string	Required
`limit`	integer	Optional
`query`	object	Required
`skip`	integer	Optional
`sort`	object	Optional

collection

data frequency

collection

is required
type: enum

The value of this property must be equal to one of the known values below.

collection Known Values

Value	Description
`aggregate_reading_every_5_minutes`
`aggregate_reading_every_30_minutes`
`aggregate_reading_every_60_minutes`

limit

limits the number of response objects

limit

is optional
type: integer

limit Type

integer

query

specify sn number

query

is required
type: object

query Type

object with following properties:

Property	Type	Required
`sn`	string	Required

sn

Serial number

sn

is required
type: string

sn Type

string

skip

starting point of the results set

skip

is optional
type: integer

skip Type

integer

sort

Specify response data sorting attribute and order.
for example: {created: 1}, 1 or -1 to specify an ascending or descending

sort

is optional
type: object

sort Type

object with following properties:

Property	Type	Required

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_server_readings Schema

http://ekoral.io/schema/get_server_readings.json

get_server_readings

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_server_readings.schema.json

get_server_readings Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_server_readings (this schema)
parm	`object`	Required	No	get_server_readings (this schema)
sid	`string`	Required	No	get_server_readings (this schema)
version	`const`	Optional	No	get_server_readings (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_server_readings"

parm

parameter object

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`device_id`	integer,string,array	Optional
`from_timestamp`	integer	Optional
`interval`	object	Optional
`past`	object	Optional
`sn`	string	Optional
`to_timestamp`	integer	Optional
`type`	string,array	Optional

device_id

device id or array of device ids

device_id

is optional
type: multiple

device_id Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

from_timestamp

starting from timestamp

from_timestamp

is optional
type: integer

from_timestamp Type

integer

minimum value: 1

interval

data aggregation interval in unit minutes, hours or days

interval

is optional
type: object

interval Type

object with following properties:

Property	Type	Required
`length`	integer	Required
`unit`	string	Required

length

length

is required
type: integer

length Type

integer

minimum value: 0

unit

unit

is required
type: enum

The value of this property must be equal to one of the known values below.

unit Known Values

Value	Description
`minutes`
`hours`
`days`

past

past length and unit

past

is optional
type: object

past Type

object with following properties:

Property	Type	Required
`length`	integer	Required
`unit`	string	Required

length

length specify past length

length

is required
type: integer

length Type

integer

minimum value: 0

unit

unit specify past unit in minutes, hours or days

unit

is required
type: enum

The value of this property must be equal to one of the known values below.

unit Known Values

Value	Description
`minutes`
`hours`
`days`

sn

Serial number

sn

is optional
type: string

sn Type

string

to_timestamp

up to timestamp

to_timestamp

is optional
type: integer

to_timestamp Type

integer

minimum value: 1

type

device type

type

is optional
type: multiple

type Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_sns_history Schema

http://ekoral.io/schema/get_sns_history.json

get_sns_history

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_sns_history.schema.json

get_sns_history Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_sns_history (this schema)
parm	`object`	Required	No	get_sns_history (this schema)
sid	`string`	Required	No	get_sns_history (this schema)
version	`const`	Optional	No	get_sns_history (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_sns_history"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`limit`	integer	Required
`query`	object	Optional
`skip`	integer	Optional
`sort`	object	Optional

limit

limit

is required
type: integer

limit Type

integer

query

query

is optional
type: object

query Type

object with following properties:

Property	Type	Required

skip

skip

is optional
type: integer

skip Type

integer

sort

sort

is optional
type: object

sort Type

object with following properties:

Property	Type	Required

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_sns_setting Schema

http://ekoral.io/schema/get_sns_setting.json

get_sns_setting

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_sns_setting.schema.json

get_sns_setting Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_sns_setting (this schema)
parm	`object`	Required	No	get_sns_setting (this schema)
sid	`string`	Required	No	get_sns_setting (this schema)
version	`const`	Optional	No	get_sns_setting (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_sns_setting"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`sn`	string	Required

sn

sn

is required
type: string

sn Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_species Schema

http://ekoral.io/schema/get_species.json

get_species

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_species.schema.json

get_species Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_species (this schema)
parm	`object`	Required	No	get_species (this schema)
sid	`string`	Required	No	get_species (this schema)
version	`const`	Optional	No	get_species (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_species"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`conditions`	object	Required
`limit`	integer	Optional
`projection`	object	Optional
`skip`	integer	Optional
`sort`	object	Optional
`type`	string	Required

conditions

conditions

is required
type: object

conditions Type

object with following properties:

Property	Type	Required
`care_level`	string	Optional
`classId`	integer	Optional
`common_name`	string	Optional
`diet`	string	Optional
`lighting`	string	Optional
`minimum_tank_size`	integer	Optional
`reef_compatible`	string	Optional
`scientific_name`	string	Optional
`temperament`	string	Optional
`waterflow`	string	Optional

care_level

care_level

is optional
type: string

care_level Type

string

classId

classId

is optional
type: integer

classId Type

integer

common_name

common_name

is optional
type: string

common_name Type

string

diet

diet

is optional
type: string

diet Type

string

lighting

lighting

is optional
type: string

lighting Type

string

minimum_tank_size

minimum_tank_size

is optional
type: integer

minimum_tank_size Type

integer

reef_compatible

reef_compatible

is optional
type: string

reef_compatible Type

string

scientific_name

scientific_name

is optional
type: string

scientific_name Type

string

temperament

temperament

is optional
type: string

temperament Type

string

waterflow

waterflow

is optional
type: string

waterflow Type

string

limit

limit

is optional
type: integer

limit Type

integer

projection

projection

is optional
type: object

projection Type

object with following properties:

Property	Type	Required

skip

skip

is optional
type: integer

skip Type

integer

sort

sort

is optional
type: object

sort Type

object with following properties:

Property	Type	Required

type

type

is required
type: string

type Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

logoff Schema

http://ekoral.io/schema/logoff.json

logoff

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	logoff.schema.json

logoff Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	logoff (this schema)
sid	`string`	Required	No	logoff (this schema)
version	`const`	Optional	No	logoff (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"logoff"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

validate_session Schema

http://ekoral.io/schema/validate_session.json

Validate session

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	validate_session.schema.json

validate_session Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	validate_session (this schema)
parm	`object`	Required	No	validate_session (this schema)
version	`const`	Optional	No	validate_session (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"validate_session"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`email`	string	Required
`info`	object	Optional
`sid`	string	Required

email

email

is required
type: string

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

info

info

is optional
type: object

info Type

object with following properties:

Property	Type	Required

sid

sid

is required
type: string

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_chats Schema

http://ekoral.io/schema/get_chats.json

get_chats

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_chats.schema.json

get_chats Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_chats (this schema)
parm	`object`	Required	No	get_chats (this schema)
sid	`string`	Required	No	get_chats (this schema)
version	`const`	Optional	No	get_chats (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_chats"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`past`	integer	Optional
`sn`	string	Required

past

past histories in seconds, 0 mean all history

past

is optional
type: integer

past Type

integer

sn

sn

is required
type: string

sn Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

note Schema

http://ekoral.io/schema/note.json

note

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	note.schema.json

note Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	note (this schema)
parm	`object`	Required	No	note (this schema)
sid	`string`	Required	No	note (this schema)
version	`const`	Optional	No	note (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"note"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`action`	string	Required
`note`		Required

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`create`
`update`
`delete`

note

note

is required
type: complex

note Type

One of the following conditions need to be fulfilled.

Condition 1

object with following properties:

Property	Type	Required
`desc`	string	Required
`photos`	array	Required
`sn`	string	Required
`timestamp`	integer	Required

desc

description

desc

is required
type: string

desc Type

string

photos

photos

is required
type: string[]

photos Type

Array type: string[]

All items must be of the type: string

sn

sn

is required
type: string

sn Type

string

timestamp

timestamp

is required
type: integer

timestamp Type

integer

Condition 2

object with following properties:

Property	Type	Required
`_id`		Required

_id

_id

is required
type: complex

_id Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

note_photo Schema

http://ekoral.io/schema/note_photo.json

note_photo

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	note_photo.schema.json

note_photo Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	note_photo (this schema)
parm	`object`	Required	No	note_photo (this schema)
sid	`string`	Required	No	note_photo (this schema)
version	`const`	Optional	No	note_photo (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"note_photo"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`action`	string	Required
`note_photo`		Required

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`create`
`update`
`delete`

note_photo

note_photo

is required
type: complex

note_photo Type

One of the following conditions need to be fulfilled.

Condition 1

object with following properties:

Property	Type	Required
`image`	string	Required
`sn`	string	Required

image

base64 encode image, for example: data:image/jpg;base64,/9j//gAQT...

image

is required
type: string

image Type

string

sn

sn

is required
type: string

sn Type

string

Condition 2

object with following properties:

Property	Type	Required
`_id`		Required

_id

_id

is required
type: complex

_id Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_server_readings Schema

http://ekoral.io/schema/get_server_readings.json

get_server_readings

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_server_readings.schema.json

get_server_readings Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	get_server_readings (this schema)
parm	`object`	Required	No	get_server_readings (this schema)
sid	`string`	Required	No	get_server_readings (this schema)
version	`const`	Optional	No	get_server_readings (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_server_readings"

parm

parameter object

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`device_id`	integer,string,array	Optional
`from_timestamp`	integer	Optional
`interval`	object	Optional
`past`	object	Optional
`sn`	string	Optional
`to_timestamp`	integer	Optional
`type`	string,array	Optional

device_id

device id or array of device ids

device_id

is optional
type: multiple

device_id Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

from_timestamp

starting from timestamp

from_timestamp

is optional
type: integer

from_timestamp Type

integer

minimum value: 1

interval

data aggregation interval in unit minutes, hours or days

interval

is optional
type: object

interval Type

object with following properties:

Property	Type	Required
`length`	integer	Required
`unit`	string	Required

length

length

is required
type: integer

length Type

integer

minimum value: 0

unit

unit

is required
type: enum

The value of this property must be equal to one of the known values below.

unit Known Values

Value	Description
`minutes`
`hours`
`days`

past

past length and unit

past

is optional
type: object

past Type

object with following properties:

Property	Type	Required
`length`	integer	Required
`unit`	string	Required

length

length specify past length

length

is required
type: integer

length Type

integer

minimum value: 0

unit

unit specify past unit in minutes, hours or days

unit

is required
type: enum

The value of this property must be equal to one of the known values below.

unit Known Values

Value	Description
`minutes`
`hours`
`days`

sn

Serial number

sn

is optional
type: string

sn Type

string

to_timestamp

up to timestamp

to_timestamp

is optional
type: integer

to_timestamp Type

integer

minimum value: 1

type

device type

type

is optional
type: multiple

type Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

validate_session Schema

http://ekoral.io/schema/validate_session.json

Validate session

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	validate_session.schema.json

validate_session Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	validate_session (this schema)
parm	`object`	Required	No	validate_session (this schema)
version	`const`	Optional	No	validate_session (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"validate_session"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`email`	string	Required
`info`	object	Optional
`sid`	string	Required

email

email

is required
type: string

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

info

info

is optional
type: object

info Type

object with following properties:

Property	Type	Required

sid

sid

is required
type: string

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

change_password Schema

http://ekoral.io/schema/change_password.json

change_password

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	change_password.schema.json

change_password Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	change_password (this schema)
parm	`object`	Required	No	change_password (this schema)
sid	`string`	Optional	No	change_password (this schema)
version	`const`	Optional	No	change_password (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"change_password"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`new_password`	string	Required
`old_password`	string	Required

new_password

new_password

is required
type: string

new_password Type

string

old_password

old_password

is required
type: string

old_password Type

string

sid

session id

sid

is optional
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

close_member Schema

http://ekoral.io/schema/close_member.json

Close member account

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	close_member.schema.json

close_member Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	close_member (this schema)
sid	`string`	Required	No	close_member (this schema)
version	`const`	Optional	No	close_member (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"close_member"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_invitation Schema

http://ekoral.io/schema/configure_invitation.json

Create, update, delete invitation of eK Core

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_invitation.schema.json

configure_invitation Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	configure_invitation (this schema)
parm	`object`	Required	No	configure_invitation (this schema)
sid	`string`	Required	No	configure_invitation (this schema)
version	`const`	Optional	No	configure_invitation (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_invitation"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`action`	string	Required
`email`	string	Required
`role`	object	Optional
`sn`	string	Required

action

invitation action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`grant`
`revoke`

email

eKoral member email address

email

is required
type: string

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

role

share role

role

is optional
type: object

role Type

object with following properties:

Property	Type	Required
`camera`	boolean	Optional
`level`	integer	Optional

camera

true for share camera, false for not share camera

camera

is optional
type: boolean

camera Type

boolean

level

share level, 1 is for guest who can read states and values, 2 is for supporter who can control device manually, 3 is for consultant who has all permissions except sharing

level

is optional
type: enum

The value of this property must be equal to one of the known values below.

level Known Values

Value	Description
`1`
`2`
`3`

sn

Serial number

sn

is required
type: string

sn Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_miniboards Schema

http://ekoral.io/schema/configure_miniboards.json

Update eK Core / eK Doser,
Delete eK Core / eK Doser,
Compose is to let eK Core contain eK Doser,
Decompose is to remove containment of eK Doser from eK Core

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_miniboards.schema.json

configure_miniboards Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	configure_miniboards (this schema)
parm	`object`	Required	No	configure_miniboards (this schema)
sid	`string`	Required	No	configure_miniboards (this schema)
version	`const`	Optional	No	configure_miniboards (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_miniboards"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_myminiboard Schema

http://ekoral.io/schema/configure_myminiboard.json

configure_myminiboard

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_myminiboard.schema.json

configure_myminiboard Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	configure_myminiboard (this schema)
parm	`object`	Required	No	configure_myminiboard (this schema)
sid	`string`	Required	No	configure_myminiboard (this schema)
version	`const`	Optional	No	configure_myminiboard (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_myminiboard"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`miniboard`	object	Optional

miniboard

miniboard

is optional
type: object

miniboard Type

object with following properties:

Property	Type	Required
`action`	string	Required
`name`	string	Optional
`sn`	string	Required

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`update`
`delete`

name

name

is optional
type: string

name Type

string

sn

sn

is required
type: string

sn Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_sns Schema

http://ekoral.io/schema/configure_sns.json

configure_sns

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_sns.schema.json

configure_sns Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	configure_sns (this schema)
parm	`object`	Required	No	configure_sns (this schema)
sid	`string`	Required	No	configure_sns (this schema)
version	`const`	Optional	No	configure_sns (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_sns"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`app`	string	Optional
`app_version`	string	Optional
`device_token`	string	Required
`locale`	string	Required
`onoff`	boolean	Required
`os`	string	Optional
`platform`	string	Required
`service`	string	Optional

app

app

is optional
type: enum

The value of this property must be equal to one of the known values below.

app Known Values

Value	Description
`mobile`
`ekmodule`
`mobileas`
`eklite`

app_version

app_version

is optional
type: string

app_version Type

string

device_token

device_token

is required
type: string

device_token Type

string

locale

locale

is required
type: string

locale Type

string

onoff

onoff

is required
type: boolean

onoff Type

boolean

os

os

is optional
type: string

os Type

string

platform

platform

is required
type: enum

The value of this property must be equal to one of the known values below.

platform Known Values

Value	Description
`ios`
`android`
`browser`

service

service

is optional
type: enum

The value of this property must be equal to one of the known values below.

service Known Values

Value	Description
`fcm`
`xg`

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_sns_setting Schema

http://ekoral.io/schema/configure_sns_setting.json

configure_sns_setting

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_sns_setting.schema.json

configure_sns_setting Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	configure_sns_setting (this schema)
parm	`object`	Required	No	configure_sns_setting (this schema)
sid	`string`	Required	No	configure_sns_setting (this schema)
version	`const`	Optional	No	configure_sns_setting (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_sns_setting"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`onoff`	boolean	Required
`onoffs`	array	Optional
`range`	array	Optional
`sn`	string	Required
`units`	array	Optional

onoff

onoff

is required
type: boolean

onoff Type

boolean

onoffs

onoffs

is optional
type: object[]* at least 0 items in the array

onoffs Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`name`	string	Required
`onoff`	boolean	Required

name

name

is required
type: string

name Type

string

onoff

onoff

is required
type: boolean

onoff Type

boolean

range

range

is optional
type: object[]* at least 0 items in the array

range Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`max`	number	Required
`min`	number	Required
`type`	string	Required

max

max

is required
type: number

max Type

number

min

min

is required
type: number

min Type

number

type

type

is required
type: string

type Type

string

sn

sn

is required
type: string

sn Type

string

units

units

is optional
type: object[]* at least 0 items in the array

units Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`type`	string	Required
`unit`	string	Required
`value`	string	Required

type

type

is required
type: string

type Type

string

unit

unit

is required
type: string

unit Type

string

value

value

is required
type: string

value Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

forget_password Schema

http://ekoral.io/schema/forget_password.json

forget_password

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	forget_password.schema.json

forget_password Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	forget_password (this schema)
parm	`object`	Required	No	forget_password (this schema)
version	`const`	Optional	No	forget_password (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"forget_password"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`email`	string	Required

email

email

is required
type: string

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

quit_invitation Schema

http://ekoral.io/schema/quit_invitation.json

quit_invitation

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	quit_invitation.schema.json

quit_invitation Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	quit_invitation (this schema)
parm	`object`	Required	No	quit_invitation (this schema)
sid	`string`	Required	No	quit_invitation (this schema)
version	`const`	Optional	No	quit_invitation (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"quit_invitation"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`sn`	string	Required

sn

sn

is required
type: string

sn Type

string

maximum length: 10 characters All instances must conform to this regular expression (test examples here):

^[A-Za-z0-9]+$

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

signup_contact_email Schema

http://ekoral.io/schema/signup_contact_email.json

signup_contact_email

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	signup_contact_email.schema.json

signup_contact_email Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	signup_contact_email (this schema)
parm	`object`	Required	No	signup_contact_email (this schema)
version	`const`	Optional	No	signup_contact_email (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"signup_contact_email"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`access_token`	string	Required
`contact_email`	string	Required
`email`	string	Required
`openid`	string	Required
`source`	string	Required

access_token

access_token

is required
type: string

access_token Type

string

contact_email

contact_email

is required
type: string

contact_email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

email

email

is required
type: string

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

openid

openid

is required
type: string

openid Type

string

source

source

is required
type: string

source Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

http://ekoral.io/schema/signup.json

signup

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	signup.schema.json

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	signup (this schema)
parm	`object`	Required	No	signup (this schema)
version	`const`	Optional	No	signup (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"signup"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`email`	string	Required
`first_name`	string	Optional
`gender`	string	Optional
`last_name`	string	Optional
`locale`	string	Optional
`mobile`	string	Optional
`openid`	string	Optional
`password`	string	Required

email

email

is required
type: string

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

first_name

first_name

is optional
type: string

first_name Type

string

gender

gender

is optional
type: enum

The value of this property must be equal to one of the known values below.

gender Known Values

Value	Description
`male`
`female`
`null`

last_name

last_name

is optional
type: string

last_name Type

string

locale

locale

is optional
type: string

locale Type

string

mobile

mobile

is optional
type: string

mobile Type

string

openid

openid

is optional
type: string

openid Type

string

password

password

is required
type: string

password Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

update_member Schema

http://ekoral.io/schema/update_member.json

update_member

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	update_member.schema.json

update_member Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	update_member (this schema)
parm	`object`	Required	No	update_member (this schema)
sid	`string`	Required	No	update_member (this schema)
version	`const`	Optional	No	update_member (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"update_member"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`first_name`	string	Optional
`gender`	string	Optional
`last_name`	string	Optional
`locale`	string	Optional
`mobile`	string	Optional
`openid`	string	Optional
`password`	string	Optional
`source`	string	Optional

first_name

first_name

is optional
type: string

first_name Type

string

gender

gender

is optional
type: enum

The value of this property must be equal to one of the known values below.

gender Known Values

Value	Description
`male`
`female`
`null`

last_name

last_name

is optional
type: string

last_name Type

string

locale

locale

is optional
type: string

locale Type

string

mobile

mobile

is optional
type: string

mobile Type

string

openid

openid

is optional
type: string

openid Type

string

password

password

is optional
type: string

password Type

string

source

source

is optional
type: string

source Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

chat Schema

http://ekoral.io/schema/chat.json

chat

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	chat.schema.json

chat Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	chat (this schema)
parm	`object`	Required	No	chat (this schema)
sid	`string`	Required	No	chat (this schema)
version	`const`	Optional	No	chat (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"chat"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`action`	string	Required
`chat`	string	Optional
`id`	string	Optional
`sn`	string	Required

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`create`
`update`
`delete`

chat

chat content in base64 encode

chat

is optional
type: string

chat Type

string

id

chat id

id

is optional
type: string

id Type

string

sn

sn

is required
type: string

sn Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

http://ekoral.io/schema/signup.json

signup

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	signup.schema.json

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	signup (this schema)
parm	`object`	Required	No	signup (this schema)
version	`const`	Optional	No	signup (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"signup"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`email`	string	Required
`first_name`	string	Optional
`gender`	string	Optional
`last_name`	string	Optional
`locale`	string	Optional
`mobile`	string	Optional
`openid`	string	Optional
`password`	string	Required

email

email

is required
type: string

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

first_name

first_name

is optional
type: string

first_name Type

string

gender

gender

is optional
type: enum

The value of this property must be equal to one of the known values below.

gender Known Values

Value	Description
`male`
`female`
`null`

last_name

last_name

is optional
type: string

last_name Type

string

locale

locale

is optional
type: string

locale Type

string

mobile

mobile

is optional
type: string

mobile Type

string

openid

openid

is optional
type: string

openid Type

string

password

password

is required
type: string

password Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

update_member Schema

http://ekoral.io/schema/update_member.json

update_member

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	update_member.schema.json

update_member Properties

Property	Type	Required	Nullable	Defined by
name	`const`	Required	No	update_member (this schema)
parm	`object`	Required	No	update_member (this schema)
sid	`string`	Required	No	update_member (this schema)
version	`const`	Optional	No	update_member (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"update_member"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`first_name`	string	Optional
`gender`	string	Optional
`last_name`	string	Optional
`locale`	string	Optional
`mobile`	string	Optional
`openid`	string	Optional
`password`	string	Optional
`source`	string	Optional

first_name

first_name

is optional
type: string

first_name Type

string

gender

gender

is optional
type: enum

The value of this property must be equal to one of the known values below.

gender Known Values

Value	Description
`male`
`female`
`null`

last_name

last_name

is optional
type: string

last_name Type

string

locale

locale

is optional
type: string

locale Type

string

mobile

mobile

is optional
type: string

mobile Type

string

openid

openid

is optional
type: string

openid Type

string

password

password

is optional
type: string

password Type

string

source

source

is optional
type: string

source Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

check_miniboard Schema

http://ekoral.io/schema/check_miniboard.json

Check eK Core accessible or not

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	check_miniboard.schema.json

check_miniboard Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	check_miniboard (this schema)
name	`const`	Required	No	check_miniboard (this schema)
parm	`object`	Required	No	check_miniboard (this schema)
sid	`string`	Required	No	check_miniboard (this schema)
sn	`string`	Required	No	check_miniboard (this schema)
version	`const`	Optional	No	check_miniboard (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"check_miniboard"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`ticket`	string	Optional

ticket

ticket

is optional
type: string

ticket Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_alert_setting Schema

http://ekoral.io/schema/get_alert_setting.json

get_alert_setting

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_alert_setting.schema.json

get_alert_setting Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_alert_setting (this schema)
name	`const`	Required	No	get_alert_setting (this schema)
parm	`object`	Required	No	get_alert_setting (this schema)
sid	`string`	Required	No	get_alert_setting (this schema)
sn	`string`	Required	No	get_alert_setting (this schema)
version	`const`	Optional	No	get_alert_setting (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_alert_setting"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`device_id`	integer,string,array	Optional

device_id

device_id

is optional
type: multiple

device_id Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_characteristics Schema

http://ekoral.io/schema/get_characteristics.json

get_characteristics

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_characteristics.schema.json

get_characteristics Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_characteristics (this schema)
name	`const`	Required	No	get_characteristics (this schema)
sid	`string`	Required	No	get_characteristics (this schema)
sn	`string`	Required	No	get_characteristics (this schema)
version	`const`	Optional	No	get_characteristics (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_characteristics"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_device_associations Schema

http://ekoral.io/schema/get_device_associations.json

get_device_associations

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_device_associations.schema.json

get_device_associations Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_device_associations (this schema)
name	`const`	Required	No	get_device_associations (this schema)
parm	`object`	Required	No	get_device_associations (this schema)
sid	`string`	Required	No	get_device_associations (this schema)
sn	`string`	Required	No	get_device_associations (this schema)
version	`const`	Optional	No	get_device_associations (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_device_associations"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`devices`	object,array	Optional

devices

devices

is optional
type: multiple

devices Type

One of the following conditions need to be fulfilled.

Condition 1

object with following properties:

Property	Type	Required
`id`	integer,string	Optional
`port_id`	integer	Optional
`strip_id`	integer,string	Optional

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

port_id

port_id

is optional
type: integer

port_id Type

integer

strip_id

strip_id

is optional
type: multiple

strip_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

Condition 2

Array type:

All items must be of the type: object with following properties:

Property	Type	Required
`id`	integer,string	Optional
`port_id`	integer	Optional
`strip_id`	integer,string	Optional

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

port_id

port_id

is optional
type: integer

port_id Type

integer

strip_id

strip_id

is optional
type: multiple

strip_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_device Schema

http://ekoral.io/schema/get_device.json

get_device

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_device.schema.json

get_device Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_device (this schema)
name	`const`	Required	No	get_device (this schema)
parm	`object`	Required	No	get_device (this schema)
sid	`string`	Required	No	get_device (this schema)
sn	`string`	Required	No	get_device (this schema)
version	`const`	Optional	No	get_device (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_device"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`characteristic`	string,array	Optional
`enable`	boolean	Optional
`id`	integer,string,array	Optional
`index`	integer,array	Optional
`module`	string,array	Optional
`type`	string,array	Optional

characteristic

characteristic

is optional
type: multiple

characteristic Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: string

Condition 2

string

enable

enable

is optional
type: boolean

enable Type

boolean

id

id

is optional
type: multiple

id Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

Condition 2

index

index

is optional
type: multiple

index Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: integer

Condition 2

integer

module

module

is optional
type: multiple

module Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: string

Condition 2

string

type

type

is optional
type: multiple

type Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: string

Condition 2

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_device_types Schema

http://ekoral.io/schema/get_device_types.json

get_device_types

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_device_types.schema.json

get_device_types Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_device_types (this schema)
name	`const`	Required	No	get_device_types (this schema)
parm	`object`	Required	No	get_device_types (this schema)
sid	`string`	Required	No	get_device_types (this schema)
sn	`string`	Required	No	get_device_types (this schema)
version	`const`	Optional	No	get_device_types (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_device_types"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`characteristic`	string,array	Optional
`type`	string,array	Optional

characteristic

characteristic

is optional
type: multiple

characteristic Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: string

Condition 2

string

type

type

is optional
type: multiple

type Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: string

Condition 2

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_journal Schema

http://ekoral.io/schema/get_journal.json

get_journal

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_journal.schema.json

get_journal Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_journal (this schema)
name	`const`	Required	No	get_journal (this schema)
parm	`object`	Required	No	get_journal (this schema)
sid	`string`	Required	No	get_journal (this schema)
sn	`string`	Required	No	get_journal (this schema)
version	`const`	Optional	No	get_journal (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_journal"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`count`	integer	Optional
`from_timestamp`	number	Optional
`to_timestamp`	number	Optional

count

count

is optional
type: integer

count Type

integer

from_timestamp

from_timestamp

is optional
type: number

from_timestamp Type

number

to_timestamp

to_timestamp

is optional
type: number

to_timestamp Type

number

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_miniboard Schema

http://ekoral.io/schema/get_miniboard.json

get_miniboard

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_miniboard.schema.json

get_miniboard Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_miniboard (this schema)
name	`const`	Required	No	get_miniboard (this schema)
sid	`string`	Required	No	get_miniboard (this schema)
sn	`string`	Required	No	get_miniboard (this schema)
version	`const`	Optional	No	get_miniboard (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_miniboard"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_plan Schema

http://ekoral.io/schema/get_plan.json

get_plan

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_plan.schema.json

get_plan Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_plan (this schema)
name	`const`	Required	No	get_plan (this schema)
parm	`object`	Required	No	get_plan (this schema)
sid	`string`	Required	No	get_plan (this schema)
sn	`string`	Required	No	get_plan (this schema)
version	`const`	Optional	No	get_plan (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_plan"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`id`	integer,string	Optional
`type`	string	Optional

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "id",
  "simpletype": "multiple"
}

type

type

is optional
type: enum

The value of this property must be equal to one of the known values below.

type Known Values

Value	Description
`maintain`
`feed`
`customize`

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_rule Schema

http://ekoral.io/schema/get_rule.json

get_rule

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_rule.schema.json

get_rule Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_rule (this schema)
name	`const`	Required	No	get_rule (this schema)
parm	`object`	Required	No	get_rule (this schema)
sid	`string`	Required	No	get_rule (this schema)
sn	`string`	Required	No	get_rule (this schema)
version	`const`	Optional	No	get_rule (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_rule"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`enable`	boolean	Optional
`gid`	integer,string,array	Optional

enable

enable

is optional
type: boolean

enable Type

boolean

gid

gid

is optional
type: multiple

gid Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_schedule Schema

http://ekoral.io/schema/get_schedule.json

get_schedule

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_schedule.schema.json

get_schedule Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_schedule (this schema)
name	`const`	Required	No	get_schedule (this schema)
parm	`object`	Required	No	get_schedule (this schema)
sid	`string`	Required	No	get_schedule (this schema)
sn	`string`	Required	No	get_schedule (this schema)
version	`const`	Optional	No	get_schedule (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_schedule"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`id`	integer,string,array	Optional

id

id

is optional
type: multiple

id Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

Condition 2

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_sensor_readings Schema

http://ekoral.io/schema/get_sensor_readings.json

get_sensor_readings

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_sensor_readings.schema.json

get_sensor_readings Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_sensor_readings (this schema)
name	`const`	Required	No	get_sensor_readings (this schema)
parm	`object`	Required	No	get_sensor_readings (this schema)
sid	`string`	Required	No	get_sensor_readings (this schema)
sn	`string`	Required	No	get_sensor_readings (this schema)
version	`const`	Optional	No	get_sensor_readings (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_sensor_readings"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`device_id`	integer,string,array	Optional
`from_timestamp`	integer	Optional
`interval`	object	Optional
`past`	object	Optional
`to_timestamp`	integer	Optional
`type`	string,array	Optional

device_id

device_id

is optional
type: multiple

device_id Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

from_timestamp

from_timestamp

is optional
type: integer

from_timestamp Type

integer

minimum value: 1

interval

interval

is optional
type: object

interval Type

object with following properties:

Property	Type	Required
`length`	integer	Required
`unit`	string	Required

length

length

is required
type: integer

length Type

integer

minimum value: 0

unit

unit

is required
type: enum

The value of this property must be equal to one of the known values below.

unit Known Values

Value	Description
`minutes`
`hours`
`days`

past

past

is optional
type: object

past Type

object with following properties:

Property	Type	Required
`length`	integer	Required
`unit`	string	Required

length

length

is required
type: integer

length Type

integer

minimum value: 0

unit

unit

is required
type: enum

The value of this property must be equal to one of the known values below.

unit Known Values

Value	Description
`minutes`
`hours`
`days`

to_timestamp

to_timestamp

is optional
type: integer

to_timestamp Type

integer

minimum value: 1

type

type

is optional
type: multiple

type Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_simulator Schema

http://ekoral.io/schema/get_simulator.json

get_simulator

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_simulator.schema.json

get_simulator Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_simulator (this schema)
name	`const`	Required	No	get_simulator (this schema)
sid	`string`	Required	No	get_simulator (this schema)
sn	`string`	Required	No	get_simulator (this schema)
version	`const`	Optional	No	get_simulator (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_simulator"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

preview Schema

http://ekoral.io/schema/preview.json

preview

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	preview.schema.json

preview Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	preview (this schema)
name	`const`	Required	No	preview (this schema)
parm	`object`	Required	No	preview (this schema)
sid	`string`	Required	No	preview (this schema)
sn	`string`	Required	No	preview (this schema)
version	`const`	Optional	No	preview (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"preview"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`preview`	object	Optional

preview

preview

is optional
type: object

preview Type

object with following properties:

Property	Type	Required
`action`	string	Required
`id`	integer,string	Optional
`manual`	object	Optional
`schedule`	object	Optional
`speed`	number	Optional

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`start`
`stop`
`status`

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "id",
  "simpletype": "multiple"
}

manual

manual

is optional
type: object

manual Type

object with following properties:

Property	Type	Required
`capability`	string	Optional
`id`	integer,string	Optional
`svalue`	string	Optional
`value`	number	Optional
`value1`	number	Optional
`values`	object,array	Optional

capability

capability

is optional
type: string

capability Type

string

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "id",
  "simpletype": "multiple"
}

svalue

svalue

is optional
type: string

svalue Type

string

value

value

is optional
type: number

value Type

number

value1

value1

is optional
type: number

value1 Type

number

values

values

is optional
type: multiple

values Type

One of the following conditions need to be fulfilled.

Condition 1

object with following properties:

Property	Type	Required

Condition 2

Array type:

schedule

schedule

is optional
type: object

schedule Type

object with following properties:

Property	Type	Required
`cron`	string	Optional
`device_id`	integer,string	Required
`duration`	integer	Optional
`events`	object	Optional
`icon`	string	Optional
`loop`	boolean	Optional
`name`	string	Optional
`tasks`	array	Optional

cron

cron

is optional
type: string

cron Type

string

device_id

device_id

is required
type: multiple

device_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "device_id",
  "simpletype": "multiple"
}

duration

duration

is optional
type: integer

duration Type

integer

minimum value: 1

events

events

is optional
type: object

events Type

object with following properties:

Property	Type	Required

icon

icon

is optional
type: string

icon Type

string

loop

loop

is optional
type: boolean

loop Type

boolean

name

name

is optional
type: string

name Type

string

tasks

tasks

is optional
type: object[]

tasks Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`capability`	string	Optional
`duration`	integer	Required
`events`	object	Optional
`features`	object	Optional
`pattern`	string	Optional
`ramp`	boolean	Optional
`values`	array	Optional

capability

capability

is optional
type: string

capability Type

string

duration

duration

is required
type: integer

duration Type

integer

minimum value: 1

events

events

is optional
type: object

events Type

object with following properties:

Property	Type	Required

features

features

is optional
type: object

features Type

object with following properties:

Property	Type	Required

pattern

pattern

is optional
type: string

pattern Type

string

ramp

ramp

is optional
type: boolean

ramp Type

boolean

values

values

is optional
type: object[]* at least 1 items in the array

values Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`duration_fall`	number	Optional
`duration_max`	number	Optional
`duration_min`	number	Optional
`duration_rise`	number	Optional
`end_density`	number	Optional
`end_density_range`	array	Optional
`max`	number	Optional
`max_range`	array	Optional
`min`	number	Optional
`min_range`	array	Optional
`start_density`	number	Optional
`start_density_range`	array	Optional

duration_fall

duration_fall

is optional
type: number

duration_fall Type

number

duration_max

duration_max

is optional
type: number

duration_max Type

number

duration_min

duration_min

is optional
type: number

duration_min Type

number

duration_rise

duration_rise

is optional
type: number

duration_rise Type

number

end_density

end_density

is optional
type: number

end_density Type

number

end_density_range

end_density_range

is optional
type: number[]* no more than 2 items in the array

end_density_range Type

Array type: number[]

All items must be of the type: number

max

max

is optional
type: number

max Type

number

max_range

max_range

is optional
type: number[]* no more than 2 items in the array

max_range Type

Array type: number[]

All items must be of the type: number

min

min

is optional
type: number

min Type

number

min_range

min_range

is optional
type: number[]* no more than 2 items in the array

min_range Type

Array type: number[]

All items must be of the type: number

start_density

start_density

is optional
type: number

start_density Type

number

start_density_range

start_density_range

is optional
type: number[]* no more than 2 items in the array

start_density_range Type

Array type: number[]

All items must be of the type: number

speed

speed

is optional
type: number

speed Type

number

minimum value: 1

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_schedule Schema

http://ekoral.io/schema/get_schedule.json

get_schedule

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_schedule.schema.json

get_schedule Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_schedule (this schema)
name	`const`	Required	No	get_schedule (this schema)
parm	`object`	Required	No	get_schedule (this schema)
sid	`string`	Required	No	get_schedule (this schema)
sn	`string`	Required	No	get_schedule (this schema)
version	`const`	Optional	No	get_schedule (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_schedule"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`id`	integer,string,array	Optional

id

id

is optional
type: multiple

id Type

One of the following conditions need to be fulfilled.

Condition 1

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

Condition 2

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_sensor_readings Schema

http://ekoral.io/schema/get_sensor_readings.json

get_sensor_readings

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_sensor_readings.schema.json

get_sensor_readings Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_sensor_readings (this schema)
name	`const`	Required	No	get_sensor_readings (this schema)
parm	`object`	Required	No	get_sensor_readings (this schema)
sid	`string`	Required	No	get_sensor_readings (this schema)
sn	`string`	Required	No	get_sensor_readings (this schema)
version	`const`	Optional	No	get_sensor_readings (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_sensor_readings"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`device_id`	integer,string,array	Optional
`from_timestamp`	integer	Optional
`interval`	object	Optional
`past`	object	Optional
`to_timestamp`	integer	Optional
`type`	string,array	Optional

device_id

device_id

is optional
type: multiple

device_id Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Array type:

All items must be of the type: Unknown type integer,string.

{
  "type": "array",
  "items": {
    "type": ["integer", "string"]
  }
}

from_timestamp

from_timestamp

is optional
type: integer

from_timestamp Type

integer

minimum value: 1

interval

interval

is optional
type: object

interval Type

object with following properties:

Property	Type	Required
`length`	integer	Required
`unit`	string	Required

length

length

is required
type: integer

length Type

integer

minimum value: 0

unit

unit

is required
type: enum

The value of this property must be equal to one of the known values below.

unit Known Values

Value	Description
`minutes`
`hours`
`days`

past

past

is optional
type: object

past Type

object with following properties:

Property	Type	Required
`length`	integer	Required
`unit`	string	Required

length

length

is required
type: integer

length Type

integer

minimum value: 0

unit

unit

is required
type: enum

The value of this property must be equal to one of the known values below.

unit Known Values

Value	Description
`minutes`
`hours`
`days`

to_timestamp

to_timestamp

is optional
type: integer

to_timestamp Type

integer

minimum value: 1

type

type

is optional
type: multiple

type Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_alert_setting Schema

http://ekoral.io/schema/configure_alert_setting.json

Configure alert setting

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_alert_setting.schema.json

configure_alert_setting Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	configure_alert_setting (this schema)
name	`const`	Required	No	configure_alert_setting (this schema)
parm	`object`	Required	No	configure_alert_setting (this schema)
sid	`string`	Required	No	configure_alert_setting (this schema)
sn	`string`	Required	No	configure_alert_setting (this schema)
version	`const`	Optional	No	configure_alert_setting (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_alert_setting"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_device Schema

http://ekoral.io/schema/configure_device.json

Create, update, delete devices of eK Core belonging to

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_device.schema.json

configure_device Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	configure_device (this schema)
name	`const`	Required	No	configure_device (this schema)
parm	`object`	Required	No	configure_device (this schema)
sid	`string`	Required	No	configure_device (this schema)
sn	`string`	Required	No	configure_device (this schema)
version	`const`	Optional	No	configure_device (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_device"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`device`	object	Optional

device

device

is optional
type: object

device Type

object with following properties:

Property	Type	Required
`action`	string	Required
`characteristic`	string	Optional
`enable`	boolean	Optional
`icon`	string	Optional
`id`	integer,string	Optional
`index`	integer	Optional
`model`	string	Optional
`module`	string	Optional
`name`	string	Optional
`path`	string	Optional
`supplement`	object	Optional
`svalue`	string	Optional
`type`	string	Optional

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`create`
`update`
`delete`

characteristic

characteristic

is optional
type: string

characteristic Type

string

enable

enable

is optional
type: boolean

enable Type

boolean

icon

icon

is optional
type: string

icon Type

string

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "id",
  "simpletype": "multiple"
}

index

index

is optional
type: integer

index Type

integer

model

model

is optional
type: string

model Type

string

module

module

is optional
type: string

module Type

string

name

name

is optional
type: string

name Type

string

path

path

is optional
type: string

path Type

string

supplement

supplement

is optional
type: object

supplement Type

object with following properties:

Property	Type	Required

svalue

svalue

is optional
type: string

svalue Type

string

type

type

is optional
type: string

type Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_miniboard Schema

http://ekoral.io/schema/configure_miniboard.json

Update eK Core name and other information

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_miniboard.schema.json

configure_miniboard Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	configure_miniboard (this schema)
name	`const`	Required	No	configure_miniboard (this schema)
parm	`object`	Required	No	configure_miniboard (this schema)
sid	`string`	Required	No	configure_miniboard (this schema)
sn	`string`	Required	No	configure_miniboard (this schema)
version	`const`	Optional	No	configure_miniboard (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_miniboard"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`miniboard`	object	Optional

miniboard

miniboard

is optional
type: object

miniboard Type

object with following properties:

Property	Type	Required
`action`	string	Required
`name`	string	Optional
`timezone`	string	Optional
`uri`	string	Optional

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`update`

name

eK Core name

name

is optional
type: string

name Type

string

timezone

timezone

is optional
type: string

timezone Type

string

uri

deprecated

uri

is optional
type: string

uri Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_plan Schema

http://ekoral.io/schema/configure_plan.json

configure_plan

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_plan.schema.json

configure_plan Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	configure_plan (this schema)
name	`const`	Required	No	configure_plan (this schema)
parm	`object`	Required	No	configure_plan (this schema)
sid	`string`	Required	No	configure_plan (this schema)
sn	`string`	Required	No	configure_plan (this schema)
version	`const`	Optional	No	configure_plan (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_plan"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`plan`	object	Optional

plan

plan

is optional
type: object

plan Type

object with following properties:

Property	Type	Required
`action`	string	Required
`devices`	array	Optional
`duration`	integer	Optional
`id`	integer,string	Optional
`name`	string	Optional
`type`	string	Optional

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`create`
`update`
`delete`

devices

devices

is optional
type: array

devices Type

Array type: array

duration

duration

is optional
type: integer

duration Type

integer

minimum value: 1000

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "id",
  "simpletype": "multiple"
}

name

name

is optional
type: string

name Type

string

type

type

is optional
type: enum

The value of this property must be equal to one of the known values below.

type Known Values

Value	Description
`maintain`
`feed`
`customize`

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_rule Schema

http://ekoral.io/schema/configure_rule.json

configure_rule

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_rule.schema.json

configure_rule Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	configure_rule (this schema)
name	`const`	Required	No	configure_rule (this schema)
parm	`object`	Required	No	configure_rule (this schema)
sid	`string`	Required	No	configure_rule (this schema)
sn	`string`	Required	No	configure_rule (this schema)
version	`const`	Optional	No	configure_rule (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_rule"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`rule`	object	Required

rule

rule

is required
type: object

rule Type

object with following properties:

Property	Type	Required
`action`		Optional
`conditions`	array	Optional
`enable`	boolean	Optional
`gid`	integer,string	Optional
`icon`	string	Optional
`name`	string	Optional

action

action

is optional
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`create`
`update`
`delete`

conditions

conditions

is optional
type: object[]* between 1 and 1 items in the array

conditions Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`if`		Required
`pause`	object	Optional
`runtime`	object	Optional
`then`	object	Required
`until`		Optional

if

if

is required
type: complex

if Type

One of the following conditions need to be fulfilled.

Condition 1

object with following properties:

Property	Type	Required
`device_id`	integer,string	Required
`keep_ms`	integer	Optional
`op`		Required
`value`	number	Required
`value_type`	string	Optional

device_id

device_id

is required
type: multiple

device_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

keep_ms

keep_ms

is optional
type: integer

keep_ms Type

integer

minimum value: 300000

op

op

is required
type: enum

The value of this property must be equal to one of the known values below.

op Known Values

Value	Description
`gt`
`eq`
`lt`
`ne`
`ge`
`le`
`dlt`

value

value

is required
type: number

value Type

number

value_type

value_type

is optional
type: string

value_type Type

string

Condition 2

object with following properties:

Property	Type	Required
`and`	array	Optional
`or`	array	Optional

and

and

is optional
type: object[]* at least 2 items in the array

and Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`device_id`	integer,string	Required
`keep_ms`	integer	Optional
`op`		Required
`value`	number	Required
`value_type`	string	Optional

device_id

device_id

is required
type: multiple

device_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

keep_ms

keep_ms

is optional
type: integer

keep_ms Type

integer

minimum value: 300000

op

op

is required
type: enum

The value of this property must be equal to one of the known values below.

op Known Values

Value	Description
`gt`
`eq`
`lt`
`ne`
`ge`
`le`
`dlt`

value

value

is required
type: number

value Type

number

value_type

value_type

is optional
type: string

value_type Type

string

or

or

is optional
type: object[]* at least 2 items in the array

or Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`device_id`	integer,string	Required
`keep_ms`	integer	Optional
`op`		Required
`value`	number	Required
`value_type`	string	Optional

device_id

device_id

is required
type: multiple

device_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

keep_ms

keep_ms

is optional
type: integer

keep_ms Type

integer

minimum value: 300000

op

op

is required
type: enum

The value of this property must be equal to one of the known values below.

op Known Values

Value	Description
`gt`
`eq`
`lt`
`ne`
`ge`
`le`
`dlt`

value

value

is required
type: number

value Type

number

value_type

value_type

is optional
type: string

value_type Type

string

pause

pause

is optional
type: object

pause Type

object with following properties:

Property	Type	Required
`duration`	integer	Required

duration

duration

is required
type: integer

duration Type

integer

minimum value: 60000
maximum value: 86400000

runtime

runtime

is optional
type: object

runtime Type

object with following properties:

Property	Type	Required
`duration`	integer	Required

duration

duration

is required
type: integer

duration Type

integer

minimum value: 60000
maximum value: 86400000

then

then

is required
type: object

then Type

object with following properties:

Property	Type	Required
`device_id`	integer,string	Required
`tasks`	array	Required

device_id

device_id

is required
type: multiple

device_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

tasks

tasks

is required
type: object[]* at least 1 items in the array

tasks Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`capability`	string	Optional
`duration`	integer	Optional
`type`		Optional
`value`	number	Optional
`values`	object,array	Optional

capability

capability

is optional
type: string

capability Type

string

duration

duration

is optional
type: integer

duration Type

integer

minimum value: 0

type

type

is optional
type: enum

The value of this property must be equal to one of the known values below.

type Known Values

Value	Description
`defer`
`onoff`
`command`
`set`

value

value

is optional
type: number

value Type

number

values

values

is optional
type: multiple

values Type

Unknown type object,array.

{
  "type": ["object", "array"],
  "simpletype": "multiple"
}

until

until

is optional
type: complex

until Type

One of the following conditions need to be fulfilled.

Condition 1

object with following properties:

Property	Type	Required
`keep_ms`	integer	Optional
`op`		Optional
`value`	number	Required

keep_ms

keep_ms

is optional
type: integer

keep_ms Type

integer

minimum value: 300000

op

op

is optional
type: enum

The value of this property must be equal to one of the known values below.

op Known Values

Value	Description
`gt`
`eq`
`lt`
`ne`
`ge`
`le`
`dlt`

value

value

is required
type: number

value Type

number

Condition 2

object with following properties:

Property	Type	Required
`and`	array	Optional
`or`	array	Optional

and

and

is optional
type: object[]* at least 2 items in the array

and Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`device_id`	integer,string	Required
`keep_ms`	integer	Optional
`op`		Required
`value`	number	Required
`value_type`	string	Optional

device_id

device_id

is required
type: multiple

device_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

keep_ms

keep_ms

is optional
type: integer

keep_ms Type

integer

minimum value: 300000

op

op

is required
type: enum

The value of this property must be equal to one of the known values below.

op Known Values

Value	Description
`gt`
`eq`
`lt`
`ne`
`ge`
`le`
`dlt`

value

value

is required
type: number

value Type

number

value_type

value_type

is optional
type: string

value_type Type

string

or

or

is optional
type: object[]* at least 2 items in the array

or Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`device_id`	integer,string	Required
`keep_ms`	integer	Optional
`op`		Required
`value`	number	Required
`value_type`	string	Optional

device_id

device_id

is required
type: multiple

device_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

keep_ms

keep_ms

is optional
type: integer

keep_ms Type

integer

minimum value: 300000

op

op

is required
type: enum

The value of this property must be equal to one of the known values below.

op Known Values

Value	Description
`gt`
`eq`
`lt`
`ne`
`ge`
`le`
`dlt`

value

value

is required
type: number

value Type

number

value_type

value_type

is optional
type: string

value_type Type

string

enable

enable

is optional
type: boolean

enable Type

boolean

gid

gid

is optional
type: multiple

gid Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "simpletype": "multiple"
}

icon

icon

is optional
type: string

icon Type

string

name

name

is optional
type: string

name Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_schedule Schema

http://ekoral.io/schema/configure_schedule.json

configure_schedule

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_schedule.schema.json

configure_schedule Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	configure_schedule (this schema)
name	`const`	Required	No	configure_schedule (this schema)
parm	`object`	Required	No	configure_schedule (this schema)
sid	`string`	Required	No	configure_schedule (this schema)
sn	`string`	Required	No	configure_schedule (this schema)
version	`const`	Optional	No	configure_schedule (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_schedule"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`schedule`	object	Optional

schedule

schedule

is optional
type: object

schedule Type

object with following properties:

Property	Type	Required
`action`	string	Required
`cron`	string	Optional
`device_id`	integer,string	Optional
`duration`	integer	Optional
`enable`	boolean	Optional
`events`	object	Optional
`icon`	string	Optional
`id`	integer,string	Optional
`loop`	boolean	Optional
`name`	string	Optional
`plan_id`	integer,string	Optional
`tasks`	array	Optional

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`create`
`update`
`delete`

cron

cron

is optional
type: string

cron Type

string

device_id

device_id

is optional
type: multiple

device_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "device_id",
  "simpletype": "multiple"
}

duration

duration

is optional
type: integer

duration Type

integer

minimum value: 1

enable

enable

is optional
type: boolean

enable Type

boolean

events

events

is optional
type: object

events Type

object with following properties:

Property	Type	Required

icon

icon

is optional
type: string

icon Type

string

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "id",
  "simpletype": "multiple"
}

loop

loop

is optional
type: boolean

loop Type

boolean

name

name

is optional
type: string

name Type

string

plan_id

plan_id

is optional
type: multiple

plan_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "plan_id",
  "simpletype": "multiple"
}

tasks

tasks

is optional
type: object[]* at least 1 items in the array

tasks Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`capability`	string	Optional
`duration`	integer	Required
`events`	object	Optional
`features`	object	Optional
`pattern`	string	Optional
`ramp`	boolean	Optional
`values`	array	Optional

capability

capability

is optional
type: string

capability Type

string

duration

duration

is required
type: integer

duration Type

integer

minimum value: 1

events

events

is optional
type: object

events Type

object with following properties:

Property	Type	Required

features

features

is optional
type: object

features Type

object with following properties:

Property	Type	Required

pattern

pattern

is optional
type: string

pattern Type

string

ramp

ramp

is optional
type: boolean

ramp Type

boolean

values

values

is optional
type: object[]* at least 1 items in the array

values Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`duration_fall`	number	Optional
`duration_max`	number	Optional
`duration_min`	number	Optional
`duration_rise`	number	Optional
`end_density`	number	Optional
`end_density_range`	array	Optional
`max`	number	Optional
`max_range`	array	Optional
`min`	number	Optional
`min_range`	array	Optional
`start_density`	number	Optional
`start_density_range`	array	Optional

duration_fall

duration_fall

is optional
type: number

duration_fall Type

number

duration_max

duration_max

is optional
type: number

duration_max Type

number

duration_min

duration_min

is optional
type: number

duration_min Type

number

duration_rise

duration_rise

is optional
type: number

duration_rise Type

number

end_density

end_density

is optional
type: number

end_density Type

number

end_density_range

end_density_range

is optional
type: number[]* no more than 2 items in the array

end_density_range Type

Array type: number[]

All items must be of the type: number

max

max

is optional
type: number

max Type

number

max_range

max_range

is optional
type: number[]* no more than 2 items in the array

max_range Type

Array type: number[]

All items must be of the type: number

min

min

is optional
type: number

min Type

number

min_range

min_range

is optional
type: number[]* no more than 2 items in the array

min_range Type

Array type: number[]

All items must be of the type: number

start_density

start_density

is optional
type: number

start_density Type

number

start_density_range

start_density_range

is optional
type: number[]* no more than 2 items in the array

start_density_range Type

Array type: number[]

All items must be of the type: number

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_simulator Schema

http://ekoral.io/schema/configure_simulator.json

configure_simulator

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_simulator.schema.json

configure_simulator Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	configure_simulator (this schema)
name	`const`	Required	No	configure_simulator (this schema)
parm	`object`	Required	No	configure_simulator (this schema)
sid	`string`	Required	No	configure_simulator (this schema)
sn	`string`	Required	No	configure_simulator (this schema)
version	`const`	Optional	No	configure_simulator (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_simulator"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`simulator`	object	Optional

simulator

simulator

is optional
type: object

simulator Type

object with following properties:

Property	Type	Required

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

connect_ap Schema

http://ekoral.io/schema/connect_ap.json

connect_ap

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	connect_ap.schema.json

connect_ap Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	connect_ap (this schema)
name	`const`	Required	No	connect_ap (this schema)
parm	`object`	Required	No	connect_ap (this schema)
sid	`string`	Required	No	connect_ap (this schema)
sn	`string`	Required	No	connect_ap (this schema)
version	`const`	Optional	No	connect_ap (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"connect_ap"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`passphrase`	string	Optional
`ssid`	string	Optional

passphrase

passphrase

is optional
type: string

passphrase Type

string

ssid

ssid

is optional
type: string

ssid Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

disconnect_ap Schema

http://ekoral.io/schema/disconnect_ap.json

disconnect_ap

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	disconnect_ap.schema.json

disconnect_ap Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	disconnect_ap (this schema)
name	`const`	Required	No	disconnect_ap (this schema)
sid	`string`	Required	No	disconnect_ap (this schema)
sn	`string`	Required	No	disconnect_ap (this schema)
version	`const`	Optional	No	disconnect_ap (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"disconnect_ap"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

ota_update Schema

http://ekoral.io/schema/ota_update.json

ota_update

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	ota_update.schema.json

ota_update Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	ota_update (this schema)
name	`const`	Required	No	ota_update (this schema)
parm	`object`	Required	No	ota_update (this schema)
sid	`string`	Required	No	ota_update (this schema)
sn	`string`	Required	No	ota_update (this schema)
version	`const`	Optional	No	ota_update (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"ota_update"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`action`	string	Optional
`parm`	object	Optional

action

action

is optional
type: string

action Type

string

parm

parm

is optional
type: object

parm Type

object with following properties:

Property	Type	Required

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

plug_device Schema

http://ekoral.io/schema/plug_device.json

plug_device

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	plug_device.schema.json

plug_device Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	plug_device (this schema)
name	`const`	Required	No	plug_device (this schema)
parm	`object`	Required	No	plug_device (this schema)
sid	`string`	Required	No	plug_device (this schema)
sn	`string`	Required	No	plug_device (this schema)
version	`const`	Optional	No	plug_device (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"plug_device"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`strip`	object	Optional

strip

strip

is optional
type: object

strip Type

object with following properties:

Property	Type	Required
`ports`	array	Optional
`strip_id`	integer,string	Required

ports

ports

is optional
type: object[]

ports Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
`default_delay`	integer	Optional
`default_onoff`	boolean	Optional
`device`	object	Optional
`port_id`	integer	Required

default_delay

default_delay

is optional
type: integer

default_delay Type

integer

default_onoff

default_onoff

is optional
type: boolean

default_onoff Type

boolean

device

device

is optional
type: object

device Type

object with following properties:

Property	Type	Required
`characteristic`	string	Optional
`icon`	string	Optional
`index`	integer	Optional
`module`	string	Optional
`name`	string	Optional

characteristic

characteristic

is optional
type: string

characteristic Type

string

icon

icon

is optional
type: string

icon Type

string

index

index

is optional
type: integer

index Type

integer

module

module

is optional
type: string

module Type

string

name

name

is optional
type: string

name Type

string

port_id

port_id

is required
type: integer

port_id Type

integer

strip_id

strip_id

is required
type: multiple

strip_id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "strip_id",
  "simpletype": "multiple"
}

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

scan_device Schema

http://ekoral.io/schema/scan_device.json

scan_device

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	scan_device.schema.json

scan_device Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	scan_device (this schema)
name	`const`	Required	No	scan_device (this schema)
parm	`object`	Required	No	scan_device (this schema)
sid	`string`	Required	No	scan_device (this schema)
sn	`string`	Required	No	scan_device (this schema)
version	`const`	Optional	No	scan_device (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"scan_device"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`device_type`	string	Required
`hostname`	string	Optional
`port`	integer	Optional

device_type

device type

device_type

is required
type: string

device_type Type

string

hostname

ip address

hostname

is optional
type: string

hostname Type

string

port

port

is optional
type: integer

port Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

update_datetime Schema

http://ekoral.io/schema/update_datetime.json

update_datetime

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	update_datetime.schema.json

update_datetime Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	update_datetime (this schema)
name	`const`	Required	No	update_datetime (this schema)
parm	`object`	Required	No	update_datetime (this schema)
sid	`string`	Required	No	update_datetime (this schema)
sn	`string`	Required	No	update_datetime (this schema)
version	`const`	Optional	No	update_datetime (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"update_datetime"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`time`	string	Optional
`timestamp`	integer	Optional
`timezone`	string	Optional
`url_ntp_server`	string	Optional

time

time

is optional
type: string

time Type

string

timestamp

timestamp

is optional
type: integer

timestamp Type

integer

timezone

timezone

is optional
type: string

timezone Type

string

url_ntp_server

url_ntp_server

is optional
type: string

url_ntp_server Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

control_device Schema

http://ekoral.io/schema/control_device.json

control_device

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	control_device.schema.json

control_device Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	control_device (this schema)
name	`const`	Required	No	control_device (this schema)
parm	`object`	Required	No	control_device (this schema)
sid	`string`	Required	No	control_device (this schema)
sn	`string`	Required	No	control_device (this schema)
version	`const`	Optional	No	control_device (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"control_device"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`device`	object	Optional

device

device

is optional
type: object

device Type

object with following properties:

Property	Type	Required
`capability`	string	Required
`id`	integer,string	Required
`svalue`	string	Optional
`value`	number	Optional
`value1`	number	Optional
`values`	object,array	Optional

capability

capability

is required
type: string

capability Type

string

id

id

is required
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "id",
  "simpletype": "multiple"
}

svalue

svalue

is optional
type: string

svalue Type

string

value

value

is optional
type: number

value Type

number

value1

value1

is optional
type: number

value1 Type

number

values

values

is optional
type: multiple

values Type

One of the following conditions need to be fulfilled.

Condition 1

object with following properties:

Property	Type	Required

Condition 2

Array type:

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

control_plan Schema

http://ekoral.io/schema/control_plan.json

control_plan

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	control_plan.schema.json

control_plan Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	control_plan (this schema)
name	`const`	Required	No	control_plan (this schema)
parm	`object`	Required	No	control_plan (this schema)
sid	`string`	Required	No	control_plan (this schema)
sn	`string`	Required	No	control_plan (this schema)
version	`const`	Optional	No	control_plan (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"control_plan"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`action`	string	Required
`duration`	integer	Optional
`id`	integer,string	Optional
`type`	string	Optional

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`start`
`stop`
`status`
`extend`
`cancel`

duration

duration

is optional
type: integer

duration Type

integer

minimum value: 1000

id

id

is optional
type: multiple

id Type

Unknown type integer,string.

{
  "type": ["integer", "string"],
  "description": "id",
  "simpletype": "multiple"
}

type

type

is optional
type: enum

The value of this property must be equal to one of the known values below.

type Known Values

Value	Description
`maintain`
`feed`
`customize`

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

diagnose_network Schema

http://ekoral.io/schema/diagnose_network.json

diagnose_network

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	diagnose_network.schema.json

diagnose_network Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	diagnose_network (this schema)
name	`const`	Required	No	diagnose_network (this schema)
sid	`string`	Required	No	diagnose_network (this schema)
sn	`string`	Required	No	diagnose_network (this schema)
version	`const`	Optional	No	diagnose_network (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"diagnose_network"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

diagnose_system Schema

http://ekoral.io/schema/diagnose_system.json

diagnose_system

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	diagnose_system.schema.json

diagnose_system Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	diagnose_system (this schema)
name	`const`	Required	No	diagnose_system (this schema)
parm	`object`	Required	No	diagnose_system (this schema)
sid	`string`	Required	No	diagnose_system (this schema)
sn	`string`	Required	No	diagnose_system (this schema)
version	`const`	Optional	No	diagnose_system (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"diagnose_system"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`tests`	object,array,string	Optional

tests

tests

is optional
type: multiple

tests Type

Unknown type object,array,string.

{
  "type": ["object", "array", "string"],
  "description": "tests",
  "simpletype": "multiple"
}

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

adjust_dosing_port Schema

http://ekoral.io/schema/adjust_dosing_port.json

Adjust level and delay by port of Doser

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	adjust_dosing_port.schema.json

adjust_dosing_port Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	adjust_dosing_port (this schema)
name	`const`	Required	No	adjust_dosing_port (this schema)
parm	`object`	Required	No	adjust_dosing_port (this schema)
sid	`string`	Required	No	adjust_dosing_port (this schema)
sn	`string`	Required	No	adjust_dosing_port (this schema)
version	`const`	Optional	No	adjust_dosing_port (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"adjust_dosing_port"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`delay`	integer	Optional
`level`	integer	Optional
`port`	integer	Required

delay

delay

is optional
type: integer

delay Type

integer

level

level

is optional
type: integer

level Type

integer

minimum value: 1
maximum value: 3

port

port

is required
type: integer

port Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_dosing Schema

http://ekoral.io/schema/calibrate_dosing.json

Calibrate pump flow rate for eK Doser

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_dosing.schema.json

calibrate_dosing Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_dosing (this schema)
name	`const`	Required	No	calibrate_dosing (this schema)
parm	`object`	Required	No	calibrate_dosing (this schema)
sid	`string`	Required	No	calibrate_dosing (this schema)
sn	`string`	Required	No	calibrate_dosing (this schema)
version	`const`	Optional	No	calibrate_dosing (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_dosing"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`level`	integer	Required
`method`	string	Required
`port`	integer	Required
`value`	number	Optional

level

level of flow rate, 1 is low, 3 is high

level

is required
type: integer

level Type

integer

minimum value: 1
maximum value: 3

method

pump state

method

is required
type: enum

The value of this property must be equal to one of the known values below.

method Known Values

Value	Description
`ready_calibration`
`calibrate_port`
`save_calibration`

port

port

is required
type: integer

port Type

integer

value

value of flow rate in unit ml/sec

value

is optional
type: number

value Type

number

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_dry Schema

http://ekoral.io/schema/calibrate_dry.json

calibrate_dry

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_dry.schema.json

calibrate_dry Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_dry (this schema)
name	`const`	Required	No	calibrate_dry (this schema)
sid	`string`	Required	No	calibrate_dry (this schema)
sn	`string`	Required	No	calibrate_dry (this schema)
version	`const`	Optional	No	calibrate_dry (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_dry"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_ec_save Schema

http://ekoral.io/schema/calibrate_ec_save.json

calibrate_ec_save

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_ec_save.schema.json

calibrate_ec_save Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_ec_save (this schema)
name	`const`	Required	No	calibrate_ec_save (this schema)
parm	`object`	Required	No	calibrate_ec_save (this schema)
sid	`string`	Required	No	calibrate_ec_save (this schema)
sn	`string`	Required	No	calibrate_ec_save (this schema)
version	`const`	Optional	No	calibrate_ec_save (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_ec_save"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`timestamp`	integer	Required

timestamp

timestamp

is required
type: integer

timestamp Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_left_intercept Schema

http://ekoral.io/schema/calibrate_left_intercept.json

calibrate_left_intercept

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_left_intercept.schema.json

calibrate_left_intercept Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_left_intercept (this schema)
name	`const`	Required	No	calibrate_left_intercept (this schema)
sid	`string`	Required	No	calibrate_left_intercept (this schema)
sn	`string`	Required	No	calibrate_left_intercept (this schema)
version	`const`	Optional	No	calibrate_left_intercept (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_left_intercept"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_mid_point Schema

http://ekoral.io/schema/calibrate_mid_point.json

calibrate_mid_point

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_mid_point.schema.json

calibrate_mid_point Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_mid_point (this schema)
name	`const`	Required	No	calibrate_mid_point (this schema)
sid	`string`	Required	No	calibrate_mid_point (this schema)
sn	`string`	Required	No	calibrate_mid_point (this schema)
version	`const`	Optional	No	calibrate_mid_point (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_mid_point"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_orp_save Schema

http://ekoral.io/schema/calibrate_orp_save.json

calibrate_orp_save

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_orp_save.schema.json

calibrate_orp_save Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_orp_save (this schema)
name	`const`	Required	No	calibrate_orp_save (this schema)
parm	`object`	Required	No	calibrate_orp_save (this schema)
sid	`string`	Required	No	calibrate_orp_save (this schema)
sn	`string`	Required	No	calibrate_orp_save (this schema)
version	`const`	Optional	No	calibrate_orp_save (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_orp_save"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`timestamp`	integer	Required

timestamp

timestamp

is required
type: integer

timestamp Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_ph_save Schema

http://ekoral.io/schema/calibrate_ph_save.json

calibrate_ph_save

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_ph_save.schema.json

calibrate_ph_save Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_ph_save (this schema)
name	`const`	Required	No	calibrate_ph_save (this schema)
parm	`object`	Required	No	calibrate_ph_save (this schema)
sid	`string`	Required	No	calibrate_ph_save (this schema)
sn	`string`	Required	No	calibrate_ph_save (this schema)
version	`const`	Optional	No	calibrate_ph_save (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_ph_save"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`timestamp`	integer	Required

timestamp

timestamp

is required
type: integer

timestamp Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_right_intercept Schema

http://ekoral.io/schema/calibrate_right_intercept.json

calibrate_right_intercept

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_right_intercept.schema.json

calibrate_right_intercept Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_right_intercept (this schema)
name	`const`	Required	No	calibrate_right_intercept (this schema)
sid	`string`	Required	No	calibrate_right_intercept (this schema)
sn	`string`	Required	No	calibrate_right_intercept (this schema)
version	`const`	Optional	No	calibrate_right_intercept (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_right_intercept"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_single_point Schema

http://ekoral.io/schema/calibrate_single_point.json

calibrate_single_point

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_single_point.schema.json

calibrate_single_point Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_single_point (this schema)
name	`const`	Required	No	calibrate_single_point (this schema)
parm	`object`	Required	No	calibrate_single_point (this schema)
sid	`string`	Required	No	calibrate_single_point (this schema)
sn	`string`	Required	No	calibrate_single_point (this schema)
version	`const`	Optional	No	calibrate_single_point (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_single_point"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`value`	integer	Optional

value

value

is optional
type: integer

value Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

calibrate_wet Schema

http://ekoral.io/schema/calibrate_wet.json

calibrate_wet

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	calibrate_wet.schema.json

calibrate_wet Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	calibrate_wet (this schema)
name	`const`	Required	No	calibrate_wet (this schema)
parm	`object`	Required	No	calibrate_wet (this schema)
sid	`string`	Required	No	calibrate_wet (this schema)
sn	`string`	Required	No	calibrate_wet (this schema)
version	`const`	Optional	No	calibrate_wet (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"calibrate_wet"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`value`	integer	Required

value

value

is required
type: integer

value Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

configure_dosing Schema

http://ekoral.io/schema/configure_dosing.json

Configure name and group of eK Doser

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	configure_dosing.schema.json

configure_dosing Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	configure_dosing (this schema)
name	`const`	Required	No	configure_dosing (this schema)
parm	`object`	Required	No	configure_dosing (this schema)
sid	`string`	Required	No	configure_dosing (this schema)
sn	`string`	Required	No	configure_dosing (this schema)
version	`const`	Optional	No	configure_dosing (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"configure_dosing"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`group`	integer	Optional
`name`	string	Optional

group

group

is optional
type: integer

group Type

integer

name

name

is optional
type: string

name Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

p_activate_ota Schema

http://ekoral.io/schema/p_activate_ota.json

p_activate_ota

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	p_activate_ota.schema.json

p_activate_ota Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	p_activate_ota (this schema)
name	`const`	Required	No	p_activate_ota (this schema)
parm	`object`	Required	No	p_activate_ota (this schema)
sid	`string`	Required	No	p_activate_ota (this schema)
sn	`string`	Required	No	p_activate_ota (this schema)
version	`const`	Optional	No	p_activate_ota (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"p_activate_ota"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`key`	string	Required

key

key

is required
type: string

key Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

p_configure_alert Schema

http://ekoral.io/schema/p_configure_alert.json

p_configure_alert

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	p_configure_alert.schema.json

p_configure_alert Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	p_configure_alert (this schema)
name	`const`	Required	No	p_configure_alert (this schema)
parm	`object`	Required	No	p_configure_alert (this schema)
sid	`string`	Required	No	p_configure_alert (this schema)
sn	`string`	Required	No	p_configure_alert (this schema)
version	`const`	Optional	No	p_configure_alert (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"p_configure_alert"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`action`	string	Required
`max`	number	Optional
`min`	number	Optional
`notify_max`	boolean	Optional
`notify_min`	boolean	Optional
`value_type`	string	Required

action

action

is required
type: enum

The value of this property must be equal to one of the known values below.

action Known Values

Value	Description
`create`
`update`
`delete`

max

max

is optional
type: number

max Type

number

min

min

is optional
type: number

min Type

number

notify_max

notify_max

is optional
type: boolean

notify_max Type

boolean

notify_min

notify_min

is optional
type: boolean

notify_min Type

boolean

value_type

value_type

is required
type: string

value_type Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

p_configure_module Schema

http://ekoral.io/schema/p_configure_module.json

p_configure_module

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	p_configure_module.schema.json

p_configure_module Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	p_configure_module (this schema)
name	`const`	Required	No	p_configure_module (this schema)
parm	`object`	Required	No	p_configure_module (this schema)
sid	`string`	Required	No	p_configure_module (this schema)
sn	`string`	Required	No	p_configure_module (this schema)
version	`const`	Optional	No	p_configure_module (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"p_configure_module"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`mode`	string	Optional
`name`	string	Optional

mode

mode

is optional
type: string

mode Type

string

name

name

is optional
type: string

name Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

p_connect_ap Schema

http://ekoral.io/schema/p_connect_ap.json

p_connect_ap

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	p_connect_ap.schema.json

p_connect_ap Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	p_connect_ap (this schema)
name	`const`	Required	No	p_connect_ap (this schema)
parm	`object`	Required	No	p_connect_ap (this schema)
sid	`string`	Required	No	p_connect_ap (this schema)
sn	`string`	Required	No	p_connect_ap (this schema)
version	`const`	Optional	No	p_connect_ap (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"p_connect_ap"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`password`	string	Optional
`ssid`	string	Optional

password

password

is optional
type: string

password Type

string

ssid

ssid

is optional
type: string

ssid Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

p_set_time Schema

http://ekoral.io/schema/p_set_time.json

p_set_time

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	p_set_time.schema.json

p_set_time Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	p_set_time (this schema)
name	`const`	Required	No	p_set_time (this schema)
parm	`object`	Required	No	p_set_time (this schema)
sid	`string`	Required	No	p_set_time (this schema)
sn	`string`	Required	No	p_set_time (this schema)
version	`const`	Optional	No	p_set_time (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"p_set_time"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`day`	integer	Required
`hour`	integer	Required
`minute`	integer	Required
`month`	integer	Required
`second`	integer	Optional
`timezone`	string	Required
`timezone_offset`	number	Required
`year`	integer	Required

day

day

is required
type: integer

day Type

integer

minimum value: 1
maximum value: 31

hour

hour

is required
type: integer

hour Type

integer

minimum value: 0
maximum value: 23

minute

minute

is required
type: integer

minute Type

integer

minimum value: 0
maximum value: 59

month

month

is required
type: integer

month Type

integer

minimum value: 1
maximum value: 12

second

second

is optional
type: integer

second Type

integer

minimum value: 0
maximum value: 59

timezone

timezone

is required
type: string

timezone Type

string

timezone_offset

timezone_offset

is required
type: number

timezone_offset Type

number

minimum value: -12
maximum value: 14

year

year

is required
type: integer

year Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

refill_dosing_port Schema

http://ekoral.io/schema/refill_dosing_port.json

refill_dosing_port

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	refill_dosing_port.schema.json

refill_dosing_port Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	refill_dosing_port (this schema)
name	`const`	Required	No	refill_dosing_port (this schema)
parm	`object`	Required	No	refill_dosing_port (this schema)
sid	`string`	Required	No	refill_dosing_port (this schema)
sn	`string`	Required	No	refill_dosing_port (this schema)
version	`const`	Optional	No	refill_dosing_port (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"refill_dosing_port"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`fill_level`	number	Required
`port`	integer	Required

fill_level

fill_level

is required
type: number

fill_level Type

number

port

port

is required
type: integer

port Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

remove_dosing_schedule Schema

http://ekoral.io/schema/remove_dosing_schedule.json

remove_dosing_schedule

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	remove_dosing_schedule.schema.json

remove_dosing_schedule Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	remove_dosing_schedule (this schema)
name	`const`	Required	No	remove_dosing_schedule (this schema)
parm	`object`	Required	No	remove_dosing_schedule (this schema)
sid	`string`	Required	No	remove_dosing_schedule (this schema)
sn	`string`	Required	No	remove_dosing_schedule (this schema)
version	`const`	Optional	No	remove_dosing_schedule (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"remove_dosing_schedule"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`id`	array	Required

id

id

is required
type: integer[]

id Type

Array type: integer[]

All items must be of the type: integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

set_dosing_port Schema

http://ekoral.io/schema/set_dosing_port.json

set_dosing_port

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	set_dosing_port.schema.json

set_dosing_port Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	set_dosing_port (this schema)
name	`const`	Required	No	set_dosing_port (this schema)
parm	`object`	Required	No	set_dosing_port (this schema)
sid	`string`	Required	No	set_dosing_port (this schema)
sn	`string`	Required	No	set_dosing_port (this schema)
version	`const`	Optional	No	set_dosing_port (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"set_dosing_port"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`alert`	boolean	Optional
`capacity`	number	Optional
`minimum`	number	Optional
`name`	string	Optional
`port`	integer	Optional

alert

alert

is optional
type: boolean

alert Type

boolean

capacity

capacity

is optional
type: number

capacity Type

number

minimum

minimum

is optional
type: number

minimum Type

number

name

name

is optional
type: string

name Type

string

port

port

is optional
type: integer

port Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

set_dosing_schedule Schema

http://ekoral.io/schema/set_dosing_schedule.json

set_dosing_schedule

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	set_dosing_schedule.schema.json

set_dosing_schedule Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	set_dosing_schedule (this schema)
name	`const`	Required	No	set_dosing_schedule (this schema)
parm	`object`	Required	No	set_dosing_schedule (this schema)
sid	`string`	Required	No	set_dosing_schedule (this schema)
sn	`string`	Required	No	set_dosing_schedule (this schema)
version	`const`	Optional	No	set_dosing_schedule (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"set_dosing_schedule"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`days`	array	Optional
`enable`	boolean	Required
`end`	object	Optional
`id`	integer	Optional
`ml`	number	Optional
`permit`	boolean	Optional
`port`	integer	Optional
`start`	object	Optional
`times`	integer	Optional

days

days

is optional
type: integer[]

days Type

Array type: integer[]

All items must be of the type: integer

minimum value: 1
maximum value: 7

enable

enable

is required
type: boolean

enable Type

boolean

end

end

is optional
type: object

end Type

object with following properties:

Property	Type	Required
`hr`	integer	Optional
`min`	integer	Optional

hr

hr

is optional
type: integer

hr Type

integer

minimum value: 0
maximum value: 23

min

min

is optional
type: integer

min Type

integer

minimum value: 0
maximum value: 59

id

id

is optional
type: integer

id Type

integer

ml

ml

is optional
type: number

ml Type

number

minimum value: 0

permit

permit

is optional
type: boolean

permit Type

boolean

port

port

is optional
type: integer

port Type

integer

start

start

is optional
type: object

start Type

object with following properties:

Property	Type	Required
`hr`	integer	Optional
`min`	integer	Optional

hr

hr

is optional
type: integer

hr Type

integer

minimum value: 0
maximum value: 23

min

min

is optional
type: integer

min Type

integer

minimum value: 0
maximum value: 59

times

times

is optional
type: integer

times Type

integer

minimum value: 1
maximum value: 24

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

set_ec_calibration Schema

http://ekoral.io/schema/set_ec_calibration.json

set_ec_calibration

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	set_ec_calibration.schema.json

set_ec_calibration Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	set_ec_calibration (this schema)
name	`const`	Required	No	set_ec_calibration (this schema)
parm	`object`	Required	No	set_ec_calibration (this schema)
sid	`string`	Required	No	set_ec_calibration (this schema)
sn	`string`	Required	No	set_ec_calibration (this schema)
version	`const`	Optional	No	set_ec_calibration (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"set_ec_calibration"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`datum`	number	Optional
`oscv`	number	Optional
`solution`	number	Optional
`temperature`	number	Optional

datum

datum

is optional
type: number

datum Type

number

oscv

oscv

is optional
type: number

oscv Type

number

solution

solution

is optional
type: number

solution Type

number

temperature

temperature

is optional
type: number

temperature Type

number

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

set_ec_kvalue Schema

http://ekoral.io/schema/set_ec_kvalue.json

set_ec_kvalue

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	set_ec_kvalue.schema.json

set_ec_kvalue Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	set_ec_kvalue (this schema)
name	`const`	Required	No	set_ec_kvalue (this schema)
parm	`object`	Required	No	set_ec_kvalue (this schema)
sid	`string`	Required	No	set_ec_kvalue (this schema)
sn	`string`	Required	No	set_ec_kvalue (this schema)
version	`const`	Optional	No	set_ec_kvalue (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"set_ec_kvalue"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`kvalue`	number	Required

kvalue

kvalue

is required
type: number

kvalue Type

number

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

set_orp_calibration Schema

http://ekoral.io/schema/set_orp_calibration.json

set_orp_calibration

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	set_orp_calibration.schema.json

set_orp_calibration Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	set_orp_calibration (this schema)
name	`const`	Required	No	set_orp_calibration (this schema)
parm	`object`	Required	No	set_orp_calibration (this schema)
sid	`string`	Required	No	set_orp_calibration (this schema)
sn	`string`	Required	No	set_orp_calibration (this schema)
version	`const`	Optional	No	set_orp_calibration (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"set_orp_calibration"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`mid_value`	number	Optional
`temperature`	number	Optional

mid_value

mid_value

is optional
type: number

mid_value Type

number

temperature

temperature

is optional
type: number

temperature Type

number

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

set_ph_calibration Schema

http://ekoral.io/schema/set_ph_calibration.json

set_ph_calibration

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	set_ph_calibration.schema.json

set_ph_calibration Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	set_ph_calibration (this schema)
name	`const`	Required	No	set_ph_calibration (this schema)
parm	`object`	Required	No	set_ph_calibration (this schema)
sid	`string`	Required	No	set_ph_calibration (this schema)
sn	`string`	Required	No	set_ph_calibration (this schema)
version	`const`	Optional	No	set_ph_calibration (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"set_ph_calibration"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`left_intercept`	number	Optional
`mid_mv`	number	Optional
`mid_value`	number	Optional
`right_intercept`	number	Optional
`temperature`	number	Optional

left_intercept

left_intercept

is optional
type: number

left_intercept Type

number

mid_mv

mid_mv

is optional
type: number

mid_mv Type

number

mid_value

mid_value

is optional
type: number

mid_value Type

number

right_intercept

right_intercept

is optional
type: number

right_intercept Type

number

temperature

temperature

is optional
type: number

temperature Type

number

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

control_dosing Schema

http://ekoral.io/schema/control_dosing.json

control_dosing

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	control_dosing.schema.json

control_dosing Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	control_dosing (this schema)
name	`const`	Required	No	control_dosing (this schema)
parm	`object`	Required	No	control_dosing (this schema)
sid	`string`	Required	No	control_dosing (this schema)
sn	`string`	Required	No	control_dosing (this schema)
version	`const`	Optional	No	control_dosing (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"control_dosing"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`ml`	number	Required
`permit`	boolean	Optional
`port`	integer	Required

ml

ml

is required
type: number

ml Type

number

permit

permit

is optional
type: boolean

permit Type

boolean

port

port

is required
type: integer

port Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

p_reboot Schema

http://ekoral.io/schema/p_reboot.json

p_reboot

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	p_reboot.schema.json

p_reboot Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	p_reboot (this schema)
name	`const`	Required	No	p_reboot (this schema)
sid	`string`	Required	No	p_reboot (this schema)
sn	`string`	Required	No	p_reboot (this schema)
version	`const`	Optional	No	p_reboot (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"p_reboot"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_calibration Schema

http://ekoral.io/schema/get_calibration.json

get_calibration

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_calibration.schema.json

get_calibration Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_calibration (this schema)
name	`const`	Required	No	get_calibration (this schema)
sid	`string`	Required	No	get_calibration (this schema)
sn	`string`	Required	No	get_calibration (this schema)
version	`const`	Optional	No	get_calibration (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_calibration"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_dosing_log Schema

http://ekoral.io/schema/get_dosing_log.json

get_dosing_log

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_dosing_log.schema.json

get_dosing_log Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_dosing_log (this schema)
name	`const`	Required	No	get_dosing_log (this schema)
parm	`object`	Required	No	get_dosing_log (this schema)
sid	`string`	Required	No	get_dosing_log (this schema)
sn	`string`	Required	No	get_dosing_log (this schema)
version	`const`	Optional	No	get_dosing_log (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_dosing_log"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`port`	integer	Required
`type`	string	Required

port

port

is required
type: integer

port Type

integer

type

type

is required
type: string

type Type

string

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_dosing_schedule Schema

http://ekoral.io/schema/get_dosing_schedule.json

get_dosing_schedule

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_dosing_schedule.schema.json

get_dosing_schedule Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_dosing_schedule (this schema)
name	`const`	Required	No	get_dosing_schedule (this schema)
parm	`object`	Required	No	get_dosing_schedule (this schema)
sid	`string`	Required	No	get_dosing_schedule (this schema)
sn	`string`	Required	No	get_dosing_schedule (this schema)
version	`const`	Optional	No	get_dosing_schedule (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_dosing_schedule"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`group`	integer	Optional

group

group

is optional
type: integer

group Type

integer

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

get_schedule_task Schema

http://ekoral.io/schema/get_schedule_task.json

get_schedule_task

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	get_schedule_task.schema.json

get_schedule_task Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	get_schedule_task (this schema)
name	`const`	Required	No	get_schedule_task (this schema)
parm	`object`	Required	No	get_schedule_task (this schema)
sid	`string`	Required	No	get_schedule_task (this schema)
sn	`string`	Required	No	get_schedule_task (this schema)
version	`const`	Optional	No	get_schedule_task (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"get_schedule_task"

parm

parm

is required
type: object
defined in this schema

parm Type

object with following properties:

Property	Type	Required
`id`	integer	Required

id

id

is required
type: integer

id Type

integer

minimum value: 1
maximum value: 48

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

manual_status Schema

http://ekoral.io/schema/manual_status.json

manual_status

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	manual_status.schema.json

manual_status Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	manual_status (this schema)
name	`const`	Required	No	manual_status (this schema)
sid	`string`	Required	No	manual_status (this schema)
sn	`string`	Required	No	manual_status (this schema)
version	`const`	Optional	No	manual_status (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"manual_status"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

p_info Schema

http://ekoral.io/schema/p_info.json

p_info

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	p_info.schema.json

p_info Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	p_info (this schema)
name	`const`	Required	No	p_info (this schema)
sid	`string`	Required	No	p_info (this schema)
sn	`string`	Required	No	p_info (this schema)
version	`const`	Optional	No	p_info (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"p_info"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

p_status Schema

http://ekoral.io/schema/p_status.json

p_status

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Experimental	No	Forbidden	Permitted	p_status.schema.json

p_status Properties

Property	Type	Required	Nullable	Defined by
email	`string`	Required	No	p_status (this schema)
name	`const`	Required	No	p_status (this schema)
sid	`string`	Required	No	p_status (this schema)
sn	`string`	Required	No	p_status (this schema)
version	`const`	Optional	No	p_status (this schema)
`*`	any	Additional	Yes	this schema allows additional properties

email

eKoral member email address

email

is required
type: string
defined in this schema

email Type

string

format: email – email address (according to RFC 5322, section 3.4.1)

name

api name

name

is required
type: const
defined in this schema

The value of this property must be equal to:

"p_status"

sid

session id

sid

is required
type: string
defined in this schema

sid Type

string

sn

Serial number

sn

is required
type: string
defined in this schema

sn Type

string

version

API version 1, if not specified, default is 1

version

is optional
type: const
defined in this schema

The value of this property must be equal to:

API

General Information

Usage and Example

Examples

Get access toke

Authenticate

Read history raw data

Read history aggregated data

Get device details in the controller.

Application type

API List and Scope

Member API (type member)

eK Core, eK Hub API (type eko)

eK Doser, eK Module API (type peripheral)

authenticate Schema

authenticate Properties

name

parm

parm Type

access_token

access_token Type

detail

detail Type

email

email Type

Option 1

Option 2

first_name

first_name Type

identifier

identifier Type

last_name

last_name Type

mobile

mobile Type

openid

openid Type

password

password Type

source

source Known Values

version

check_app_update Schema

check_app_update Properties

name

parm

parm Type

application

application Type

version

version Type

version

get_invitation Schema

get_invitation Properties

name

parm

parm Type

sn

sn Type

Condition 1

Condition 2

sid

sid Type

version

get_miniboards Schema

get_miniboards Properties

name

sid

sid Type

version

get_reading_history Schema

get_reading_history Properties

name

parm

parm Type

collection

collection Known Values

limit

limit Type

query