API docs by Redocly

api.cv1-core (7.55.0)

Download OpenAPI specification:

JCS CONFLUENCE WIKI for CLOUD v1

JCS CLOUD v1 - REST API SPECIFICATION

Overview of HTTP status error codes used

Success

  • 200 - Success - body contains JSON object
  • 201 - Created - body contains created JSON object
  • 202 - Accepted - request has been accepted but not processed yet, it will be processed asynchronously, header Location is returned
  • 204 - Success - without body

Redirects to resource

  • 302 - Found - the requested resource to create already exists, header Location to resource detail is returned and body contains JSON object of resource

Client errors

  • 400 - Bad request - request is not formatted correctly (wrong parameters,...)
  • 401 - Unauthenticated - endpoint request authentication of the user/app and authentication was not successful
  • 402 - Payment required - payment is required to access requested data or perform requested operation
  • 403 - Unauthorized - authenticated user or app is not allowed to access requested data or perform requested operation
  • 404 - Not found - resource, path or method has not been found
  • 409 - Conflict - operation can not be processed because the system is in state that doesn't allow it
  • 422 - Unprocessable entity - operation can not be processed because the request is semantically wrong

Server errors

  • 428 - Precondition required - operation can not be processed because the system is in state that doesn't allow it'
  • 500 - Internal server error

Localization of API responses

The client must send a parameter Accept-Language in every request header to receive localized response. Without this parameter, or in case of unsupported localization, English text will be returned

Arc

Arcs resources

Get active objects connected to given ARC

Authorizations:
KongResolverOAuthJCS
query Parameters
first
integer (Limit) >= 1
Example: first=50

Limits maximum of returned items, can be used together with cursor after for pagination

after
string (Cursor)
Example: after=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value first

last
integer (Limit) >= 1
Example: last=50

Limits maximum of returned items, can be used together with cursor before for pagination

before
string (Cursor)
Example: before=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value last

serialNumber
string (SERIAL_NUMBER_HEX) ^[A-F\d]{8}
Example: serialNumber=F9301214

Serial number in HEX string

registrationKey
string (REGISTRATION_KEY) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: registrationKey=LAS6D-U2VBG-UHX65

Registration key

customerName
string (SearchString) >= 3 characters
Example: customerName=jand

Name of customer (LIKE)

devicePhoneNumber
string (SearchString) >= 3 characters
Example: devicePhoneNumber=jand

Device phone number (LIKE)

objectType[]
Array of strings (ObjectType) non-empty unique
Items Enum: "AC116" "ATHOS" "ATHOS2" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" "JA10" "JA100" "JA100F" "JA100M" "JA100S" "JA90" "OASIS" "PROFI" "TCU" "VOLTA" "DCH"
Example: objectType[]=JA100&objectType[]=JA100F&objectType[]=JA100S&objectType[]=JA100M

Object type

objectNumber
string (ObjectNumber) ^[\dA-F]{4,8}$
Example: objectNumber=F13D

ARC object number (EQUAL)

distributorInstallerId
integer <int64> (DB_INCREMENT_ID) >= 1
Example: distributorInstallerId=242566

Id of distributor installer company (EQUAL)

distributorId
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: distributorId=DISTRIBUTOR_DEFAULT:0012

Id of distributor

endUserLogin
string (SearchString) >= 3 characters
Example: endUserLogin=jand

Login name of end user (LIKE)

objectId
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: objectId=OBJECT_JA100F:242566

Id of object

withLabels[]
Array of strings (ObjectArcLabels) non-empty unique
Items Enum: "NEW_OBJECT" "NEW_CAMERA" "CONNECTED_CAMERA" "ARC_TRANSFER_DISABLED" "REQUESTED_CAMERA" "CONFIGURATION_REQUIRED"
Example: withLabels[]=NEW_OBJECT&withLabels[]=NEW_CAMERA

List of wanted active labels

arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: arcEntityId=ARC_CLOUD:00008808

Cloud entity id of ARC

arcTemplateSetId
number (IntId) >= 1

ID of ARC template set

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageInfo": {
    }
}

Export active objects connected to given ARC

Authorizations:
KongResolverOAuthJCS
query Parameters
serialNumber
string (SERIAL_NUMBER_HEX) ^[A-F\d]{8}
Example: serialNumber=F9301214

Serial number in HEX string

registrationKey
string (REGISTRATION_KEY) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: registrationKey=LAS6D-U2VBG-UHX65

Registration key

customerName
string (SearchString) >= 3 characters
Example: customerName=jand

Name of customer (LIKE)

devicePhoneNumber
string (SearchString) >= 3 characters
Example: devicePhoneNumber=jand

Device phone number (LIKE)

objectType[]
Array of strings (ObjectType) non-empty unique
Items Enum: "AC116" "ATHOS" "ATHOS2" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" "JA10" "JA100" "JA100F" "JA100M" "JA100S" "JA90" "OASIS" "PROFI" "TCU" "VOLTA" "DCH"
Example: objectType[]=JA100&objectType[]=JA100F&objectType[]=JA100S&objectType[]=JA100M

Object type

objectNumber
string (ObjectNumber) ^[\dA-F]{4,8}$
Example: objectNumber=F13D

ARC object number (EQUAL)

distributorInstallerId
integer <int64> (DB_INCREMENT_ID) >= 1
Example: distributorInstallerId=242566

Id of distributor installer company (EQUAL)

distributorId
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: distributorId=DISTRIBUTOR_DEFAULT:0012

Id of distributor

endUserLogin
string (SearchString) >= 3 characters
Example: endUserLogin=jand

Login name of end user (LIKE)

withLabels[]
Array of strings (ObjectArcLabels) non-empty unique
Items Enum: "NEW_OBJECT" "NEW_CAMERA" "CONNECTED_CAMERA" "ARC_TRANSFER_DISABLED" "REQUESTED_CAMERA" "CONFIGURATION_REQUIRED"
Example: withLabels[]=NEW_OBJECT&withLabels[]=NEW_CAMERA

List of wanted active labels

arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: arcEntityId=ARC_CLOUD:00008808

Cloud entity id of ARC

arcTemplateSetId
number (IntId) >= 1

ID of ARC template set

Responses

Response samples

Content type
application/json
{
  • "csv": "string"
}

Update bulk objects attributes

Authorizations:
KongResolverOAuthJCS
query Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: arcEntityId=ARC_CLOUD:00008808

Cloud entity id of ARC

objectIds[]
Array of strings (OBJECT_ENTITY) non-empty unique [ items^OBJECT_(\w+):([\d]+)$ ]
Example: objectIds[]=OBJECT_JA100F:242566

List of object entities

Request Body schema: application/json

Objects attributes

arcProcessState
string
Enum: "PROCESSED" "UNPROCESSED"

Responses

Request samples

Content type
application/json
{
  • "arcProcessState": "PROCESSED"
}

Response samples

Content type
application/json
{
  • "arcProcessStateUpdateCount": 0
}

Get specific object connected to given ARC

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "objectId": "OBJECT_JA100F:242566",
  • "timeZone": "Europe/Prague",
  • "objectNumber": "F13D",
  • "installer": {},
  • "distributor": {},
  • "arcConnectedDate": "2019-08-24T14:15:22Z",
  • "transferDisabledDate": "2019-08-24T14:15:22Z",
  • "photoVerificationUrl": "https://subdomain.domain.tld/path?query#anchor",
  • "videoVerificationUrl": "https://subdomain.domain.tld/path?query#anchor",
  • "hasActiveCamera": false,
  • "device": {
    },
  • "labels": [
    ],
  • "template": {
    },
  • "customer": {
    },
  • "endUsersAccesses": [
    ]
}

Update object attributes

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Request Body schema: application/json

Object attributes

arcProcessState
string
Enum: "PROCESSED" "UNPROCESSED"

Responses

Request samples

Content type
application/json
{
  • "arcProcessState": "PROCESSED"
}

Response samples

Content type
application/json
{
  • "arcProcessStateUpdateCount": 0
}

Update object settings

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Request Body schema: application/json

Object setting action

One of
$type
required
string
Value: "ARC_TRANSFER"
enabled
required
boolean
Default: true

Responses

Request samples

Content type
application/json
Example
{
  • "$type": "ARC_TRANSFER",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "arcObjectNumber": "F13D"
}

Get object contacts

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{}

Get objects configuration for ARC

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "sections": [
    ],
  • "users": [
    ],
  • "components": [
    ],
  • "lastConfigurationUpdateDate": "2019-08-24T14:15:22Z"
}

Request configuration download for ARC Deprecated

This endpoint is deprecated. Use arcUpdateObjectSettings with DOWNLOAD_CONFIGURATION action instead.

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "requestId": "DCD-1254445521"
}

Control remotely security system by given user code

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Request Body schema: application/json
required

Control action object

Array of objects (Authorizations) [ 1 .. 2 ] items unique

Authorization data for control to identify the user on the device

required
Array of SECTION_COMMAND (object) or ACTOR_COMMAND (object) or PERIPHERAL_COMMAND (object) or PICTURE_COMMAND (object) or DEVICE_CONFIGURATION (object) or DEVICE_STATUS (object) or DEVICE_EVENTS (object) or DEVICE_RESET (object) or CHECK_AUTHORIZATION (object) (ControlActions) non-empty unique

List of wanted control actions

Responses

Request samples

Content type
application/json
{
  • "authorizations": [
    ],
  • "controls": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "controls": [
    ],
  • "states": [
    ]
}

Get object logs

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

query Parameters
first
integer (Limit) >= 1
Example: first=50

Limits maximum of returned items, can be used together with cursor after for pagination

after
string (Cursor)
Example: after=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value first

last
integer (Limit) >= 1
Example: last=50

Limits maximum of returned items, can be used together with cursor before for pagination

before
string (Cursor)
Example: before=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value last

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageInfo": {
    }
}

Get distributor companies for ARC

Authorizations:
KongResolverOAuthJCS
query Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: arcEntityId=ARC_CLOUD:00008808

Cloud entity id of ARC

objectsCount
boolean
Default: false

Include count of active objects under each company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get available distributor installer companies

Authorizations:
KongResolverOAuthJCS
query Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: arcEntityId=ARC_CLOUD:00008808

Cloud entity id of ARC

distributorId
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: distributorId=DISTRIBUTOR_DEFAULT:0012

Id of distributor

objectsCount
boolean
Default: false

Include count of active objects under each company

installerCompanyName
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters
Example: installerCompanyName=Company s.r.o.

Name of installer company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get arc companies for logged user

Authorizations:
KongResolverOAuthJCS

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get ARC company information

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
{
  • "arcId": "ARC_CLOUD:00008808",
  • "name": "Company s.r.o.",
  • "hasDefaultTemplate": false,
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "countryCode": "CZ",
  • "helpdeskEmail": "tomas.janda@jablotron.cz",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "description": "Common description of entity up to 255 characters",
  • "autoTransferDisabled": true,
  • "companyLogoUrl": "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200",
  • "me": {
    }
}

Update ARC company information

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Request Body schema: application/json

Company information

COMPANY_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

ZIP (string) or null

null only for PATCH to remove current value

countryCode
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

EMAIL (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

EMAIL (string) or null

null only for PATCH to remove current value

shareContacts
boolean (ShareContacts)

Company want to share phone number and email address with end users

LogoData (string) or null

null only for PATCH to remove current logo

Description (string) or null

null only for PATCH to remove current value

boolean or null

null only for PATCH to remove current value

name
string (CommonCompanyName) [ 1 .. 70 ] characters

Responses

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "countryCode": "CZ",
  • "helpdeskEmail": "tomas.janda@jablotron.cz",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "description": "Common description of entity up to 255 characters",
  • "autoTransferDisabled": true,
  • "name": "Company s.r.o."
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get ARC global settings

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
{
  • "ipAddressApplication": [
    ],
  • "autoTransferDisabled": false,
  • "meta": {
    }
}

Update ARC global settings

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Request Body schema: application/json

List of IP addresses

non-empty
ipAddressApplication
Array of strings (IpAddressApplicationModule) >= 0 items unique
Items Enum: "MY_ARC" "CAMERA_VERIFICATION"
autoTransferDisabled
boolean

ARC has disabled data transfer to ARC from new objects by default. DIRECT ARC has always this value set to false and cannot be changed.

Responses

Request samples

Content type
application/json
{
  • "ipAddressApplication": [
    ],
  • "autoTransferDisabled": true
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get users under ARC company

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user under ARC company

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Request Body schema: application/json

User attributes

userLogin
required
string <email> (Email)

Email address

role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
setDefaultNotifications
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "role": "USER",
  • "setDefaultNotifications": true
}

Response samples

Content type
application/json
{
  • "arcUserId": 242566,
  • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
  • "lastLoggedDate": "2019-08-24T14:15:22Z",
  • "userLogin": "tomas.janda@jablotron.cz",
  • "role": "USER"
}

Update user under ARC company

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Request Body schema: application/json

User attributes

role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"

Responses

Request samples

Content type
application/json
{
  • "role": "USER"
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Remove user under ARC company

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get ARC IP addresses

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
[
  • "169.124.56.3"
]

Update list of ARC IP addresses

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Request Body schema: application/json

List of IP addresses

Array (>= 0 items)
One of
string <ipv4> (IPV4)

Responses

Request samples

Content type
application/json
[
  • "169.124.56.3"
]

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get ARC notifications

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create notification under ARC company

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Request Body schema: application/json

Notification attributes

targetType
required
string
Value: "EMAIL"
target
required
string <email> (Email)

Email address

categories
required
Array of strings (NotificationCategory) non-empty unique
Items Enum: "ARC_CONNECTED" "ARC_REMOVED" "CAMERA_REQUESTED" "MAINTENANCE"
languageCode
required
string (LanguageCode)
Enum: "CS" "DA" "DE" "EL" "EN" "ES" "FI" "FR" "HR" "HU" "IT" "NL" "NO" "PL" "PT" "RO" "RU" "SK" "SL" "SR" "SV" "TR" "UK" "VI" "ET"

Responses

Request samples

Content type
application/json
{
  • "targetType": "EMAIL",
  • "target": "tomas.janda@jablotron.cz",
  • "categories": [
    ],
  • "languageCode": "CS"
}

Response samples

Content type
application/json
{
  • "notificationId": 242566,
  • "lastUpdate": "2019-08-24T14:15:22Z",
  • "lastUpdateUserId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
  • "targetType": "EMAIL",
  • "target": "tomas.janda@jablotron.cz",
  • "categories": [
    ],
  • "languageCode": "CS"
}

Remove ARC notification contact

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

intId
required
number (IntId) >= 1

Common Int id

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Update ARC notification contact categories

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

intId
required
number (IntId) >= 1

Common Int id

Request Body schema: application/json

Notification attributes

categories
required
Array of strings (NotificationCategory) non-empty unique
Items Enum: "ARC_CONNECTED" "ARC_REMOVED" "CAMERA_REQUESTED" "MAINTENANCE"

Responses

Request samples

Content type
application/json
{
  • "categories": [
    ]
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get logged user information

Authorizations:
KongResolverOAuthJCS

Responses

Response samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
  • "confirmPhoneNumber": "+420739259931",
  • "personName": "Jan Tron",
  • "newsletterAllowed": true
}

Update logged user information

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Changed values

non-empty
PHONE_NUMBER (string) or null
NAME_AND_SURNAME (string) or null
newsletterAllowed
boolean

Responses

Request samples

Content type
application/json
{
  • "confirmPhoneNumber": "+420739259931",
  • "personName": "Jan Tron",
  • "newsletterAllowed": true
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get ARC template sets

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create ARC template set under ARC company

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Request Body schema: application/json

ARC template set attributes

name
required
string (ArcTemplateSetName) non-empty
isDefault
required
boolean

default false

secondaryTemplateIsBackup
boolean

If true, secondaryTemplate has to be set

required
object (ArcTemplateExtended)
object (ArcTemplateExtended)

Responses

Request samples

Content type
application/json
{
  • "name": "SIA with retry",
  • "isDefault": true,
  • "secondaryTemplateIsBackup": false,
  • "primaryTemplate": {
    },
  • "secondaryTemplate": {
    }
}

Response samples

Content type
application/json
{
  • "templateSetId": 1,
  • "name": "SIA with retry",
  • "isDefault": true,
  • "secondaryTemplateIsBackup": false,
  • "primaryTemplate": {
    },
  • "secondaryTemplate": {
    },
  • "canBeSetAsDefault": true,
  • "isDeprecated": false
}

Get detail of ARC template set

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

arcTemplateSetId
required
number (IntId) >= 1

ID of ARC template set

Responses

Response samples

Content type
application/json
{
  • "name": "SIA with retry",
  • "isDefault": true,
  • "secondaryTemplateIsBackup": false,
  • "primaryTemplate": {
    },
  • "secondaryTemplate": {
    },
  • "canBeSetAsDefault": true,
  • "isDeprecated": false,
  • "templateSetId": 1,
  • "activeObjects": 4
}

Update ARC template set under ARC company

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

arcTemplateSetId
required
number (IntId) >= 1

ID of ARC template set

Request Body schema: application/json

ARC template set attributes

name
string (ArcTemplateSetName) non-empty
isDefault
boolean

default false

secondaryTemplateIsBackup
boolean

If true, secondaryTemplate has to be set

object (ArcTemplatePatch)
object (ArcTemplatePatch)
reconfigureObjects
boolean
Default: false

If true, it will return number of reconfigured objects

Responses

Request samples

Content type
application/json
{
  • "name": "SIA with retry",
  • "isDefault": true,
  • "secondaryTemplateIsBackup": false,
  • "primaryTemplate": {
    },
  • "secondaryTemplate": {
    },
  • "reconfigureObjects": false
}

Response samples

Content type
application/json
{
  • "reconfigurationRequests": [
    ]
}

Remove ARC template set

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

arcTemplateSetId
required
number (IntId) >= 1

ID of ARC template set

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Reconfigure all objects under given template set

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

arcTemplateSetId
required
number (IntId) >= 1

ID of ARC template set

Request Body schema: application/json

ARC template objects set attributes

One of
$type
required
string
Value: "RECONFIGURATION"

Responses

Request samples

Content type
application/json
{
  • "$type": "RECONFIGURATION"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get the status of a device configuration manager request

Authorizations:
KongResolverOAuthJCS
path Parameters
requestId
required
string (REQUEST_ID) >= 5 characters
Example: DCD-1254445521

Returns if an action was created in the device configuration manager (configuration download, reconfiguration ...)

Responses

Response samples

Content type
application/json
{
  • "requestId": "DCD-1254445521",
  • "state": "CREATED",
  • "type": "SETTING",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "success": true,
  • "error": {
    },
  • "meta": {
    }
}

System

System resources

Get url of ACOBA video clip

Authorizations:
KongResolverOAuthJCS
path Parameters
attachmentId
required
string (MEDIA_EVENT_ID) ^(PICTURE)-(\d+)$|^VIDEO-([[0-9a-fA-F\-]{36})...
Example: VIDEO-123e4567-e89b-12d3-a456-426655440000

Id of attachment

Responses

Response samples

Content type
application/json
{}

Get object state for ARC verification state

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "alarm": {
    }
}

Get component states

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

query Parameters
componentType
Array of strings (EndUserComponentType) non-empty unique
Items Enum: "SECTION" "ACTOR" "CAMERA" "THERMOMETER" "PULSE_METER"

Type of cloud component, default is SECTION

mockUserId
number (IntId) >= 1

UserAccountId for system, mock logged user

Responses

Response samples

Content type
application/json
{
  • "sections": [
    ],
  • "actors": [
    ],
  • "cameras": [
    ],
  • "customCameras": [
    ],
  • "cameraDetectors": [
    ],
  • "thermometers": [
    ],
  • "thermostats": [
    ],
  • "pulseMeters": [
    ]
}

Get actual current object states

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "service": false,
  • "sections": [
    ],
  • "actors": [
    ]
}

Sync component states to Kafka

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Responses

Response samples

Content type
application/json
{
  • "correlationId": "api.cv1-core-2cea8c53-5da1-4f05-b229-ec5a0be27b1e"
}

Get service widget state for system

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "global": {
    },
  • "components": [
    ]
}

Control remotely security system by given code

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Request Body schema: application/json
required

Control action object

Array of objects (Authorizations) [ 1 .. 2 ] items unique

Authorization data for control to identify the user on the device

required
Array of SECTION_COMMAND (object) or ACTOR_COMMAND (object) or PERIPHERAL_COMMAND (object) or PICTURE_COMMAND (object) or DEVICE_CONFIGURATION (object) or DEVICE_STATUS (object) or DEVICE_EVENTS (object) or DEVICE_RESET (object) or CHECK_AUTHORIZATION (object) (ControlActions) non-empty unique

List of wanted control actions

Responses

Request samples

Content type
application/json
{
  • "authorizations": [
    ],
  • "controls": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "controls": [
    ],
  • "states": [
    ]
}

Control remotely security system device by given code

Authorizations:
KongResolverOAuthJCS
path Parameters
deviceEntityId
required
string (DEVICE_IDENTITY) ^DEVICE_((JACLOUDSN:[A-F\d]{8})|(JASNV1:[\d]{...
Example: DEVICE_JACLOUDSN:F9100013

Cloud entity id of Device

Request Body schema: application/json
required

Control action object

Array of objects (Authorizations) [ 1 .. 2 ] items unique

Authorization data for control to identify the user on the device

required
Array of SECTION_COMMAND (object) or ACTOR_COMMAND (object) or PERIPHERAL_COMMAND (object) or PICTURE_COMMAND (object) or DEVICE_CONFIGURATION (object) or DEVICE_STATUS (object) or DEVICE_EVENTS (object) or DEVICE_RESET (object) or CHECK_AUTHORIZATION (object) (ControlActions) non-empty unique

List of wanted control actions

devicePhoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$

Phone number of device to RING from YTUN server (for non-persistent devices)

Responses

Request samples

Content type
application/json
{
  • "authorizations": [
    ],
  • "controls": [
    ],
  • "devicePhoneNumber": "+420739259931"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "controls": [
    ],
  • "states": [
    ]
}

Register Dial controller and create CLOUD account

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Registration params

required
DEVICE_IDENTITY (string) or REGISTRATION_KEY (string)
serviceName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters

Name of object or service

timeZone
required
string (TimeZone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Port_of_Spain" "America/Puerto_Rico" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santa_Isabel" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Ho_Chi_Minh" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/Stanley" "Atlantic/St_Helena" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

IANA timezone definition

countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

ownerLoginName
required
string <email> (Email)

Email address

Responses

Request samples

Content type
application/json
{
  • "deviceIdentification": "DEVICE_JACLOUDSN:F9100013",
  • "serviceName": "My House",
  • "timeZone": "Europe/Prague",
  • "countryCode": "CZ",
  • "ownerLoginName": "tomas.janda@jablotron.cz"
}

Response samples

Content type
application/json
{
  • "serviceEntityId": "SERVICE_JA100F:242566",
  • "objectEntityId": "OBJECT_JA100F:242566"
}

Register Dial controller and create CLOUD account

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Registration params

required
DEVICE_IDENTITY (string) or REGISTRATION_KEY (string)
serviceName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters

Name of object or service

timeZone
required
string (TimeZone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Port_of_Spain" "America/Puerto_Rico" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santa_Isabel" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Ho_Chi_Minh" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/Stanley" "Atlantic/St_Helena" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

IANA timezone definition

countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

ownerLoginName
required
string <email> (Email)

Email address

Responses

Request samples

Content type
application/json
{
  • "deviceIdentification": "DEVICE_JACLOUDSN:F9100013",
  • "serviceName": "My House",
  • "timeZone": "Europe/Prague",
  • "countryCode": "CZ",
  • "ownerLoginName": "tomas.janda@jablotron.cz"
}

Response samples

Content type
application/json
{
  • "serviceEntityId": "SERVICE_JA100F:242566",
  • "objectEntityId": "OBJECT_JA100F:242566"
}

Register user account to device

Registers the user account for the given device registration flow and sends the registration email.

The backend returns a successful response both when a new account is created and when the account already exists. The response does not expose which branch was taken.

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

User account registration params

loginName
required
string <email> (Email)

Email address

Responses

Request samples

Content type
application/json
{
  • "loginName": "tomas.janda@jablotron.cz"
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Register user account to Indexa device

Registers the user account for the given Indexa device registration flow and sends the registration email.

The backend returns a successful response both when a new account is created and when the account already exists. The response does not expose which branch was taken.

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Account registration params

loginName
required
string <email> (Email)

Email address

authorizationCode
required
string (IndexaAuthorizationCode) ^[A-F0-9]{16}$
registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...

Responses

Request samples

Content type
application/json
{
  • "loginName": "tomas.janda@jablotron.cz",
  • "authorizationCode": "A1B2C3D4E5F60708",
  • "registrationKey": "LAS6D-U2VBG-UHX65"
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Parse TCSPKU Protocol

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json
required

Protocol payloads

format
required
string
Enum: "JSON" "CLI"
required
Array of objects (PayloadItemRequest) [ 1 .. 2 ] items unique

Responses

Request samples

Content type
application/json
{
  • "format": "JSON",
  • "payloads": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get service access settings

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
{
  • "accesses": [
    ]
}

Update installer company information

Authorizations:
KongResolverOAuthJCS
path Parameters
companyId
required
number (IntId) >= 1

Id of installerCompany

Request Body schema: application/json

Company information

affiliateRegistered
required
boolean (InstallerAffiliate)

Company is registered in affiliate

Responses

Request samples

Content type
application/json
{
  • "affiliateRegistered": false
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Update distributor company information

Authorizations:
KongResolverOAuthJCS
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Request Body schema: application/json

Company information

affiliateRegistered
required
boolean (InstallerAffiliate)

Company is registered in affiliate

Responses

Request samples

Content type
application/json
{
  • "affiliateRegistered": false
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get info about user by given user entity id

Authorizations:
KongResolverOAuthJCS
path Parameters
userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Responses

Response samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
}

Remove active user sessions in cv1

Authorizations:
KongResolverOAuthJCS
path Parameters
userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get notification contacts

Authorizations:
KongResolverOAuthJCS
query Parameters
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
type
string (ContactType)
Enum: "SMS" "VOICE" "PUSH" "EMAIL"
Example: type=PUSH
OBJECT_ENTITY (string) or SERVICE_ENTITY (string)
ownerId
string (CLOUD_USER) ^USER_
Example: ownerId=USER_<OEM_JABLOTRON:Jablotron>:52325

Unique identification of CLOUD user account e.g. USER_<OEM_JABLOTRON:Jablotron>:52325

contactId
string <uuid> (UuidString)
Example: contactId=296ffe8b-2f9e-4c69-939d-5b996b73681f

UUIDv4 of notification contact

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get notification settings

Authorizations:
KongResolverOAuthJCS
query Parameters
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
role
string (NotificationSettingRole)
Enum: "END_USER" "INSTALLER"
Example: role=END_USER

Role of user

OBJECT_ENTITY (string) or SERVICE_ENTITY (string)
ownerId
string (CLOUD_USER) ^USER_
Example: ownerId=USER_<OEM_JABLOTRON:Jablotron>:52325

Unique identification of CLOUD user account e.g. USER_<OEM_JABLOTRON:Jablotron>:52325

contactId
string <uuid> (UuidString)
Example: contactId=296ffe8b-2f9e-4c69-939d-5b996b73681f

UUIDv4 of notification contact

settingId
string (NotificationSettingId) ^(?:SECURITY_SYSTEM|HOME_AUTOMATION)-[0-9(a-f...
Example: settingId=SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f

Id of notification settings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Check user role permission

Authorizations:
KongResolverOAuthJCS
path Parameters
userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Request Body schema: application/json
required

Wanted operations to check

Array (non-empty)
entityId
required
string (EntityId)
Value: "SECURITY-SYSTEM-CONFIGURATION-TOOL"
operationId
required
string (OperationId)
Enum: "END-USER-VIEW" "INSTALLER-VIEW"
Array of objects non-empty

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get list of device configuration manager requests

Authorizations:
KongResolverOAuthJCS
query Parameters
first
integer (Limit) >= 1
Example: first=50

Limits maximum of returned items, can be used together with cursor after for pagination

after
string (Cursor)
Example: after=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value first

last
integer (Limit) >= 1
Example: last=50

Limits maximum of returned items, can be used together with cursor before for pagination

before
string (Cursor)
Example: before=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value last

types[]
Array of strings (ProcessType)
Items Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" "SYNC_LEGACY_THERMOSTAT_STATE" "DEACTIVATE_OBJECT" "CREATE_SERVICE" "FLINK_SETTING"
Example: types[]=SETTING&types[]=DEACTIVATE_OBJECT
states[]
Array of strings (ProcessState)
Items Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
Example: states[]=CREATED&states[]=IN_PROGRESS
errors[]
Array of strings (ProcessErrorType)
Items Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" "ERROR_FOLLOWING_ACTION" "ERROR" "UNKNOWN"
Example: errors[]=UNAUTHORIZED&errors[]=UNPROCESSABLE
REQUEST_ID (string) or DB_INCREMENT_ID_QUERY (string) or DB_INCREMENT_ID (integer)
REQUEST_ID (string) or DB_INCREMENT_ID_QUERY (string) or DB_INCREMENT_ID (integer)
DB_INCREMENT_ID_QUERY (string) or DB_INCREMENT_ID (integer)
OBJECT_ENTITY (string) or DB_INCREMENT_ID_QUERY (string) or DB_INCREMENT_ID (integer)

Cloud entity id of Object

serialNumber
string (SERIAL_NUMBER_HEX) ^[A-F\d]{8}
Example: serialNumber=F9301214

Serial number (HEX) of device

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageInfo": {
    }
}

List of objects for maintenance report for Distributor

Authorizations:
KongResolverOAuthJCS
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

query Parameters
first
integer (Limit) >= 1
Example: first=50

Limits maximum of returned items, can be used together with cursor after for pagination

after
string (Cursor)
Example: after=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value first

last
integer (Limit) >= 1
Example: last=50

Limits maximum of returned items, can be used together with cursor before for pagination

before
string (Cursor)
Example: before=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value last

deviceModel[]
Array of strings (DeviceModel) non-empty unique
Items Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CCU208" "CU07" "CU08" "CU08A" "FUTURA" "FUTURA2" "GD02DIN" "GD04K" "JA100K" "JA101K" "JA101KLAN" "JA101KLAN3G" "JA102K" "JA152K" "JA151KRY" "JA103K" "JA106K" "JA106KLAN3G" "JA107K" "JA108K" "JA14K" "JA60GSM" "JA62GSM" "JA80V" "JA80Y" "JA82Y" "VOLTA" "DC01H"
Example: deviceModel[]=JA107K&deviceModel[]=JA103K&deviceModel[]=JA151KRY

Device model

objectId
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: objectId=OBJECT_JA100F:242566

Id of object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageInfo": {
    }
}

List of objects for maintenance report for Arc

Authorizations:
KongResolverOAuthJCS
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

query Parameters
first
integer (Limit) >= 1
Example: first=50

Limits maximum of returned items, can be used together with cursor after for pagination

after
string (Cursor)
Example: after=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value first

last
integer (Limit) >= 1
Example: last=50

Limits maximum of returned items, can be used together with cursor before for pagination

before
string (Cursor)
Example: before=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value last

deviceModel[]
Array of strings (DeviceModel) non-empty unique
Items Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CCU208" "CU07" "CU08" "CU08A" "FUTURA" "FUTURA2" "GD02DIN" "GD04K" "JA100K" "JA101K" "JA101KLAN" "JA101KLAN3G" "JA102K" "JA152K" "JA151KRY" "JA103K" "JA106K" "JA106KLAN3G" "JA107K" "JA108K" "JA14K" "JA60GSM" "JA62GSM" "JA80V" "JA80Y" "JA82Y" "VOLTA" "DC01H"
Example: deviceModel[]=JA107K&deviceModel[]=JA103K&deviceModel[]=JA151KRY

Device model

objectId
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: objectId=OBJECT_JA100F:242566

Id of object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageInfo": {
    }
}

List of objects for maintenance report for Company

Authorizations:
KongResolverOAuthJCS
path Parameters
companyId
required
number (IntId) >= 1

Id of installerCompany

query Parameters
first
integer (Limit) >= 1
Example: first=50

Limits maximum of returned items, can be used together with cursor after for pagination

after
string (Cursor)
Example: after=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value first

last
integer (Limit) >= 1
Example: last=50

Limits maximum of returned items, can be used together with cursor before for pagination

before
string (Cursor)
Example: before=WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd

Cursor value, can be used together with limits value last

deviceModel[]
Array of strings (DeviceModel) non-empty unique
Items Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CCU208" "CU07" "CU08" "CU08A" "FUTURA" "FUTURA2" "GD02DIN" "GD04K" "JA100K" "JA101K" "JA101KLAN" "JA101KLAN3G" "JA102K" "JA152K" "JA151KRY" "JA103K" "JA106K" "JA106KLAN3G" "JA107K" "JA108K" "JA14K" "JA60GSM" "JA62GSM" "JA80V" "JA80Y" "JA82Y" "VOLTA" "DC01H"
Example: deviceModel[]=JA107K&deviceModel[]=JA103K&deviceModel[]=JA151KRY

Device model

objectId
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: objectId=OBJECT_JA100F:242566

Id of object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageInfo": {
    }
}

EndUser

EndUser resources

Get device diagnostic

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
{
  • "centralUnit": {
    },
  • "gsm": {
    }
}

Get service components states

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

query Parameters
componentType
Array of strings (EndUserComponentType) non-empty unique
Items Enum: "SECTION" "ACTOR" "CAMERA" "THERMOMETER" "PULSE_METER"

Type of cloud component, default is SECTION

Responses

Response samples

Content type
application/json
{
  • "sections": [
    ],
  • "actors": [
    ],
  • "cameras": [
    ],
  • "customCameras": [
    ],
  • "cameraDetectors": [
    ],
  • "thermometers": [
    ],
  • "thermostats": [
    ],
  • "pulseMeters": [
    ]
}

Get service widget state for end user

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
{
  • "global": {
    },
  • "components": [
    ]
}

Get service detail state for end user

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
{
  • "troubles": [
    ],
  • "alarms": [
    ],
  • "maintenances": [
    ],
  • "service": {
    }
}

Control remotely security system by given user code

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Request Body schema: application/json
required

Control action object

Array of objects (Authorizations) [ 1 .. 2 ] items unique

Authorization data for control to identify the user on the device

required
Array of SECTION_COMMAND (object) or ACTOR_COMMAND (object) or PERIPHERAL_COMMAND (object) or PICTURE_COMMAND (object) or DEVICE_CONFIGURATION (object) or DEVICE_STATUS (object) or DEVICE_EVENTS (object) or DEVICE_RESET (object) or CHECK_AUTHORIZATION (object) (ControlActions) non-empty unique

List of wanted control actions

Responses

Request samples

Content type
application/json
{
  • "authorizations": [
    ],
  • "controls": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "controls": [
    ],
  • "states": [
    ]
}

Get service settings

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

query Parameters
meta
boolean
Default: false

Return meta information like list of timezone

Responses

Response samples

Content type
application/json
{
  • "name": "My House",
  • "timeZone": "Europe/Prague",
  • "installerAccessLevel": "NONE",
  • "historyExpiration": "NONE",
  • "objectRegistrationDate": "2019-08-24T14:15:22Z",
  • "voiceNotificationPrefix": "My house",
  • "device": {
    },
  • "installerCompany": {
    },
  • "distributor": {
    },
  • "meta": {
    }
}

Update service settings

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Request Body schema: application/json

Service settings

non-empty
name
string (ObjectOrServiceName) [ 1 .. 64 ] characters

Name of object or service

timeZone
string (TimeZone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Port_of_Spain" "America/Puerto_Rico" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santa_Isabel" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Ho_Chi_Minh" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/Stanley" "Atlantic/St_Helena" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

IANA timezone definition

installerAccessLevel
string (InstallerAccessLevel)
Enum: "NONE" "TECHNICAL_INFO" "ALL"

Access level of installer company

historyExpiration
string (HistoryExpiration)
Enum: "NONE" "P30D" "P90D"

Object history expiration, default is NONE - Lifetime

VoiceNotificationPrefix (string) or null

null only for PATCH to remove current value

Responses

Request samples

Content type
application/json
{
  • "name": "My House",
  • "timeZone": "Europe/Prague",
  • "installerAccessLevel": "NONE",
  • "historyExpiration": "NONE",
  • "voiceNotificationPrefix": "My house"
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get service global permissions

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
{
  • "role": "OWNER",
  • "timeZone": {
    },
  • "historyExpiration": {
    },
  • "installerAccessLevel": {
    },
  • "voiceNotificationPrefix": {
    },
  • "installerCompany": {
    },
  • "deviceConfiguration": {
    },
  • "jaPay": {
    }
}

Get service access setting for current user

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
{
  • "me": {
    },
  • "accesses": [
    ],
  • "serviceSharingPermissions": {
    }
}

Add service access setting for given user

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Request Body schema: application/json

User access

userLogin
required
string <email> (Email)

Email address

role
required
string (ServiceAccessRole)
Enum: "OWNER" "READ" "CONTROL" "SHARE" "CUSTOM"
Array of objects (UserComponentForSharing) non-empty
Array of objects (PermissionGroupGlobal) non-empty unique

Responses

Request samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "role": "OWNER",
  • "components": [
    ],
  • "global": [
    ]
}

Response samples

Content type
application/json
{
  • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
}

Get service access detail for given user

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

query Parameters
displayType
string
Default: "COMPONENT"
Enum: "COMPONENT" "ACCESS"
Example: displayType=ACCESS

Return details by components or by access

Responses

Response samples

Content type
application/json
Example
{
  • "components": [
    ],
  • "global": [
    ]
}

Remove access to service for given user

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Update access detail to service for given user

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Request Body schema: application/json

User access changes

role
required
string (ServiceAccessRole)
Enum: "OWNER" "READ" "CONTROL" "SHARE" "CUSTOM"
Array of objects (UserComponentForSharing) non-empty
Array of objects

Responses

Request samples

Content type
application/json
{
  • "role": "OWNER",
  • "components": [
    ],
  • "global": [
    ]
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Delete media event from service

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

mediaId
required
string (MEDIA_EVENT_ID) ^(PICTURE)-(\d+)$|^VIDEO-([[0-9a-fA-F\-]{36})...
Example: VIDEO-123e4567-e89b-12d3-a456-426655440000

Cloud media event id

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get notification settings for given service and contacts

Authorizations:
KongResolverOAuthJCS
path Parameters
contactId
required
string <uuid> (UuidString)
Example: 296ffe8b-2f9e-4c69-939d-5b996b73681f

UUIDv4 of notification contact

serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bulk create notification settings

Authorizations:
KongResolverOAuthJCS
path Parameters
contactId
required
string <uuid> (UuidString)
Example: 296ffe8b-2f9e-4c69-939d-5b996b73681f

UUIDv4 of notification contact

serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Request Body schema: application/json

Bulk notification settings

Array
clientCustomId
required
string (ClientCustomId) non-empty

Custom client identification of object

category
required
string (schemas-NotificationCategory) ^[A-Z\.\_]{1,}[A-Z]$

Allowed values:

  • SECURITY_SYSTEM.ALARM (only EndUser)
  • SECURITY_SYSTEM.PANIC (only EndUser)
  • SECURITY_SYSTEM.ACTOR_ON (only EndUser)
  • SECURITY_SYSTEM.ACTOR_OFF (only EndUser)
  • SECURITY_SYSTEM.ARM (only EndUser)
  • SECURITY_SYSTEM.DISARM (only EndUser)
  • SECURITY_SYSTEM.CONSUMPTION_EXCEEDED (only EndUser)
  • SECURITY_SYSTEM.GEOFENCE (only EndUser)
  • SECURITY_SYSTEM.MEDIA (only EndUser)
  • SECURITY_SYSTEM.SERVICE (only EndUser)
  • SECURITY_SYSTEM.SERVICE_ENTER (only Installer)
  • SECURITY_SYSTEM.SERVICE_EXIT (only Installer)
  • SECURITY_SYSTEM.TEMPERATURE_HIGH (only EndUser)
  • SECURITY_SYSTEM.TEMPERATURE_LOW (only EndUser)
  • SECURITY_SYSTEM.TROUBLE (only EndUser)
  • SECURITY_SYSTEM.TROUBLE_ACTIVATION (only Installer)
  • SECURITY_SYSTEM.TROUBLE_DEACTIVATION (only Installer)
  • SECURITY_SYSTEM.TROUBLE.ACCUMULATOR (only Installer)
  • SECURITY_SYSTEM.TROUBLE.ARC (only Installer)
  • SECURITY_SYSTEM.TROUBLE.BATTERY (only Installer)
  • SECURITY_SYSTEM.TROUBLE.CONNECTION (only Installer)
  • SECURITY_SYSTEM.TROUBLE.GENERAL (only Installer)
  • SECURITY_SYSTEM.TROUBLE.JAMMING (only Installer)
  • SECURITY_SYSTEM.TROUBLE.POWER_SUPPLY (only Installer)
  • SECURITY_SYSTEM.TROUBLE.ACCUMULATOR_DEACTIVATION (only Installer)
  • SECURITY_SYSTEM.TROUBLE.ARC_DEACTIVATION (only Installer)
  • SECURITY_SYSTEM.TROUBLE.BATTERY_DEACTIVATION (only Installer)
  • SECURITY_SYSTEM.TROUBLE.CONNECTION_DEACTIVATION (only Installer)
  • SECURITY_SYSTEM.TROUBLE.GENERAL_DEACTIVATION (only Installer)
  • SECURITY_SYSTEM.TROUBLE.JAMMING_DEACTIVATION (only Installer)
  • SECURITY_SYSTEM.TROUBLE.POWER_SUPPLY_DEACTIVATION (only Installer)
languageCode
required
string (LanguageCode)
Enum: "CS" "DA" "DE" "EL" "EN" "ES" "FI" "FR" "HR" "HU" "IT" "NL" "NO" "PL" "PT" "RO" "RU" "SK" "SL" "SR" "SV" "TR" "UK" "VI" "ET"
TEMPERATURE_SETTING (object) or CONSUMPTION_SETTING (object)
object
isCritical
boolean

Indicates if the notification is critical

soundCategory
string (SoundCategory)
Enum: "ALARM" "ALARM2" "ALARM_LONG" "ARMED" "DISARMED" "ACTOR" "FAILURE" "INFO" "NONE"

Sound category for the notification

SECTION (string) or ACTOR (string) or COMPONENT (string) (NotificationSettingComponent)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get service notification contacts for current user

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Request Body schema: application/json

Contacts filter

active
boolean (Active)

Filter only active or inactive contacts, default is both of them

valid
boolean (Valid)

Filter only valid or invalid contacts, default is both of them

Array of objects (TargetTypeFilter) non-empty unique [ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "valid": true,
  • "targetType": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get notification components for service

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bulk update notification settings

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Notification settings

Array
id
required
string (NotificationSettingId) ^(?:SECURITY_SYSTEM|HOME_AUTOMATION)-[0-9(a-f...
languageCode
string (LanguageCode)
Enum: "CS" "DA" "DE" "EL" "EN" "ES" "FI" "FR" "HR" "HU" "IT" "NL" "NO" "PL" "PT" "RO" "RU" "SK" "SL" "SR" "SV" "TR" "UK" "VI" "ET"
TEMPERATURE_SETTING (object) or CONSUMPTION_SETTING (object)
object or null
isCritical
boolean

Indicates if the notification is critical

soundCategory
string (SoundCategory)
Enum: "ALARM" "ALARM2" "ALARM_LONG" "ARMED" "DISARMED" "ACTOR" "FAILURE" "INFO" "NONE"

Sound category for the notification

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Bulk remove notification settings

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Notification settings

Array (non-empty)
id
required
string (NotificationSettingId) ^(?:SECURITY_SYSTEM|HOME_AUTOMATION)-[0-9(a-f...

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get notification setting detail

Authorizations:
KongResolverOAuthJCS
path Parameters
settingId
required
string (NotificationSettingId) ^(?:SECURITY_SYSTEM|HOME_AUTOMATION)-[0-9(a-f...
Example: SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f

UUIDv4 of notification settings with context prefix

Responses

Response samples

Content type
application/json
{
  • "id": "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f",
  • "contact": {
    },
  • "category": "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED",
  • "languageCode": "CS",
  • "component": {
    },
  • "settings": {
    },
  • "validity": {
    },
  • "isCritical": true,
  • "soundCategory": "ALARM",
  • "canEdit": true,
  • "canRemove": true,
  • "created": "2019-08-24T14:15:22Z"
}

Bulk create notification contacts

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Contacts

Array
clientCustomId
required
string (ClientCustomId) non-empty

Custom client identification of object

type
required
string (ContactType)
Enum: "SMS" "VOICE" "PUSH" "EMAIL"
required
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
label
string or null (ContactLabel) [ 1 .. 64 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Update notification contact

Authorizations:
KongResolverOAuthJCS
path Parameters
contactId
required
string <uuid> (UuidString)
Example: 296ffe8b-2f9e-4c69-939d-5b996b73681f

UUIDv4 of notification contact

Request Body schema: application/json

Target or label

non-empty
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
label
string or null (ContactLabel) [ 1 .. 64 ] characters

Responses

Request samples

Content type
application/json
{
  • "target": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
  • "label": "My iPhone"
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Remove service notification settings for given contact

Authorizations:
KongResolverOAuthJCS
path Parameters
contactId
required
string <uuid> (UuidString)
Example: 296ffe8b-2f9e-4c69-939d-5b996b73681f

UUIDv4 of notification contact

serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get settings of component

Authorizations:
KongResolverOAuthJCS
path Parameters
componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Responses

Response samples

Content type
application/json
Example
{
  • "$type": "ELECTRIC_METER_SETTINGS",
  • "currency": "AED",
  • "priceLo": 0.01,
  • "priceHi": 0.01,
  • "displayMode": "SINGLE"
}

Update settings of component

Authorizations:
KongResolverOAuthJCS
path Parameters
componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Request Body schema: application/json

Component settings

$type
required
string
Currency (string) or null
PulseMeterPrice (number) or null
PulseMeterPrice (number) or null
displayMode
string (PulseMeterDisplayMode)
Enum: "SINGLE" "DUAL"

Responses

Request samples

Content type
application/json
Example
{
  • "$type": "ELECTRIC_METER_SETTINGS",
  • "currency": "AED",
  • "priceLo": 0.01,
  • "priceHi": 0.01,
  • "displayMode": "SINGLE"
}

Response samples

Content type
application/json
Example
{
  • "$type": "ELECTRIC_METER_SETTINGS",
  • "currency": "AED",
  • "priceLo": 0.01,
  • "priceHi": 0.01,
  • "displayMode": "SINGLE"
}

Update current mode of component

Authorizations:
KongResolverOAuthJCS
path Parameters
componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Request Body schema: application/json

Component mode

mode
required
string
Enum: "MANUAL" "CALENDAR" "MANUAL_TEMPORARY" "STANDBY"

Current thermostat mode

temperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

lastChange
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

$type
required
string

Responses

Request samples

Content type
application/json
{
  • "mode": "MANUAL",
  • "temperature": -13.5,
  • "lastChange": "2019-08-24T14:15:22Z",
  • "$type": "THERMOSTAT_MODE"
}

Response samples

Content type
application/json
{
  • "mode": "MANUAL",
  • "temperature": -13.5,
  • "lastChange": "2019-08-24T14:15:22Z",
  • "$type": "THERMOSTAT_MODE"
}

Set component states

Authorizations:
KongResolverOAuthJCS
path Parameters
componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Request Body schema: application/json

Component states

non-empty
$type
required
string
wantedTotalValueHi
number <float> (WantedConsumption) >= 0

Current consumption value, cannot be negative, 0 for reset!

wantedTotalValueLo
number <float> (WantedConsumption) >= 0

Current consumption value, cannot be negative, 0 for reset!

wantedTotalValue
number <float> (WantedConsumption) >= 0

Current consumption value, cannot be negative, 0 for reset!

Responses

Request samples

Content type
application/json
{
  • "$type": "PULSE_METER_STATE",
  • "wantedTotalValueHi": 15.2365,
  • "wantedTotalValueLo": 15.2365,
  • "wantedTotalValue": 15.2365
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Register Dial controller device to CLOUD

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Registration params

required
DEVICE_IDENTITY (string) or REGISTRATION_KEY (string)
serviceName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters

Name of object or service

timeZone
required
string (TimeZone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Port_of_Spain" "America/Puerto_Rico" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santa_Isabel" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Ho_Chi_Minh" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/Stanley" "Atlantic/St_Helena" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

IANA timezone definition

countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

Responses

Request samples

Content type
application/json
{
  • "deviceIdentification": "DEVICE_JACLOUDSN:F9100013",
  • "serviceName": "My House",
  • "timeZone": "Europe/Prague",
  • "countryCode": "CZ"
}

Response samples

Content type
application/json
{
  • "serviceEntityId": "SERVICE_JA100F:242566",
  • "objectEntityId": "OBJECT_JA100F:242566"
}

Get status of device request

Authorizations:
KongResolverOAuthJCS
path Parameters
requestId
required
string (REQUEST_ID) >= 5 characters
Example: DCD-1254445521

Returns if an action was created in the device configuration manager (configuration download, reconfiguration ...)

Responses

Response samples

Content type
application/json
{
  • "requestId": "DCD-1254445521",
  • "state": "CREATED",
  • "type": "SETTING",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "success": true,
  • "error": {
    },
  • "meta": {
    }
}

Update object settings

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Request Body schema: application/json

Object setting action

One of
$type
required
string
Value: "RECONFIGURATION"

Responses

Request samples

Content type
application/json
Example
{
  • "$type": "RECONFIGURATION"
}

Response samples

Content type
application/json
{
  • "requestId": "DCD-1254445521"
}

Get all unfinished registrations for logged user

Authorizations:
KongResolverOAuthJCS

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get object registration status

Returns the global registration status of the object

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "finalState": true,
  • "unfinishedSteps": [
    ],
  • "recommendedStep": "OBJECT_SETUP"
}

Get object setup status

Returns the current configuration setup status derived from object state and currently active requests. Historical failed request details are not included in this response.

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "finalState": true,
  • "settingStep": {
    },
  • "configurationDownloadStep": {
    },
  • "recommendedStep": "DOWNLOAD_CONFIGURATION"
}

Get object customer attributes status

Returns the current customer attributes setup status.

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "finalState": true,
  • "groups": [
    ],
  • "attributes": [
    ]
}

Get service setup status

Returns the current setup status of end user service

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "finalState": true,
  • "dependencies": [
    ],
  • "serviceStatus": {
    },
  • "meta": {
    }
}

Create service

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Request Body schema: application/json

Service create params

name
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters

Name of object or service

type
string (ServiceType)
Enum: "AMBIENTA" "ATHOS" "ATHOS2" "AURA" "AZOR" "FUTURA" "FUTURA2" "GD04K" "JA10" "JA100" "JA100F" "JA100M" "JA100S" "LOGBOOK" "OASIS" "TCU" "VOLTA" "DC01H"

Only for objects where multiple service types can be created; by default, the primary service type is created

Responses

Request samples

Content type
application/json
{
  • "name": "My House",
  • "type": "JA100F"
}

Response samples

Content type
application/json
{
  • "id": "SERVICE_JA100F:242566"
}

Register Indexa device to CLOUD

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Registration params

registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
authorizationCode
required
string (IndexaAuthorizationCode) ^[A-F0-9]{16}$
masterCode
required
string (JA100Code) ^([\d]{1,3}\*)?([\d]{4}|[\d]{6}|[\d]{8})$
msisdn
string (PhoneNumber) ^\+[\d]{5,19}$

Internation phone number with + prefix

objectName
string (ObjectOrServiceName) [ 1 .. 64 ] characters

Name of object or service

timeZone
string (TimeZone)
Default: "Europe/Berlin"
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Port_of_Spain" "America/Puerto_Rico" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santa_Isabel" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Ho_Chi_Minh" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/Stanley" "Atlantic/St_Helena" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

IANA timezone definition

Responses

Request samples

Content type
application/json
{
  • "registrationKey": "LAS6D-U2VBG-UHX65",
  • "authorizationCode": "A1B2C3D4E5F60708",
  • "masterCode": "2*1234",
  • "msisdn": "+420739259931",
  • "objectName": "My House",
  • "timeZone": "Europe/Prague"
}

Response samples

Content type
application/json
{
  • "objectEntityId": "OBJECT_JA100F:242566"
}

Unregister service and device

Authorizations:
KongResolverOAuthJCS
path Parameters
serviceEntityId
required
string (SERVICE_ENTITY) ^SERVICE_(\w+):([\d]+)$
Example: SERVICE_JA100F:242566

Cloud entity id of end user Service

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get logged user information

Authorizations:
KongResolverOAuthJCS

Responses

Response samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
  • "confirmPhoneNumber": "+420739259931",
  • "personName": "Jan Tron",
  • "newsletterAllowed": true
}

Update logged user information

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Changed values

non-empty
PHONE_NUMBER (string) or null
NAME_AND_SURNAME (string) or null
newsletterAllowed
boolean

Responses

Request samples

Content type
application/json
{
  • "confirmPhoneNumber": "+420739259931",
  • "personName": "Jan Tron",
  • "newsletterAllowed": true
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Installer

Installer resources

Get companies for logged installer

Authorizations:
KongResolverOAuthJCS
query Parameters
include[]
string (Include)
Value: "DISTRIBUTOR"

Array of included objects

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get company information

Authorizations:
KongResolverOAuthJCS
path Parameters
companyId
required
number (IntId) >= 1

Id of installerCompany

Responses

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "Company s.r.o.",
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "iban": "CZ5508000000001234567899",
  • "vatPayer": true,
  • "countryCode": "CZ",
  • "invoiceCompanyName": "Company s.r.o.",
  • "swiftCode": "AAAABBCC123",
  • "bankAccountNumber": "35-254125846/0100",
  • "bankAccountName": "Company s.r.o.",
  • "bankAccountStreet": "Pod Houbou 15",
  • "bankAccountCity": "Jablonec nad Nisou",
  • "bankCountryCode": "CZ",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "affiliateRegistered": false,
  • "affiliateEmail": "tomas.janda@jablotron.cz",
  • "affiliatePhoneNumber": "+420739259931",
  • "companyLogoUrl": "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200",
  • "ownerAccount": {
    },
  • "distributors": [
    ],
  • "me": {
    }
}

Update company information

Authorizations:
KongResolverOAuthJCS
path Parameters
companyId
required
number (IntId) >= 1

Id of installerCompany

Request Body schema: application/json

Company information

cin
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

ZIP (string) or null

null only for PATCH to remove current value

Iban (string) or null

null only for PATCH to remove current value

vatPayer
boolean (VatPayer)

Company is payer of VAT

CountryCode (string) or null

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

CountryCode (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

EMAIL (string) or null

null only for PATCH to remove current value

shareContacts
boolean (ShareContacts)

Company want to share phone number and email address with end users

LogoData (string) or null

null only for PATCH to remove current logo

affiliateRegistered
boolean

ignored in PATCH, only for admin view

EMAIL (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

name
string (CommonCompanyName) [ 1 .. 70 ] characters

Responses

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "iban": "CZ5508000000001234567899",
  • "vatPayer": true,
  • "countryCode": "CZ",
  • "invoiceCompanyName": "Company s.r.o.",
  • "swiftCode": "AAAABBCC123",
  • "bankAccountNumber": "35-254125846/0100",
  • "bankAccountName": "Company s.r.o.",
  • "bankAccountStreet": "Pod Houbou 15",
  • "bankAccountCity": "Jablonec nad Nisou",
  • "bankCountryCode": "CZ",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "affiliateRegistered": true,
  • "affiliateEmail": "tomas.janda@jablotron.cz",
  • "affiliatePhoneNumber": "+420739259931",
  • "name": "Company s.r.o."
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Thermometers list

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

query Parameters
state
string (ThermometerState)
Enum: "SET" "PREPARED" "LIMIT_REACHED"

Allow to filter only SET or PREPARED thermostats

includeActors
boolean

Returns available ACTORS to be used for CLOUD thermostats

Responses

Response samples

Content type
application/json
{
  • "thermometers": [
    ],
  • "actors": [
    ]
}

Thermometer detail

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

query Parameters
includeActors
boolean

Returns available ACTORS to be used for CLOUD thermostats

Responses

Response samples

Content type
application/json
{
  • "thermometer": {
    },
  • "actors": [
    ]
}

Update CLOUD thermostat

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Request Body schema: application/json

CLOUD thermostat setting

non-empty
actorId
string (ActorEntityId) ^ACTOR_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
temperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

Responses

Request samples

Content type
application/json
{
  • "actorId": "ACTOR_<OBJECT_JA100F:242566>:5",
  • "temperature": -13.5
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Create CLOUD thermostat

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Request Body schema: application/json

CLOUD thermostat setting

actorId
required
string (ActorEntityId) ^ACTOR_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
temperature
required
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

Responses

Request samples

Content type
application/json
{
  • "actorId": "ACTOR_<OBJECT_JA100F:242566>:5",
  • "temperature": -13.5
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Remove CLOUD thermostat

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get thermostat settings

Authorizations:
KongResolverOAuthJCS
path Parameters
componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Responses

Response samples

Content type
application/json
{
  • "$type": "THERMOSTAT_SETTINGS",
  • "economyTemperature": -13.5,
  • "comfortTemperature": -13.5,
  • "standbyTemperature": -13.5,
  • "hysteresis": -13.5,
  • "calibration": -13.5,
  • "calendar": {
    },
  • "calendarGrouping": "WEEK",
  • "overheatTemperature": -13.5,
  • "freezeTemperature": -13.5,
  • "minimumTemperature": -13.5,
  • "maximumTemperature": -13.5,
  • "armSwitchOption": "NONE",
  • "tamperDisabled": true
}

Update thermostat settings

Authorizations:
KongResolverOAuthJCS
path Parameters
componentEntityId
required
string (DEVICE_COMPONENT_IN_PATH) ^(SECTION|COMPONENT|ACTOR|USER)_
Example: COMPONENT_<OBJECT_JA100F:12345>:1

Cloud entity id of component

Request Body schema: application/json

Component settings

$type
required
string
Value: "THERMOSTAT_SETTINGS"
economyTemperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

comfortTemperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

standbyTemperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

hysteresis
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

calibration
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

object (ThermostatCalendar)
calendarGrouping
string
Default: "SEPARATE"
Enum: "WEEK" "WORKING_DAYS" "SEPARATE"
overheatTemperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

freezeTemperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

minimumTemperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

maximumTemperature
number <float> (Temperature)

Temperature in Celsius, formatted to 1 decimal place (-99.9 - +99.9)

armSwitchOption
string
Enum: "NONE" "ARM" "ARM_AND_PARTIAL_ARM"
tamperDisabled
boolean

Responses

Request samples

Content type
application/json
{
  • "$type": "THERMOSTAT_SETTINGS",
  • "economyTemperature": -13.5,
  • "comfortTemperature": -13.5,
  • "standbyTemperature": -13.5,
  • "hysteresis": -13.5,
  • "calibration": -13.5,
  • "calendar": {
    },
  • "calendarGrouping": "WEEK",
  • "overheatTemperature": -13.5,
  • "freezeTemperature": -13.5,
  • "minimumTemperature": -13.5,
  • "maximumTemperature": -13.5,
  • "armSwitchOption": "NONE",
  • "tamperDisabled": true
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get logged user information

Authorizations:
KongResolverOAuthJCS

Responses

Response samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
  • "confirmPhoneNumber": "+420739259931",
  • "personName": "Jan Tron",
  • "newsletterAllowed": true
}

Update logged user information

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Changed values

non-empty
PHONE_NUMBER (string) or null
NAME_AND_SURNAME (string) or null
newsletterAllowed
boolean

Responses

Request samples

Content type
application/json
{
  • "confirmPhoneNumber": "+420739259931",
  • "personName": "Jan Tron",
  • "newsletterAllowed": true
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Administrator

Administrator resources

Get object maintenance report for administrator

Authorizations:
KongResolverOAuthJCS
path Parameters
objectEntityId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: OBJECT_JA100F:242566

Cloud entity id of Object

Responses

Response samples

Content type
application/json
{
  • "objectName": "My House",
  • "deviceOfficialName": "JA-101K LAN 3G",
  • "serialNumber": "F9301214",
  • "timeZone": "Europe/Prague",
  • "registrationKey": "LAS6D-U2VBG-UHX65",
  • "phoneNumber": "+420739259931",
  • "arcObjectNumber": "F13D",
  • "installerCompany": "Company s.r.o.",
  • "lastEventDate": "2019-08-24T14:15:22Z",
  • "gsm": {
    },
  • "firmware": {
    },
  • "connection": {
    },
  • "settingSuccessDate": "2019-08-24T14:15:22Z",
  • "configurationSuccessDate": "2019-08-24T14:15:22Z",
  • "peripherals": [
    ]
}

Get list of distributors

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create distributor company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
Request Body schema: application/json

Distributor attributes

distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

helpdeskLogin
required
string <email> (Email)

Email address

description
string (Description) [ 1 .. 255 ] characters
required
object (DistributorSettings)

Responses

Request samples

Content type
application/json
{
  • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
  • "name": "Company s.r.o.",
  • "countryCode": "CZ",
  • "rgapCountry": "CZ",
  • "helpdeskLogin": "tomas.janda@jablotron.cz",
  • "description": "Common description of entity up to 255 characters",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get detail of distributor

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Responses

Response samples

Content type
application/json
{
  • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
  • "name": "Company s.r.o.",
  • "countryCode": "CZ",
  • "rgapCountry": "CZ",
  • "helpdeskLogin": "tomas.janda@jablotron.cz",
  • "description": "Common description of entity up to 255 characters",
  • "settings": {
    },
  • "api": {
    },
  • "contacts": {
    },
  • "arcs": [
    ],
  • "users": [
    ],
  • "meta": {
    }
}

Update distributor settings

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Request Body schema: application/json

Attributes to be updated

non-empty
countryCode
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

CountryCode (string) or null
EMAIL (string) or null
Description (string) or null
object

Responses

Request samples

Content type
application/json
{
  • "countryCode": "CZ",
  • "rgapCountry": "CZ",
  • "helpdeskLogin": "tomas.janda@jablotron.cz",
  • "description": "Common description of entity up to 255 characters",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Remove distributor

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Enable API access for distributor

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Request Body schema: application/json

API mode

mode
required
string
Enum: "API" "JA_ARC"

Responses

Request samples

Content type
application/json
{
  • "mode": "API"
}

Response samples

Content type
application/json
{
  • "authorizationKey": "b0d2f6a2d76a354d3a37f64b8ad08019"
}

Disable API access for distributor

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get users under distributor company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user under distributor company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Request Body schema: application/json

User attributes

userLogin
required
string <email> (Email)

Email address

role
required
string (DistributorRole)
Enum: "USER" "ADMINISTRATOR"
modules
Array of strings (DistributorModules) >= 0 items unique
Items Enum: "OBJECTS" "INSTALLER_COMPANIES" "SETTINGS" "JA_PAY" "SN_LANG" "HELPDESK"

Responses

Request samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "role": "USER",
  • "modules": [
    ]
}

Response samples

Content type
application/json
{
  • "distributorUserId": 242566,
  • "user": {
    },
  • "lastLoggedDate": "2019-08-24T14:15:22Z",
  • "role": "USER",
  • "modules": [
    ]
}

Remove user under distributor company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Create ARC under distributor company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Request Body schema: application/json

ARC attributes

arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
customName
string (CommonCompanyName) [ 1 .. 70 ] characters

Responses

Request samples

Content type
application/json
{
  • "arcId": "ARC_CLOUD:00008808",
  • "customName": "Company s.r.o."
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Remove ARC under distributor company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Update Distributor company information

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Request Body schema: application/json

Company information

COMPANY_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

ZIP (string) or null

null only for PATCH to remove current value

Iban (string) or null

null only for PATCH to remove current value

vatPayer
boolean (VatPayer)

Company is payer of VAT

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

CountryCode (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

EMAIL (string) or null

null only for PATCH to remove current value

shareContacts
boolean (ShareContacts)

Company want to share phone number and email address with end users

LogoData (string) or null

null only for PATCH to remove current logo

EMAIL (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

name
string >= 3 characters

Responses

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "iban": "CZ5508000000001234567899",
  • "vatPayer": true,
  • "invoiceCompanyName": "Company s.r.o.",
  • "swiftCode": "AAAABBCC123",
  • "bankAccountNumber": "35-254125846/0100",
  • "bankAccountName": "Company s.r.o.",
  • "bankAccountStreet": "Pod Houbou 15",
  • "bankAccountCity": "Jablonec nad Nisou",
  • "bankCountryCode": "CZ",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "affiliateEmail": "tomas.janda@jablotron.cz",
  • "affiliatePhoneNumber": "+420739259931",
  • "name": "UP TEST"
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get installer company information

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
companyId
required
number (IntId) >= 1

Id of installerCompany

Responses

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "Company s.r.o.",
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "iban": "CZ5508000000001234567899",
  • "vatPayer": true,
  • "countryCode": "CZ",
  • "invoiceCompanyName": "Company s.r.o.",
  • "swiftCode": "AAAABBCC123",
  • "bankAccountNumber": "35-254125846/0100",
  • "bankAccountName": "Company s.r.o.",
  • "bankAccountStreet": "Pod Houbou 15",
  • "bankAccountCity": "Jablonec nad Nisou",
  • "bankCountryCode": "CZ",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "affiliateRegistered": true,
  • "affiliateEmail": "tomas.janda@jablotron.cz",
  • "affiliatePhoneNumber": "+420739259931",
  • "companyLogoUrl": "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200",
  • "ownerAccount": {
    }
}

Update installer company information

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
companyId
required
number (IntId) >= 1

Id of installerCompany

Request Body schema: application/json

Company information

cin
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

ZIP (string) or null

null only for PATCH to remove current value

Iban (string) or null

null only for PATCH to remove current value

vatPayer
boolean (VatPayer)

Company is payer of VAT

CountryCode (string) or null

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

CountryCode (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

EMAIL (string) or null

null only for PATCH to remove current value

shareContacts
boolean (ShareContacts)

Company want to share phone number and email address with end users

LogoData (string) or null

null only for PATCH to remove current logo

affiliateRegistered
boolean

ignored in PATCH, only for admin view

EMAIL (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

name
string (CommonCompanyName) [ 1 .. 70 ] characters

Responses

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "iban": "CZ5508000000001234567899",
  • "vatPayer": true,
  • "countryCode": "CZ",
  • "invoiceCompanyName": "Company s.r.o.",
  • "swiftCode": "AAAABBCC123",
  • "bankAccountNumber": "35-254125846/0100",
  • "bankAccountName": "Company s.r.o.",
  • "bankAccountStreet": "Pod Houbou 15",
  • "bankAccountCity": "Jablonec nad Nisou",
  • "bankCountryCode": "CZ",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "affiliateRegistered": true,
  • "affiliateEmail": "tomas.janda@jablotron.cz",
  • "affiliatePhoneNumber": "+420739259931",
  • "name": "Company s.r.o."
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get list of ARCs

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
query Parameters
arcType
string
Enum: "CLOUD" "DIRECT"

Type of ARC to be returned

arcEntityId
Array of strings (ArcEntityId) non-empty unique [ items^ARC_(CLOUD|DIRECT):([\d]+)$ ]
Example: arcEntityId=ARC_CLOUD:00008808

ArcId for optional filtering

distributorEntities
Array of strings (DistributorId) non-empty unique [ items^DISTRIBUTOR_DEFAULT:(\d{4})$ ]
Example: distributorEntities=DISTRIBUTOR_DEFAULT:0012

DistributorId for optional filtering

Responses

Response samples

Content type
application/json
[]

Create ARC

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
Request Body schema: application/json

ARC attributes

$type
string
countryCode
required
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

outputId
required
string (OutputId)
Enum: "SP1" "SP2" "SP3" "SP4" "SP5" "SP6" "SP7"

Available only for CLOUD ARC

driverType
required
string (DriverType)
Enum: "KROND" "KRONDI" "SIAD" "SIAD_DUAL" "SRG2D" "SRG2D_DUAL" "MNTD" "MNTD_DUAL" "UNSUPPORTED"

Available only for CLOUD ARC

outputPort
integer (OutputPort) [ 1 .. 65535 ]

Available only for CLOUD ARC

arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
hasDefaultTemplate
boolean
Default: false

Indicates whether the DIRECT ARC has a default template set

COMPANY_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

ZIP (string) or null

null only for PATCH to remove current value

EMAIL (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

EMAIL (string) or null

null only for PATCH to remove current value

shareContacts
boolean (ShareContacts)

Company want to share phone number and email address with end users

LogoData (string) or null

null only for PATCH to remove current logo

Description (string) or null

null only for PATCH to remove current value

boolean or null

null only for PATCH to remove current value

Responses

Request samples

Content type
application/json
Example
{
  • "$type": "ARC_CLOUD",
  • "countryCode": "CZ",
  • "outputId": "SP1",
  • "driverType": "KROND",
  • "outputPort": 30005,
  • "arcId": "ARC_CLOUD:00008808",
  • "name": "Company s.r.o.",
  • "hasDefaultTemplate": false,
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "helpdeskEmail": "tomas.janda@jablotron.cz",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "description": "Common description of entity up to 255 characters",
  • "autoTransferDisabled": true
}

Response samples

Content type
application/json
{
  • "arcId": "ARC_CLOUD:00008808"
}

Get detail of ARC

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
{
  • "arcId": "ARC_CLOUD:00008808",
  • "name": "Company s.r.o.",
  • "hasDefaultTemplate": false,
  • "countryCode": "CZ",
  • "outputId": "SP1",
  • "driverType": "KROND",
  • "photoVerificationUrlBase": "https://arc-verification.jablotron.cloud/12541/akdsjfhkjs/:objectNumber",
  • "outputPort": 30005,
  • "helpdeskEmail": "tomas.janda@jablotron.cz",
  • "description": "Common description of entity up to 255 characters",
  • "autoTransferDisabled": true,
  • "notificationContacts": [
    ],
  • "distributors": [
    ],
  • "users": [
    ],
  • "meta": {
    }
}

Update ARC settings

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Request Body schema: application/json

ARC attributes

non-empty
name
string (CommonCompanyName) [ 1 .. 70 ] characters
countryCode
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW"

Supported country code from CLOUD

driverType
string (DriverType)
Enum: "KROND" "KRONDI" "SIAD" "SIAD_DUAL" "SRG2D" "SRG2D_DUAL" "MNTD" "MNTD_DUAL" "UNSUPPORTED"

Available only for CLOUD ARC

OutputPort (integer) or null
OutputId (string) or null
EMAIL (string) or null
Description (string) or null
autoTransferDisabled
boolean

ARC has disabled data transfer to ARC from new objects by default

Responses

Request samples

Content type
application/json
{
  • "name": "Company s.r.o.",
  • "countryCode": "CZ",
  • "driverType": "KROND",
  • "outputPort": 30005,
  • "outputId": "SP1",
  • "helpdeskEmail": "tomas.janda@jablotron.cz",
  • "description": "Common description of entity up to 255 characters",
  • "autoTransferDisabled": true
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Remove ARC

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get users under ARC company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user under ARC company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

Request Body schema: application/json

User attributes

userLogin
required
string <email> (Email)

Email address

role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
setDefaultNotifications
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "role": "USER",
  • "setDefaultNotifications": true
}

Response samples

Content type
application/json
{
  • "arcUserId": 242566,
  • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
  • "lastLoggedDate": "2019-08-24T14:15:22Z",
  • "userLogin": "tomas.janda@jablotron.cz",
  • "role": "USER"
}

Remove user under ARC company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: ARC_CLOUD:00008808

Cloud entity id of ARC

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get list of RGAP countries

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution

Responses

Response samples

Content type
application/json
[
  • "CZ"
]

Migrate ARC to ARC template set

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
path Parameters
directArcEntityId
required
string (DirectArcEntityId) ^ARC_DIRECT:([\d]+)$
Example: ARC_DIRECT:9463

Entity id of direct ARC

Request Body schema: application/json

ARC attributes

sourceArcId
required
string (DirectArcEntityId) ^ARC_DIRECT:([\d]+)$

Responses

Request samples

Content type
application/json
{
  • "sourceArcId": "ARC_DIRECT:9463"
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Common

Common resources

Get microservice catalog information

Returns metadata about the running microservice, including service information and dependencies

Responses

Response samples

Content type
application/json
{
  • "service": {
    },
  • "dependencies": [
    ]
}

Distributor

Get distributor companies for logged user

Authorizations:
KongResolverOAuthJCS

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get distributor company information

Authorizations:
KongResolverOAuthJCS
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Responses

Response samples

Content type
application/json
{
  • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
  • "name": "Company s.r.o.",
  • "countryCode": "CZ",
  • "rgapCountry": "CZ",
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "iban": "CZ5508000000001234567899",
  • "vatPayer": true,
  • "invoiceCompanyName": "Company s.r.o.",
  • "swiftCode": "AAAABBCC123",
  • "bankAccountNumber": "35-254125846/0100",
  • "bankAccountName": "Company s.r.o.",
  • "bankAccountStreet": "Pod Houbou 15",
  • "bankAccountCity": "Jablonec nad Nisou",
  • "bankCountryCode": "CZ",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "affiliateEmail": "tomas.janda@jablotron.cz",
  • "affiliatePhoneNumber": "+420739259931",
  • "companyLogoUrl": "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200",
  • "affiliateRegistered": false,
  • "me": {
    }
}

Update distributor company information

Authorizations:
KongResolverOAuthJCS
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Request Body schema: application/json

Company information

COMPANY_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

ZIP (string) or null

null only for PATCH to remove current value

Iban (string) or null

null only for PATCH to remove current value

vatPayer
boolean (VatPayer)

Company is payer of VAT

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

CITY (string) or null

null only for PATCH to remove current value

CountryCode (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

EMAIL (string) or null

null only for PATCH to remove current value

shareContacts
boolean (ShareContacts)

Company want to share phone number and email address with end users

LogoData (string) or null

null only for PATCH to remove current logo

EMAIL (string) or null

null only for PATCH to remove current value

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

name
string >= 3 characters

Responses

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "iban": "CZ5508000000001234567899",
  • "vatPayer": true,
  • "invoiceCompanyName": "Company s.r.o.",
  • "swiftCode": "AAAABBCC123",
  • "bankAccountNumber": "35-254125846/0100",
  • "bankAccountName": "Company s.r.o.",
  • "bankAccountStreet": "Pod Houbou 15",
  • "bankAccountCity": "Jablonec nad Nisou",
  • "bankCountryCode": "CZ",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "shareContacts": false,
  • "companyLogoData": "U3dhZ2dlciByb2Nrcw==",
  • "affiliateEmail": "tomas.janda@jablotron.cz",
  • "affiliatePhoneNumber": "+420739259931",
  • "name": "UP TEST"
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get users under distributor company

Authorizations:
KongResolverOAuthJCS
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create user under distributor company

Authorizations:
KongResolverOAuthJCS
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

Request Body schema: application/json

User attributes

userLogin
required
string <email> (Email)

Email address

role
required
string (DistributorRole)
Enum: "USER" "ADMINISTRATOR"
modules
Array of strings (DistributorModules) >= 0 items unique
Items Enum: "OBJECTS" "INSTALLER_COMPANIES" "SETTINGS" "JA_PAY" "SN_LANG" "HELPDESK"

Responses

Request samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "role": "USER",
  • "modules": [
    ]
}

Response samples

Content type
application/json
{
  • "distributorUserId": 242566,
  • "user": {
    },
  • "lastLoggedDate": "2019-08-24T14:15:22Z",
  • "role": "USER",
  • "modules": [
    ]
}

Update user under distributor company

Authorizations:
KongResolverOAuthJCS
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Request Body schema: application/json

User attributes

non-empty
role
string (DistributorRole)
Enum: "USER" "ADMINISTRATOR"
modules
Array of strings (DistributorModule) non-empty
Items Enum: "OBJECTS" "INSTALLER_COMPANIES" "SETTINGS" "JA_PAY" "SN_LANG" "HELPDESK"

Responses

Request samples

Content type
application/json
{
  • "role": "USER",
  • "modules": [
    ]
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Remove user under distributor company

Authorizations:
KongResolverOAuthJCS
path Parameters
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: DISTRIBUTOR_DEFAULT:0012

Cloud entity id of distributor

userEntity
required
string (CLOUD_USER) ^USER_
Example: USER_<OEM_JABLOTRON:Jablotron>:52325

Entity id of wanted CLOUD user

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Get logged user information

Authorizations:
KongResolverOAuthJCS

Responses

Response samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
  • "confirmPhoneNumber": "+420739259931",
  • "personName": "Jan Tron",
  • "newsletterAllowed": true
}

Update logged user information

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Changed values

non-empty
PHONE_NUMBER (string) or null
NAME_AND_SURNAME (string) or null
newsletterAllowed
boolean

Responses

Request samples

Content type
application/json
{
  • "confirmPhoneNumber": "+420739259931",
  • "personName": "Jan Tron",
  • "newsletterAllowed": true
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    ]
}

Reserve device registration for distributor

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Reservation params

distributorEntityId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
required
DEVICE_IDENTITY (string) or REGISTRATION_KEY (string) or SERIAL_NUMBER_HEX (string) or SERIAL_NUMBER_DEC (string) or SERIAL_NUMBER_FULL_DEC_NO_DASH (string) or SERIAL_NUMBER_DEC_NO_PREFIX_NO_DASH (string) or CU07 (string) (RegistrationDeviceIdentification)
objectName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters

Name of object or service

msisdn
string (PhoneNumber) ^\+[\d]{5,19}$

Internation phone number with + prefix

timeZone
string (TimeZone)
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" "Africa/Brazzaville" "Africa/Bujumbura" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/Conakry" "Africa/Dakar" "Africa/Dar_es_Salaam" "Africa/Djibouti" "Africa/Douala" "Africa/El_Aaiun" "Africa/Freetown" "Africa/Gaborone" "Africa/Harare" "Africa/Johannesburg" "Africa/Juba" "Africa/Kampala" "Africa/Khartoum" "Africa/Kigali" "Africa/Kinshasa" "Africa/Lagos" "Africa/Libreville" "Africa/Lome" "Africa/Luanda" "Africa/Lubumbashi" "Africa/Lusaka" "Africa/Malabo" "Africa/Maputo" "Africa/Maseru" "Africa/Mbabane" "Africa/Mogadishu" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Niamey" "Africa/Nouakchott" "Africa/Ouagadougou" "Africa/Porto-Novo" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Anguilla" "America/Antigua" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Aruba" "America/Asuncion" "America/Atikokan" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Blanc-Sablon" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Cayman" "America/Chicago" "America/Chihuahua" "America/Costa_Rica" "America/Creston" "America/Cuiaba" "America/Curacao" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Dominica" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fortaleza" "America/Glace_Bay" "America/Godthab" "America/Goose_Bay" "America/Grand_Turk" "America/Grenada" "America/Guadeloupe" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/Kralendijk" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Lower_Princes" "America/Maceio" "America/Managua" "America/Manaus" "America/Marigot" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Montreal" "America/Montserrat" "America/Nassau" "America/New_York" "America/Nipigon" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Ojinaga" "America/Panama" "America/Pangnirtung" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Port_of_Spain" "America/Puerto_Rico" "America/Rainy_River" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santa_Isabel" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Shiprock" "America/Sitka" "America/St_Barthelemy" "America/St_Johns" "America/St_Kitts" "America/St_Lucia" "America/St_Thomas" "America/St_Vincent" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Thunder_Bay" "America/Tijuana" "America/Toronto" "America/Tortola" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "America/Yellowknife" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/DumontDUrville" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/McMurdo" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/South_Pole" "Antarctica/Syowa" "Antarctica/Vostok" "Arctic/Longyearbyen" "Asia/Aden" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Baghdad" "Asia/Bahrain" "Asia/Baku" "Asia/Bangkok" "Asia/Beirut" "Asia/Bishkek" "Asia/Brunei" "Asia/Choibalsan" "Asia/Chongqing" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Gaza" "Asia/Harbin" "Asia/Hebron" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Ho_Chi_Minh" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kashgar" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuching" "Asia/Kuwait" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Muscat" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Phnom_Penh" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qyzylorda" "Asia/Rangoon" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vientiane" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/Reykjavik" "Atlantic/South_Georgia" "Atlantic/Stanley" "Atlantic/St_Helena" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Currie" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Europe/Amsterdam" "Europe/Andorra" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Busingen" "Europe/Chisinau" "Europe/Copenhagen" "Europe/Dublin" "Europe/Gibraltar" "Europe/Guernsey" "Europe/Helsinki" "Europe/Isle_of_Man" "Europe/Istanbul" "Europe/Jersey" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Luxembourg" "Europe/Madrid" "Europe/Malta" "Europe/Mariehamn" "Europe/Minsk" "Europe/Monaco" "Europe/Moscow" "Europe/Oslo" "Europe/Paris" "Europe/Podgorica" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/San_Marino" "Europe/Sarajevo" "Europe/Simferopol" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Tirane" "Europe/Uzhgorod" "Europe/Vaduz" "Europe/Vatican" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zaporozhye" "Europe/Zurich" "Indian/Antananarivo" "Indian/Chagos" "Indian/Christmas" "Indian/Cocos" "Indian/Comoro" "Indian/Kerguelen" "Indian/Mahe" "Indian/Maldives" "Indian/Mauritius" "Indian/Mayotte" "Indian/Reunion" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Chuuk" "Pacific/Easter" "Pacific/Efate" "Pacific/Enderbury" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Funafuti" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Johnston" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Majuro" "Pacific/Marquesas" "Pacific/Midway" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Pohnpei" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Saipan" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu" "Pacific/Wake" "Pacific/Wallis" "UTC"

IANA timezone definition

Responses

Request samples

Content type
application/json
{
  • "distributorEntityId": "DISTRIBUTOR_DEFAULT:0012",
  • "deviceIdentification": "DEVICE_JACLOUDSN:F9100013",
  • "objectName": "My House",
  • "msisdn": "+420739259931",
  • "timeZone": "Europe/Prague"
}

Response samples

Content type
application/json
{
  • "objectEntityId": "OBJECT_JA100F:242566"
}

Debug

Get debug information and check authorization

Authorizations:
KongResolver
path Parameters
v1
required
string
Value: "v1"

Version 1 of API

allActors
required
string (AllActorList)
Enum: "system" "installer" "end-user" "arc" "distributor"

List of allowed actors for manipulating with this resource

Responses

Response samples

Content type
application/json
{
  • "dateTime": "2019-08-24T14:15:22Z",
  • "id": 35562,
  • "email": "tomas.janda@jablotron.cz"
}