API docs by Redocly

api.cv1-core (8.18.2)

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
arcEntityId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: arcEntityId=ARC_CLOUD:00008808

Cloud entity id of ARC

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 (ObjectTypeParameter) non-empty unique
Items Enum: "ATHOS" "ATHOS2" "AURA" "AZOR" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 10 more
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

arcTemplateSetId
number (IntId) >= 1

ID of ARC template set

Responses

Response Schema: application/json
required
Array of objects (ListOfObjects) >= 0 items unique
Array (>= 0 items)
required
object (ObjectListSchema)
objectId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

objectNumber
required
string (ObjectNumber) ^[\dA-F]{4,8}$
Example: "F13D"
required
object
deviceId
required
string (DeviceEntityId) ^DEVICE_((JACLOUDSN:[A-F\d]{8})|(JASNV1:[\d]{...
Example: "DEVICE_JACLOUDSN:F9100013"
registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
family
required
string (DeviceFamily)
Enum: "ATHOS" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 13 more
Example: "JA100F"
model
required
string (DeviceModel)
Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: "JA107K"
officialName
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"
object (DeviceSimCard)
phoneNumber
required
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

simCardId
required
string (SimCardEntityId) ^SIM_(CUSTOMER|DISTRIBUTOR|SDC):([0-9(a-f|A-F...
Example: "SIM_SDC:46c41735-c931-4bf0-a03a-f39275beea8"
object
date
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

version
required
string
Example: "MD6112.07.1.2dbg"
lastCommunicationChannel
string
Enum: "IP" "SMS" "NONE"
required
object (ArcDistributor)
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

companyLogoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

arcConnectedDate
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object (InstallerCompany)
name
required
string
Example: "Alarm Systems inc."
distributorCompanyId
integer <int64> (DbId) >= 1
Example: "242566"
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

companyLogoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

transferDisabledDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

photoVerificationUrl
string <uri> (HttpUri)
Example: "https://subdomain.domain.tld/path?query#anchor"

URL of some resource

videoVerificationUrl
string <uri> (HttpUri)
Example: "https://subdomain.domain.tld/path?query#anchor"

URL of some resource

hasActiveCamera
boolean
Default: false

Object has registered any camera

labels
Array of strings (ObjectArcLabels) non-empty unique
Items Enum: "NEW_OBJECT" "NEW_CAMERA" "CONNECTED_CAMERA" "ARC_TRANSFER_DISABLED" "REQUESTED_CAMERA" "CONFIGURATION_REQUIRED"
object
id
required
number (IntId) >= 1

Common Int id

name
required
string (ArcTemplateSetName) non-empty
Example: "SIA with retry"
object (CustomerBase)
name
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
object
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {},
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

Export active objects connected to given ARC

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

Cloud entity id of ARC

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 (ObjectTypeParameter) non-empty unique
Items Enum: "ATHOS" "ATHOS2" "AURA" "AZOR" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 10 more
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

arcTemplateSetId
number (IntId) >= 1

ID of ARC template set

Responses

Response Schema: application/json
csv
required
string <base64> <application/csv>

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

Response Schema: application/json
arcProcessStateUpdateCount
integer <int32> >= 0

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 Schema: application/json
objectId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

objectNumber
required
string (ObjectNumber) ^[\dA-F]{4,8}$
Example: "F13D"
required
object
deviceId
required
string (DeviceEntityId) ^DEVICE_((JACLOUDSN:[A-F\d]{8})|(JASNV1:[\d]{...
Example: "DEVICE_JACLOUDSN:F9100013"
registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
family
required
string (DeviceFamily)
Enum: "ATHOS" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 13 more
Example: "JA100F"
model
required
string (DeviceModel)
Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: "JA107K"
officialName
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"
object (DeviceSimCard)
phoneNumber
required
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

simCardId
required
string (SimCardEntityId) ^SIM_(CUSTOMER|DISTRIBUTOR|SDC):([0-9(a-f|A-F...
Example: "SIM_SDC:46c41735-c931-4bf0-a03a-f39275beea8"
object
date
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

version
required
string
Example: "MD6112.07.1.2dbg"
lastCommunicationChannel
string
Enum: "IP" "SMS" "NONE"
required
object (ArcDistributor)
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

companyLogoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

arcConnectedDate
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object (InstallerCompany)
name
required
string
Example: "Alarm Systems inc."
distributorCompanyId
integer <int64> (DbId) >= 1
Example: "242566"
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

companyLogoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

transferDisabledDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

photoVerificationUrl
string <uri> (HttpUri)
Example: "https://subdomain.domain.tld/path?query#anchor"

URL of some resource

videoVerificationUrl
string <uri> (HttpUri)
Example: "https://subdomain.domain.tld/path?query#anchor"

URL of some resource

hasActiveCamera
boolean
Default: false

Object has registered any camera

labels
Array of strings (ObjectArcLabels) non-empty unique
Items Enum: "NEW_OBJECT" "NEW_CAMERA" "CONNECTED_CAMERA" "ARC_TRANSFER_DISABLED" "REQUESTED_CAMERA" "CONFIGURATION_REQUIRED"
object
id
required
number (IntId) >= 1

Common Int id

name
required
string (ArcTemplateSetName) non-empty
Example: "SIA with retry"
object (CustomerAll)
name
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
type
string (CustomerType)
Enum: "COMPANY" "PERSON"
companyIdentificationNumber
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters
Example: "885255412"

Company identification number

taxIdentificationNumber
string (TaxIdentificationNumber) [ 3 .. 18 ] characters
Example: "CZ885255412"

Company tax identification number

personName
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
personPhoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

street
string (Street) [ 3 .. 64 ] characters
Example: "Pod Houbou 15"

Company street

city
string (City) [ 1 .. 64 ] characters
Example: "Jablonec nad Nisou"

Company city

zipCode
string (ZipCode) ^[\d A-Z\-]{4,10}$
Example: "466 01"

Company zip code

alarmStreet
string (Street) [ 3 .. 64 ] characters
Example: "Pod Houbou 15"

Company street

alarmCity
string (City) [ 1 .. 64 ] characters
Example: "Jablonec nad Nisou"

Company city

alarmZipCode
string (ZipCode) ^[\d A-Z\-]{4,10}$
Example: "466 01"

Company zip code

Array of objects (EndUserAccessItem) non-empty unique
Array (non-empty)
role
required
string (ServiceAccessRole)
Enum: "OWNER" "READ" "CONTROL" "SHARE" "CUSTOM"
userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

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": {
    • "deviceId": "DEVICE_JACLOUDSN:F9100013",
    • "registrationKey": "LAS6D-U2VBG-UHX65",
    • "sim": {
      • "phoneNumber": "+420739259931",
      • "simCardId": "SIM_SDC:46c41735-c931-4bf0-a03a-f39275beea8"
      },
    • "family": "JA100F",
    • "model": "JA107K",
    • "officialName": "JA-101K LAN 3G",
    • "firmware": {
      • "date": "2019-08-24T14:15:22Z",
      • "version": "MD6112.07.1.2dbg"
      },
    • "lastCommunicationChannel": "IP"
    },
  • "labels": [
    • "NEW_OBJECT"
    ],
  • "template": {
    • "id": 1,
    • "name": "SIA with retry"
    },
  • "customer": {
    • "name": "Company s.r.o.",
    • "type": "COMPANY",
    • "companyIdentificationNumber": "885255412",
    • "taxIdentificationNumber": "CZ885255412",
    • "personName": "Company s.r.o.",
    • "personPhoneNumber": "+420739259931",
    • "phoneNumber": "+420739259931",
    • "email": "tomas.janda@jablotron.cz",
    • "street": "Pod Houbou 15",
    • "city": "Jablonec nad Nisou",
    • "zipCode": "466 01",
    • "alarmStreet": "Pod Houbou 15",
    • "alarmCity": "Jablonec nad Nisou",
    • "alarmZipCode": "466 01"
    },
  • "endUsersAccesses": [
    • {
      • "userLogin": "tomas.janda@jablotron.cz",
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
      • "role": "OWNER"
      }
    ]
}

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

Response Schema: application/json
arcProcessStateUpdateCount
integer <int32> >= 0

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

Response Schema: application/json
non-empty
arcObjectNumber
string (ObjectNumber) ^[\dA-F]{4,8}$
Example: "F13D"

Returned for action ARC_OBJECT_NUMBER_CHANGE

Response Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

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 Schema: application/json
required
object
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

logoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

object
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

logoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

object
email
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

object
name
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

personName
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
personPhoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

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 Schema: application/json
Array of objects (CommonComponent) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

position
required
integer <int32> (ComponentPosition) >= 0
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

lastChangeDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Array of objects (CommonComponent) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

position
required
integer <int32> (ComponentPosition) >= 0
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

lastChangeDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Array of objects (PeripheralComponent) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

position
required
integer <int32> (ComponentPosition) >= 0
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

lastChangeDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

model
string
Example: "JA-150M"
lastConfigurationUpdateDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Response samples

Content type
application/json
{
  • "sections": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "position": 0,
      • "lastChangeDate": "2019-08-24T14:15:22Z"
      }
    ],
  • "users": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "position": 0,
      • "lastChangeDate": "2019-08-24T14:15:22Z"
      }
    ],
  • "components": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "position": 0,
      • "lastChangeDate": "2019-08-24T14:15:22Z",
      • "model": "JA-150M"
      }
    ],
  • "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 Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

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

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

Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
action
required
string (SectionControlCommands)
Enum: "ARM" "PARTIAL_ARM" "ARM_FORCE" "PARTIAL_ARM_FORCE" "DISARM"
Array of objects (Authorizations) [ 1 .. 2 ] items unique

Authorization data for control to identify the user on the device

Array ([ 1 .. 2 ] items)
type
required
string
Default: "CODE"
Enum: "CODE" "RFID"

Type of authorization value

required
JA100_CODE (string) or DIAL_CONTROLLER_CODE (string) or SERIAL_NUMBER_DEC (string)
Example: "2*1234"

For type CODE:

  • JA100+ - user code with or without prefix (20*1254, 1234, 1*12345678)
  • GD04K - UTF-8 string up to 30 bytes (Příliš žluťoučký kůň)

For type RFID

  • JA100+ serial number (1400-40-0000-0001)
Any of
string (JA100_CODE) ^([\d]{1,3}\*)?([\d]{4}|[\d]{6}|[\d]{8})$

For type CODE:

  • JA100+ - user code with or without prefix (20*1254, 1234, 1*12345678)
  • GD04K - UTF-8 string up to 30 bytes (Příliš žluťoučký kůň)

For type RFID

  • JA100+ serial number (1400-40-0000-0001)

Responses

Response Schema: application/json
required
Array of SECTION_CONTROL_STATUS (object) or ACTOR_CONTROL_STATUS (object) or PERIPHERAL_CONTROL_STATUS (object) or PICTURE_CONTROL_STATUS (object) or DEVICE_CONFIGURATION_STATUS (object) or DEVICE_STATUS (object) or DEVICE_EVENTS (object) or DEVICE_RESET (object) or CHECK_AUTHORIZATION (object) (ComponentControlResponseStatus) non-empty unique
Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
status
required
string (ControlResponseStatuses)
Enum: "SUCCESS" "NO_CHANGE" "NO_ACCESS" "NOT_READY_TO_ARM" "CAN_NOT_BE_CONTROLLED" "BLOCKED" "PARTIAL_ARM_NOT_ALLOWED" "INVALID_SECTION_STATE_FOR_ACTION" "UNKNOWN"
object
$type
required
string
Value: "BLOCKING_COMPONENTS"
bypassable
required
boolean
Default: false
required
Array of COMPONENT (string) or COMMUNICATOR (string) non-empty unique
Array (non-empty)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
clientTimerSeconds
integer [ 1 .. 60 ]
Default: 8

If returned, client is allowed to force ARM/PARTIAL_ARM after this time

object (Meta) non-empty
firmware
string
Example: "MD6112.05.1"

Current firmware in device

behavior
integer >= 0
Example: "55"

Behavior version of device

registrationKey
string
Example: "L2ASM-ZSVD3-UULS8"

Current registration key of device

Array of SECTION_STATE (object) or ACTOR_STATE (object) or COMPONENT_STATE (object) (ControlResponseStates) non-empty unique
Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
state
required
string (SectionStates)
Enum: "ARM" "PARTIAL_ARM" "DISARM" "MAINTENANCE" "SERVICE" "BLOCK" "OFF" "UNKNOWN"
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

hasActiveAlarms
boolean
canBeControlled
boolean

Request samples

Content type
application/json
{
  • "authorizations": [
    • {
      • "type": "CODE",
      • "value": "2*1234"
      }
    ],
  • "controls": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "action": "ARM"
      }
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    • "firmware": "MD6112.05.1",
    • "behavior": 55,
    • "registrationKey": "L2ASM-ZSVD3-UULS8"
    },
  • "controls": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "status": "SUCCESS",
      • "details": {
        • "$type": "BLOCKING_COMPONENTS",
        • "bypassable": false,
        • "clientTimerSeconds": 8,
        • "components": [
          • "COMPONENT_<OBJECT_JA100F:242566>:25"
          ]
        }
      }
    ],
  • "states": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "state": "ARM",
      • "name": "PIR Bedroom",
      • "hasActiveAlarms": true,
      • "canBeControlled": true
      }
    ]
}

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 Schema: application/json
required
Array of objects (ListOfObjectLogs) >= 0 items unique
Array (>= 0 items)
required
object
actionLogId
required
number (IntId) >= 1

Common Int id

actionType
required
string^[A-Z_]+$
Example: "CONFIGURATION_DOWNLOAD_REQUEST"

Specific action of the object, the list of items can grow, therefore it is not as enum

logDate
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

actionNameTk
required
string
Example: "ObjectLog:Registration key modify"

Action log name translation key

object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "actionLogId": 1,
        • "actionType": "CONFIGURATION_DOWNLOAD_REQUEST",
        • "actionNameTk": "ObjectLog:Registration key modify",
        • "logDate": "2019-08-24T14:15:22Z",
        • "user": {
          • "userLogin": "tomas.janda@jablotron.cz",
          • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
          }
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

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 Schema: application/json
Array (>= 0 items)
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
objectsCount
integer <int32> >= 0
Example: "156"

Response samples

Content type
application/json
[
  • {
    • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
    • "name": "Company s.r.o.",
    • "objectsCount": 156
    }
]

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 Schema: application/json
Array (>= 0 items)
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
distributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
objectsCount
integer <int32> >= 0
Example: "156"

Response samples

Content type
application/json
[
  • {
    • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
    • "distributorInstallerId": 242566,
    • "name": "Company s.r.o.",
    • "objectsCount": 156
    }
]

Get arc companies for logged user

Authorizations:
KongResolverOAuthJCS

Responses

Response Schema: application/json
Array (>= 0 items)
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
required
object
role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
hasDefaultTemplate
boolean
Default: false

Indicates whether the DIRECT ARC has a default template set

Response samples

Content type
application/json
[
  • {
    • "arcId": "ARC_CLOUD:00008808",
    • "name": "Company s.r.o.",
    • "hasDefaultTemplate": false,
    • "me": {
      • "role": "USER"
      }
    }
]

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 Schema: application/json
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
required
object
role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
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

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

countryCode
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

Description (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 255 ] characters
string (Description) [ 1 .. 255 ] characters

null only for PATCH to remove current value

boolean or null

null only for PATCH to remove current value

One of
boolean

null only for PATCH to remove current value

companyLogoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

disabledFunctions
Array of strings (DisabledFunctions) non-empty unique
Items Enum: "REMOTE_CONTROL" "CAMERA_MANAGEMENT" "COMMUNICATION_NUMBER_MODIFICATION" "ARC_TRANSFER_MODIFICATION" "DOWNLOAD_CONFIGURATION" "REGISTRATION"

Returned only if the ARC has at least one disabled function.

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": {
    • "role": "USER"
    },
  • "disabledFunctions": [
    • "REMOTE_CONTROL"
    ]
}

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

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

countryCode
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

Description (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 255 ] characters
string (Description) [ 1 .. 255 ] characters

null only for PATCH to remove current value

boolean or null

null only for PATCH to remove current value

One of
boolean

null only for PATCH to remove current value

name
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
required
object
hasAnyActiveCamera
required
boolean
Default: false

If any camera is active, you cannot remove the last IP address from the list

autoTransferDisabled
required
boolean
Default: false

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.

ipAddressApplication
Array of strings (IpAddressApplicationModule) non-empty unique
Items Enum: "MY_ARC" "CAMERA_VERIFICATION"

Returned only if the ARC has at least one IP address set. Item CAMERA_VERIFICATION is always required

disabledFunctions
Array of strings (DisabledFunctions) non-empty unique
Items Enum: "REMOTE_CONTROL" "CAMERA_MANAGEMENT" "COMMUNICATION_NUMBER_MODIFICATION" "ARC_TRANSFER_MODIFICATION" "DOWNLOAD_CONFIGURATION" "REGISTRATION"

Returned only if the ARC has at least one disabled function.

Response samples

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

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": [
    • "MY_ARC"
    ],
  • "autoTransferDisabled": true
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array
arcUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
lastLoggedDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

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"
    }
]

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)
Example: "tomas.janda@jablotron.cz"

Email address

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

Responses

Response Schema: application/json
arcUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
lastLoggedDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array (>= 0 items)
One of
string <ipv4> (IPV4)

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array
notificationId
required
integer <int64> (DbId) >= 1
Example: "242566"
targetType
required
string
Value: "EMAIL"
target
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

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" … 15 more
lastUpdate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

lastUpdateUserId
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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": [
      • "ARC_CONNECTED"
      ],
    • "languageCode": "CS"
    }
]

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)
Example: "tomas.janda@jablotron.cz"

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" … 15 more

Responses

Response Schema: application/json
notificationId
required
integer <int64> (DbId) >= 1
Example: "242566"
targetType
required
string
Value: "EMAIL"
target
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

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" … 15 more
lastUpdate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

lastUpdateUserId
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

Request samples

Content type
application/json
{
  • "targetType": "EMAIL",
  • "target": "tomas.janda@jablotron.cz",
  • "categories": [
    • "ARC_CONNECTED"
    ],
  • "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": [
    • "ARC_CONNECTED"
    ],
  • "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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • "ARC_CONNECTED"
    ]
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Get logged user information

Authorizations:
KongResolverOAuthJCS

Responses

Response Schema: application/json
non-empty
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

PHONE_NUMBER (string) or null
One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

NAME_AND_SURNAME (string) or null
One of
[ 1 .. 70 ] characters
string (NAME_AND_SURNAME) [ 1 .. 70 ] characters

Name of a person, each part of name must be maximal 30 characters long

newsletterAllowed
boolean

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
One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

NAME_AND_SURNAME (string) or null
One of
[ 1 .. 70 ] characters
string (NAME_AND_SURNAME) [ 1 .. 70 ] characters

Name of a person, each part of name must be maximal 30 characters long

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array (>= 0 items)
name
required
string (ArcTemplateSetName) non-empty
Example: "SIA with retry"
required
object (ArcTemplateExtended)
protocol
required
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
required
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
isDefault
required
boolean
Example: "true"

default false

canBeSetAsDefault
required
boolean
Example: "true"

default false

isDeprecated
required
boolean
Example: "false"

default false

templateSetId
required
number (IntId) >= 1

Common Int id

secondaryTemplateIsBackup
boolean
Example: "false"

If true, secondaryTemplate has to be set

object (ArcTemplateExtended)
protocol
required
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
required
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
activeObjects
integer >= 1
Example: "4"

Response samples

Content type
application/json
[
  • {
    • "name": "SIA with retry",
    • "isDefault": true,
    • "secondaryTemplateIsBackup": false,
    • "primaryTemplate": {
      • "protocol": "JABLOTRON_IP",
      • "primaryDomain": "cid.jablotron.cloud:2565",
      • "secondaryDomain": "cid.jablotron.cloud:2565",
      • "heartbeatReportTime": 60,
      • "heartbeatReportTimeIsFixed": true,
      • "retryCount": 1,
      • "retryDelaySeconds": 10
      },
    • "secondaryTemplate": {
      • "protocol": "JABLOTRON_IP",
      • "primaryDomain": "cid.jablotron.cloud:2565",
      • "secondaryDomain": "cid.jablotron.cloud:2565",
      • "heartbeatReportTime": 60,
      • "heartbeatReportTimeIsFixed": true,
      • "retryCount": 1,
      • "retryDelaySeconds": 10
      },
    • "canBeSetAsDefault": true,
    • "isDeprecated": false,
    • "templateSetId": 1,
    • "activeObjects": 4
    }
]

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
Example: "SIA with retry"
required
object (ArcTemplateExtended)
protocol
required
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
required
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
isDefault
required
boolean
Example: "true"

default false

secondaryTemplateIsBackup
boolean
Example: "false"

If true, secondaryTemplate has to be set

object (ArcTemplateExtended)
protocol
required
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
required
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60

Responses

Response Schema: application/json
templateSetId
required
number (IntId) >= 1

Common Int id

name
string (ArcTemplateSetName) non-empty
Example: "SIA with retry"
isDefault
boolean
Example: "true"

default false

secondaryTemplateIsBackup
boolean
Example: "false"

If true, secondaryTemplate has to be set

object (ArcTemplateExtended)
protocol
required
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
required
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
object (ArcTemplateExtended)
protocol
required
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
required
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
canBeSetAsDefault
boolean
Example: "true"

default false

isDeprecated
boolean
Example: "false"

default false

Request samples

Content type
application/json
{
  • "name": "SIA with retry",
  • "isDefault": true,
  • "secondaryTemplateIsBackup": false,
  • "primaryTemplate": {
    • "protocol": "JABLOTRON_IP",
    • "primaryDomain": "cid.jablotron.cloud:2565",
    • "secondaryDomain": "cid.jablotron.cloud:2565",
    • "heartbeatReportTime": 60,
    • "heartbeatReportTimeIsFixed": true,
    • "retryCount": 1,
    • "retryDelaySeconds": 10
    },
  • "secondaryTemplate": {
    • "protocol": "JABLOTRON_IP",
    • "primaryDomain": "cid.jablotron.cloud:2565",
    • "secondaryDomain": "cid.jablotron.cloud:2565",
    • "heartbeatReportTime": 60,
    • "heartbeatReportTimeIsFixed": true,
    • "retryCount": 1,
    • "retryDelaySeconds": 10
    }
}

Response samples

Content type
application/json
{
  • "templateSetId": 1,
  • "name": "SIA with retry",
  • "isDefault": true,
  • "secondaryTemplateIsBackup": false,
  • "primaryTemplate": {
    • "protocol": "JABLOTRON_IP",
    • "primaryDomain": "cid.jablotron.cloud:2565",
    • "secondaryDomain": "cid.jablotron.cloud:2565",
    • "heartbeatReportTime": 60,
    • "heartbeatReportTimeIsFixed": true,
    • "retryCount": 1,
    • "retryDelaySeconds": 10
    },
  • "secondaryTemplate": {
    • "protocol": "JABLOTRON_IP",
    • "primaryDomain": "cid.jablotron.cloud:2565",
    • "secondaryDomain": "cid.jablotron.cloud:2565",
    • "heartbeatReportTime": 60,
    • "heartbeatReportTimeIsFixed": true,
    • "retryCount": 1,
    • "retryDelaySeconds": 10
    },
  • "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 Schema: application/json
name
required
string (ArcTemplateSetName) non-empty
Example: "SIA with retry"
required
object (ArcTemplateExtended)
protocol
required
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
required
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
isDefault
required
boolean
Example: "true"

default false

canBeSetAsDefault
required
boolean
Example: "true"

default false

isDeprecated
required
boolean
Example: "false"

default false

templateSetId
required
number (IntId) >= 1

Common Int id

secondaryTemplateIsBackup
boolean
Example: "false"

If true, secondaryTemplate has to be set

object (ArcTemplateExtended)
protocol
required
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
required
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
activeObjects
integer >= 1
Example: "4"

Response samples

Content type
application/json
{
  • "name": "SIA with retry",
  • "isDefault": true,
  • "secondaryTemplateIsBackup": false,
  • "primaryTemplate": {
    • "protocol": "JABLOTRON_IP",
    • "primaryDomain": "cid.jablotron.cloud:2565",
    • "secondaryDomain": "cid.jablotron.cloud:2565",
    • "heartbeatReportTime": 60,
    • "heartbeatReportTimeIsFixed": true,
    • "retryCount": 1,
    • "retryDelaySeconds": 10
    },
  • "secondaryTemplate": {
    • "protocol": "JABLOTRON_IP",
    • "primaryDomain": "cid.jablotron.cloud:2565",
    • "secondaryDomain": "cid.jablotron.cloud:2565",
    • "heartbeatReportTime": 60,
    • "heartbeatReportTimeIsFixed": true,
    • "retryCount": 1,
    • "retryDelaySeconds": 10
    },
  • "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
Example: "SIA with retry"
isDefault
boolean
Example: "true"

default false

secondaryTemplateIsBackup
boolean
Example: "false"

If true, secondaryTemplate has to be set

object (ArcTemplatePatch)
protocol
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
object (ArcTemplatePatch)
protocol
string
Enum: "JABLOTRON_IP" "SIA_UDP" "JABLOTRON_PICTURE" "JABLOTRON_SMS" "CID_PSTN" "CID_GSM"
Example: "JABLOTRON_IP"
PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

PhoneBasedProtocol (string) or IpBasedProtocols (string) (ArcProtocolDomain)
Example: "cid.jablotron.cloud:2565"
Any of
string (PhoneBasedProtocol) ^(?:\d{1,32}|\+\d{1,31})$

For protocol CID_PSTN in format with optional + followed by 1-31 alphanumeric characters

heartbeatReportTime
integer [ 0 .. 1439 ]
Example: "60"

Time in minutes

heartbeatReportTimeIsFixed
boolean
Example: "true"
  • If true: value is interpreted as fixed time HH:MM (0 = 00:00, 1439 = 23:59)
  • if false: value is an interval in minutes
retryCount
integer
Example: "1"
  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 0–14
  • JABLOTRON_SMS: 0–2
  • CID_PSTN: 0–3
  • CID_GSM: 0–5
retryDelaySeconds
integer [ 0 .. 3600 ]
Example: "10"

Only if retryCount > 0

  • JABLOTRON_IP, SIA_UDP, JABLOTRON_PICTURE: 1–3600
  • JABLOTRON_SMS: 60–120
  • CID_GSM: 30–120
  • CID_PSTN: 1–60
reconfigureObjects
boolean
Default: false

If true, it will return number of reconfigured objects

Responses

Response Schema: application/json
required
Array of objects >= 0 items unique

Returned only if reconfigureObjects in request was true, can be empty!

Array (>= 0 items)
objectEntityId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

Request samples

Content type
application/json
{
  • "name": "SIA with retry",
  • "isDefault": true,
  • "secondaryTemplateIsBackup": false,
  • "primaryTemplate": {
    • "protocol": "JABLOTRON_IP",
    • "primaryDomain": "cid.jablotron.cloud:2565",
    • "secondaryDomain": "cid.jablotron.cloud:2565",
    • "heartbeatReportTime": 60,
    • "heartbeatReportTimeIsFixed": true,
    • "retryCount": 1,
    • "retryDelaySeconds": 10
    },
  • "secondaryTemplate": {
    • "protocol": "JABLOTRON_IP",
    • "primaryDomain": "cid.jablotron.cloud:2565",
    • "secondaryDomain": "cid.jablotron.cloud:2565",
    • "heartbeatReportTime": 60,
    • "heartbeatReportTimeIsFixed": true,
    • "retryCount": 1,
    • "retryDelaySeconds": 10
    },
  • "reconfigureObjects": false
}

Response samples

Content type
application/json
{
  • "reconfigurationRequests": [
    • {
      • "objectEntityId": "OBJECT_JA100F:242566",
      • "requestId": "DCD-1254445521"
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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

Response Schema: application/json
Array (non-empty)
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

objectId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"

Request samples

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

Response samples

Content type
application/json
[
  • {
    • "requestId": "DCD-1254445521",
    • "objectId": "OBJECT_JA100F:242566"
    }
]

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 Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

state
required
string (ProcessState)
Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
type
required
string (ProcessType)
Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" … 4 more

CONFIGURATION is deprecated, use CONFIGURATION_DOWNLOAD instead

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

scheduledAt
string <date-time> (DateTime)

Only available for CREATED status

completedAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

success
boolean
Default: true

Only available for completed status

object

Only available for non-success status

code
required
string (ProcessErrorType)
Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" … 3 more
debugMessage
string non-empty
Example: "Cannot connect to device via YTUN"
object non-empty
userName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originUserName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originRequestId
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

remainingAttempts
integer >= 0

Returns only for unfinished requests and tells how many attempts (including the currently running one) remain.

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": {
    • "code": "CANCELED_BY_OTHER_PROCESS",
    • "debugMessage": "Cannot connect to device via YTUN"
    },
  • "meta": {
    • "userName": "tomas.janda@jablotron.cz",
    • "originUserName": "tomas.janda@jablotron.cz",
    • "originRequestId": "DCD-1254445521",
    • "remainingAttempts": 0
    }
}

System

System resources

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 Schema: application/json
Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

status
required
string (SectionStatusType)
Enum: "DISARMED" "ARMED_PARTIALLY" "ARMED_FULL" "MAINTENANCE" "SERVICE" "UNKNOWN"

Current state of section

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
statusDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

partialArmEnabled
boolean (PartialArmEnabled)

Section has enabled partially arm

Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

status
required
string (ActorStatusType)
Enum: "ON" "OFF" "UNKNOWN"

Current state of actor

controllable
required
boolean
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
statusDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

reaction
string (ActorReactionType)
Enum: "PULSE" "SWITCH" "COPY" "COPY_AFTER_TIME" "PULSE_EXTENDED" "INVERT" "ACTOR_DISABLED"
interval
string (DateInterval) ^-?P[\dYMDTHS]+$
Example: "-P1DT10M"

Date time interval format

Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
arcConnectionStatus
string
Default: "NONE"
Enum: "NONE" "REQUESTED" "CONNECTED"

One of connection state: REQUESTED => user has sent request to ARC, but ARC not yet accepted. CONNECTED => camera is connected to ARC

object (LastPictureModel)
Deprecated
url
required
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

occurredAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

macAddress
string (MacAddress) ^[\da-z]{2}:[\da-z]{2}:[\da-z]{2}:[\da-z]{2}:...
Example: "54:c4:15:8c:56:df"
Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

streamUrl
required
string
Example: "rtsp://wowzaec2demo.streamlock.net/vod/mp4:BigBuckBunny_115k.mp4"
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
object (LastPictureModel)
url
required
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

occurredAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
currentTemperature
number <float> (Temperature)
Example: "-13.5"

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

currentTemperatureTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

heatingState
string (HeatingState)
Enum: "NOT_CONFIGURED" "HEATING" "BLOCKED" "STANDBY"

Current status of heating status

object (ThermometerExtendedSettings)
minimumTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

maximumTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

triggerTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

Array of THERMOSTAT_V2 (object) or THERMOSTAT (object) non-empty unique
Array (non-empty)
One of
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

$type
required
string
Value: "THERMOSTAT_V2"
floorThermometerEnabled
required
boolean
Default: false
required
object (ThermostatBaseSettings)
minimumTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

maximumTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

economyTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

comfortTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

standbyTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

required
object (ThermostatV2Meta)
measurables
required
Array of strings (Measurable) non-empty unique
Items Enum: "TEMPERATURE" "FLOOR_TEMPERATURE" "HUMIDITY" "CO2_CONCENTRATION"
Example: [["TEMPERATURE","CO2_CONCENTRATION"]]
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
currentTemperature
number <float> (Temperature)
Example: "-13.5"

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

currentTemperatureTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object (ThermostatV2Mode)
temperature
required
number <float> (Temperature)
Example: "-13.5"

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

lastChange
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

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

Current thermostat mode

calendarMode
string (CalendarMode)
Enum: "ECONOMIC" "COMFORT" "ECONOMIC_FORCED"

ECONOMIC_FORCED - switched forced to economic - section is armed

currentTemperatureFloor
number <float> (Temperature)
Example: "-13.5"

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

currentTemperatureFloorTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

currentHumidity
integer (Percent) [ 0 .. 100 ]

Value in percent without decimal

currentHumidityTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

currentCo2Concentration
integer (PartsPerMillion) >= 0

Integer value >= 0

currentCo2ConcentrationTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

actorState
string (ThermostatActorState)
Enum: "NOT_CONFIGURED" "ACTIVE" "BLOCKED" "STANDBY"

Current status of actor

ventilationState
string (ThermostatActorState)
Enum: "NOT_CONFIGURED" "ACTIVE" "BLOCKED" "STANDBY"

Current status of actor

thermostatMode
string (OperationalMode)
Enum: "HEATING" "COOLING"

Current thermostat mode

Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

isConfigured
required
boolean
manualConsumptionAlignment
required
boolean
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
object
required
object (PulseMeterUserSettingsWithMode)
unit
required
string (PulseMeterUnits)
Enum: "KWH" "L" "PCS" "M3" "PULSES"

Units of consumption

displayMode
required
string (PulseMeterDisplayMode)
Enum: "SINGLE" "DUAL"
currency
string (Currency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" … 155 more

Allowed CLOUD currencies

totalConsumption
required
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

lastMeasureDate
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

totalConsumptionLo
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

totalConsumptionHi
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

totalCost
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

totalCostLo
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

totalCostHi
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

currentMonthConsumption
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

currentMonthConsumptionLo
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

currentMonthConsumptionHi
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

currentMonthCost
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

currentMonthCostLo
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

currentMonthCostHi
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

todayConsumptionLo
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

todayConsumptionHi
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

todayConsumption
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

todayCostLo
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

todayCostHi
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

todayCost
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

Response samples

Content type
application/json
{
  • "sections": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "status": "DISARMED",
      • "statusDate": "2019-08-24T14:15:22Z",
      • "partialArmEnabled": true
      }
    ],
  • "actors": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "status": "ON",
      • "statusDate": "2019-08-24T14:15:22Z",
      • "reaction": "PULSE",
      • "interval": "-P1DT10M",
      • "controllable": true
      }
    ],
  • "cameras": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "arcConnectionStatus": "NONE",
      • "lastPicture": {},
      • "macAddress": "54:c4:15:8c:56:df"
      }
    ],
  • "customCameras": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "streamUrl": "rtsp://wowzaec2demo.streamlock.net/vod/mp4:BigBuckBunny_115k.mp4"
      }
    ],
  • "cameraDetectors": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "lastPicture": {}
      }
    ],
  • "thermometers": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "currentTemperature": -13.5,
      • "currentTemperatureTime": "2019-08-24T14:15:22Z",
      • "heatingState": "NOT_CONFIGURED",
      • "settings": {
        • "minimumTemperature": -13.5,
        • "maximumTemperature": -13.5,
        • "triggerTemperature": -13.5
        }
      }
    ],
  • "thermostats": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "currentTemperature": -13.5,
      • "currentTemperatureTime": "2019-08-24T14:15:22Z",
      • "currentMode": {
        • "calendarMode": "ECONOMIC",
        • "mode": "MANUAL",
        • "temperature": -13.5,
        • "lastChange": "2019-08-24T14:15:22Z"
        },
      • "currentTemperatureFloor": -13.5,
      • "currentTemperatureFloorTime": "2019-08-24T14:15:22Z",
      • "currentHumidity": 100,
      • "currentHumidityTime": "2019-08-24T14:15:22Z",
      • "currentCo2Concentration": 0,
      • "currentCo2ConcentrationTime": "2019-08-24T14:15:22Z",
      • "actorState": "NOT_CONFIGURED",
      • "ventilationState": "NOT_CONFIGURED",
      • "thermostatMode": "HEATING",
      • "floorThermometerEnabled": false,
      • "settings": {
        • "minimumTemperature": -13.5,
        • "maximumTemperature": -13.5,
        • "economyTemperature": -13.5,
        • "comfortTemperature": -13.5,
        • "standbyTemperature": -13.5
        },
      • "meta": {
        • "measurables": [
          • [
            • "TEMPERATURE",
            • "CO2_CONCENTRATION"
            ]
          ]
        },
      • "$type": "THERMOSTAT_V2"
      }
    ],
  • "pulseMeters": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "isConfigured": true,
      • "manualConsumptionAlignment": true,
      • "summary": {
        • "lastMeasureDate": "2019-08-24T14:15:22Z",
        • "totalConsumption": 15.2365,
        • "totalConsumptionLo": 15.2365,
        • "totalConsumptionHi": 15.2365,
        • "totalCost": 1.52,
        • "totalCostLo": 1.52,
        • "totalCostHi": 1.52,
        • "currentMonthConsumption": 15.2365,
        • "currentMonthConsumptionLo": 15.2365,
        • "currentMonthConsumptionHi": 15.2365,
        • "currentMonthCost": 1.52,
        • "currentMonthCostLo": 1.52,
        • "currentMonthCostHi": 1.52,
        • "todayConsumptionLo": 15.2365,
        • "todayConsumptionHi": 15.2365,
        • "todayConsumption": 15.2365,
        • "todayCostLo": 1.52,
        • "todayCostHi": 1.52,
        • "todayCost": 1.52,
        • "meta": {
          • "unit": "KWH",
          • "currency": "AED",
          • "displayMode": "SINGLE"
          }
        }
      }
    ]
}

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 Schema: application/json
service
required
boolean
Default: false

It's true when section is in state = service

required
Array of objects (SectionCurrentStateModel) non-empty unique
Array (non-empty)
id
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
state
required
string (SectionCurrentStatusType)
Enum: "DISARMED" "ARMED_PARTIALLY" "ARMED_FULL" "MAINTENANCE" "SERVICE" "BLOCKED"

Current state of section only for uses of GetActualCurrentObjectStates

Array of objects (ActorCurrentStateModel) non-empty unique
Array (non-empty)
id
required
string (ActorEntityId) ^ACTOR_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "ACTOR_<OBJECT_JA100F:242566>:5"
state
required
string (ActorCurrentStatusType)
Enum: "ON" "OFF"

Current state of actor only for uses of GetActualCurrentObjectStates

Response samples

Content type
application/json
{
  • "service": false,
  • "sections": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:242566>:1",
      • "state": "DISARMED"
      }
    ],
  • "actors": [
    • {
      • "id": "ACTOR_<OBJECT_JA100F:242566>:5",
      • "state": "ON"
      }
    ]
}

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 Schema: application/json
correlationId
required
string (CorrelationId) ^(?:[\w\d\.\-_]+-)?[\da-fA-F]{8}-[\da-fA-F]{4...
Example: "api.cv1-core-2cea8c53-5da1-4f05-b229-ec5a0be27b1e"

Correlation id of request with optional app prefix

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 Schema: application/json
required
object
serviceMode
boolean (BoolVal)
maintenance
boolean (BoolVal)
ALARM_DETAILS (object) or BoolVal (boolean)
One of
non-empty
intrusion
boolean (BoolVal)
fire
boolean (BoolVal)
flood
boolean (BoolVal)
gas
boolean (BoolVal)
panic
boolean (BoolVal)
sabotage
boolean (BoolVal)
health
boolean (BoolVal)
overCode
boolean (BoolVal)
trouble
boolean (BoolVal)
Array of SECURITY_SYSTEM_SECTION (object) or ACTOR (object)
Array
One of
$type
string
Value: "SECURITY_SYSTEM_SECTION"
state
string
Enum: "ARMED" "ARMED_PARTIAL" "DISARMED" "MAINTENANCE" "SERVICE"
count
number [ 0 .. 16 ]

Response samples

Content type
application/json
{
  • "global": {
    • "serviceMode": false,
    • "maintenance": false,
    • "alarm": {
      • "intrusion": false,
      • "fire": false,
      • "flood": false,
      • "gas": false,
      • "panic": false,
      • "sabotage": false,
      • "health": false,
      • "overCode": false
      },
    • "trouble": false
    },
  • "components": [
    • {
      • "$type": "SECURITY_SYSTEM_SECTION",
      • "state": "ARMED",
      • "count": 16
      }
    ]
}

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

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

Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
action
required
string (SectionControlCommands)
Enum: "ARM" "PARTIAL_ARM" "ARM_FORCE" "PARTIAL_ARM_FORCE" "DISARM"
Array of objects (Authorizations) [ 1 .. 2 ] items unique

Authorization data for control to identify the user on the device

Array ([ 1 .. 2 ] items)
type
required
string
Default: "CODE"
Enum: "CODE" "RFID"

Type of authorization value

required
JA100_CODE (string) or DIAL_CONTROLLER_CODE (string) or SERIAL_NUMBER_DEC (string)
Example: "2*1234"

For type CODE:

  • JA100+ - user code with or without prefix (20*1254, 1234, 1*12345678)
  • GD04K - UTF-8 string up to 30 bytes (Příliš žluťoučký kůň)

For type RFID

  • JA100+ serial number (1400-40-0000-0001)
Any of
string (JA100_CODE) ^([\d]{1,3}\*)?([\d]{4}|[\d]{6}|[\d]{8})$

For type CODE:

  • JA100+ - user code with or without prefix (20*1254, 1234, 1*12345678)
  • GD04K - UTF-8 string up to 30 bytes (Příliš žluťoučký kůň)

For type RFID

  • JA100+ serial number (1400-40-0000-0001)

Responses

Response Schema: application/json
required
Array of SECTION_CONTROL_STATUS (object) or ACTOR_CONTROL_STATUS (object) or PERIPHERAL_CONTROL_STATUS (object) or PICTURE_CONTROL_STATUS (object) or DEVICE_CONFIGURATION_STATUS (object) or DEVICE_STATUS (object) or DEVICE_EVENTS (object) or DEVICE_RESET (object) or CHECK_AUTHORIZATION (object) (ComponentControlResponseStatus) non-empty unique
Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
status
required
string (ControlResponseStatuses)
Enum: "SUCCESS" "NO_CHANGE" "NO_ACCESS" "NOT_READY_TO_ARM" "CAN_NOT_BE_CONTROLLED" "BLOCKED" "PARTIAL_ARM_NOT_ALLOWED" "INVALID_SECTION_STATE_FOR_ACTION" "UNKNOWN"
object
$type
required
string
Value: "BLOCKING_COMPONENTS"
bypassable
required
boolean
Default: false
required
Array of COMPONENT (string) or COMMUNICATOR (string) non-empty unique
Array (non-empty)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
clientTimerSeconds
integer [ 1 .. 60 ]
Default: 8

If returned, client is allowed to force ARM/PARTIAL_ARM after this time

object (Meta) non-empty
firmware
string
Example: "MD6112.05.1"

Current firmware in device

behavior
integer >= 0
Example: "55"

Behavior version of device

registrationKey
string
Example: "L2ASM-ZSVD3-UULS8"

Current registration key of device

Array of SECTION_STATE (object) or ACTOR_STATE (object) or COMPONENT_STATE (object) (ControlResponseStates) non-empty unique
Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
state
required
string (SectionStates)
Enum: "ARM" "PARTIAL_ARM" "DISARM" "MAINTENANCE" "SERVICE" "BLOCK" "OFF" "UNKNOWN"
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

hasActiveAlarms
boolean
canBeControlled
boolean

Request samples

Content type
application/json
{
  • "authorizations": [
    • {
      • "type": "CODE",
      • "value": "2*1234"
      }
    ],
  • "controls": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "action": "ARM"
      }
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    • "firmware": "MD6112.05.1",
    • "behavior": 55,
    • "registrationKey": "L2ASM-ZSVD3-UULS8"
    },
  • "controls": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "status": "SUCCESS",
      • "details": {
        • "$type": "BLOCKING_COMPONENTS",
        • "bypassable": false,
        • "clientTimerSeconds": 8,
        • "components": [
          • "COMPONENT_<OBJECT_JA100F:242566>:25"
          ]
        }
      }
    ],
  • "states": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "state": "ARM",
      • "name": "PIR Bedroom",
      • "hasActiveAlarms": true,
      • "canBeControlled": true
      }
    ]
}

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

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

Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
action
required
string (SectionControlCommands)
Enum: "ARM" "PARTIAL_ARM" "ARM_FORCE" "PARTIAL_ARM_FORCE" "DISARM"
Array of objects (Authorizations) [ 1 .. 2 ] items unique

Authorization data for control to identify the user on the device

Array ([ 1 .. 2 ] items)
type
required
string
Default: "CODE"
Enum: "CODE" "RFID"

Type of authorization value

required
JA100_CODE (string) or DIAL_CONTROLLER_CODE (string) or SERIAL_NUMBER_DEC (string)
Example: "2*1234"

For type CODE:

  • JA100+ - user code with or without prefix (20*1254, 1234, 1*12345678)
  • GD04K - UTF-8 string up to 30 bytes (Příliš žluťoučký kůň)

For type RFID

  • JA100+ serial number (1400-40-0000-0001)
Any of
string (JA100_CODE) ^([\d]{1,3}\*)?([\d]{4}|[\d]{6}|[\d]{8})$

For type CODE:

  • JA100+ - user code with or without prefix (20*1254, 1234, 1*12345678)
  • GD04K - UTF-8 string up to 30 bytes (Příliš žluťoučký kůň)

For type RFID

  • JA100+ serial number (1400-40-0000-0001)
devicePhoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

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

Responses

Response Schema: application/json
required
Array of SECTION_CONTROL_STATUS (object) or ACTOR_CONTROL_STATUS (object) or PERIPHERAL_CONTROL_STATUS (object) or PICTURE_CONTROL_STATUS (object) or DEVICE_CONFIGURATION_STATUS (object) or DEVICE_STATUS (object) or DEVICE_EVENTS (object) or DEVICE_RESET (object) or CHECK_AUTHORIZATION (object) (ComponentControlResponseStatus) non-empty unique
Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
status
required
string (ControlResponseStatuses)
Enum: "SUCCESS" "NO_CHANGE" "NO_ACCESS" "NOT_READY_TO_ARM" "CAN_NOT_BE_CONTROLLED" "BLOCKED" "PARTIAL_ARM_NOT_ALLOWED" "INVALID_SECTION_STATE_FOR_ACTION" "UNKNOWN"
object
$type
required
string
Value: "BLOCKING_COMPONENTS"
bypassable
required
boolean
Default: false
required
Array of COMPONENT (string) or COMMUNICATOR (string) non-empty unique
Array (non-empty)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
clientTimerSeconds
integer [ 1 .. 60 ]
Default: 8

If returned, client is allowed to force ARM/PARTIAL_ARM after this time

object (Meta) non-empty
firmware
string
Example: "MD6112.05.1"

Current firmware in device

behavior
integer >= 0
Example: "55"

Behavior version of device

registrationKey
string
Example: "L2ASM-ZSVD3-UULS8"

Current registration key of device

Array of SECTION_STATE (object) or ACTOR_STATE (object) or COMPONENT_STATE (object) (ControlResponseStates) non-empty unique
Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
state
required
string (SectionStates)
Enum: "ARM" "PARTIAL_ARM" "DISARM" "MAINTENANCE" "SERVICE" "BLOCK" "OFF" "UNKNOWN"
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

hasActiveAlarms
boolean
canBeControlled
boolean

Request samples

Content type
application/json
{
  • "authorizations": [
    • {
      • "type": "CODE",
      • "value": "2*1234"
      }
    ],
  • "controls": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "action": "ARM"
      }
    ],
  • "devicePhoneNumber": "+420739259931"
}

Response samples

Content type
application/json
{
  • "meta": {
    • "firmware": "MD6112.05.1",
    • "behavior": 55,
    • "registrationKey": "L2ASM-ZSVD3-UULS8"
    },
  • "controls": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "status": "SUCCESS",
      • "details": {
        • "$type": "BLOCKING_COMPONENTS",
        • "bypassable": false,
        • "clientTimerSeconds": 8,
        • "components": [
          • "COMPONENT_<OBJECT_JA100F:242566>:25"
          ]
        }
      }
    ],
  • "states": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "state": "ARM",
      • "name": "PIR Bedroom",
      • "hasActiveAlarms": true,
      • "canBeControlled": true
      }
    ]
}

Register Dial controller and create CLOUD account (deprecated path) Deprecated

Deprecated endpoint path kept for backward compatibility. Please use /api/{v1}/devices/dial-controller/register.

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Registration params

ownerLoginName
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

required
DEVICE_IDENTITY (string) or REGISTRATION_KEY (string)
One of
string (DEVICE_IDENTITY) ^DEVICE_((JACLOUDSN:[A-F\d]{8})|(JASNV1:[\d]{...
serviceName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

Responses

Response Schema: application/json
serviceEntityId
required
string (ServiceEntityId) ^SERVICE_(\w+):([\d]+)$
Example: "SERVICE_JA100F:242566"
objectEntityId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"

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"
}

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
Array ([ 1 .. 2 ] items)
payload
required
string^[\da-fA-F]+$
Example: "48AE39481000320000000E00040100000003020000000F000200000000100002010000001A000111000000313431302D30302D303035362D38363238"

Protocol payload in HEX

payloadType
required
string (PayloadType)
Enum: "REQUEST" "RESPONSE"

Type of protocol payload

Responses

Response Schema: application/json
Array ([ 1 .. 2 ] items)
dump
required
string <byte>
Example: "U3dhZ2dlciByb2Nrcw=="

Payload protocol dump in base64

payloadType
required
string (PayloadType)
Enum: "REQUEST" "RESPONSE"

Type of protocol payload

Request samples

Content type
application/json
{
  • "format": "JSON",
  • "payloads": [
    • {
      • "payload": "48AE39481000320000000E00040100000003020000000F000200000000100002010000001A000111000000313431302D30302D303035362D38363238",
      • "payloadType": "REQUEST"
      }
    ]
}

Response samples

Content type
application/json
[
  • {
    • "dump": "U3dhZ2dlciByb2Nrcw==",
    • "payloadType": "REQUEST"
    }
]

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 Schema: application/json
Array of objects (SharedAccount) non-empty
Array (non-empty)
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

role
required
string (ServiceAccessRole)
Enum: "OWNER" "READ" "CONTROL" "SHARE" "CUSTOM"
Array of objects (AccessComponentWithPermission) non-empty
Array (non-empty)
$type
required
string
Enum: "SECTION" "ACTOR" "THERMOMETER" "THERMOSTAT" "PULSE_METER" "CAMERA_PIR" "CAMERA"
required
COMPONENT (string) or SECTION (string) or ACTOR (string) or JABLOTRON_CAMERA (string)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
required
SECTION_PERMISSIONS (object) or ACTOR_PERMISSIONS (object) or THERMOMETER_PERMISSIONS (object) or THERMOSTAT_PERMISSIONS (object) or PULSE_METER_PERMISSIONS (object) or CAMERA_PIR_PERMISSIONS (object) or CAMERA_PERMISSIONS (object) (ComponentPermissionItem)
One of
non-empty
$type
required
string
Value: "SECTION_PERMISSIONS"
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentControl
boolean (BoolVal)
notificationModify
boolean (BoolVal)
componentShare
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

Response samples

Content type
application/json
{
  • "accesses": [
    • {
      • "userLogin": "tomas.janda@jablotron.cz",
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
      • "role": "OWNER",
      • "components": [
        • {
          • "$type": "SECTION",
          • "id": "COMPONENT_<OBJECT_JA100F:242566>:25",
          • "name": "PIR Bedroom",
          • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
          • "defaultNameTVar": {
            • "entityId": "5"
            },
          • "permissions": {
            • "$type": "SECTION_PERMISSIONS",
            • "stateView": false,
            • "historyRead": false,
            • "componentControl": false,
            • "notificationModify": false,
            • "componentShare": false,
            • "componentNameModify": false
            }
          }
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array (>= 0 items)
id
required
string <uuid> (UuidString)
Example: "296ffe8b-2f9e-4c69-939d-5b996b73681f"
required
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
Any of
[ 1 .. 128 ] characters
string (APP_INSTANCE_ID) [ 1 .. 128 ] characters
type
required
string (ContactType)
Enum: "SMS" "VOICE" "PUSH" "EMAIL"
Example: "PUSH"
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

active
required
boolean (Active)

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

valid
required
boolean (Valid)

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

canEdit
required
boolean (CanEdit)

User can edit this entity

canRemove
required
boolean (CanEdit)

User can edit this entity

created
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

label
string or null (ContactLabel) [ 1 .. 64 ] characters
Example: "My iPhone"
settingsCount
number
Example: "5"

Current settings under this contact and service

Response samples

Content type
application/json
[
  • {
    • "id": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "target": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "label": "My iPhone",
    • "type": "PUSH",
    • "owner": {
      • "userLogin": "tomas.janda@jablotron.cz",
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
      },
    • "active": true,
    • "valid": true,
    • "settingsCount": 5,
    • "canEdit": true,
    • "canRemove": true,
    • "created": "2019-08-24T14:15:22Z"
    }
]

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 Schema: application/json
Array (>= 0 items)
id
required
string (NotificationSettingId) ^(?:SECURITY_SYSTEM|HOME_AUTOMATION)-[0-9(a-f...
Example: "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f"
required
object (NotificationContactBase)
id
required
string <uuid> (UuidString)
Example: "296ffe8b-2f9e-4c69-939d-5b996b73681f"
required
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
Any of
[ 1 .. 128 ] characters
string (APP_INSTANCE_ID) [ 1 .. 128 ] characters
label
string or null (ContactLabel) [ 1 .. 64 ] characters
Example: "My iPhone"
category
required
string (schemas-NotificationCategory) ^[A-Z\.\_]{1,}[A-Z]$
Example: "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED"

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" … 15 more
canEdit
required
boolean (CanEdit)

User can edit this entity

canRemove
required
boolean (CanEdit)

User can edit this entity

role
required
string (NotificationSettingRole)
Enum: "END_USER" "INSTALLER"
Example: "END_USER"
required
OBJECT_ENTITY (string) or SERVICE_ENTITY (string)
One of
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
object (NotificationComponentBase)
required
SECTION (string) or ACTOR (string) or COMPONENT (string) (NotificationSettingComponent)
One of
string (SECTION) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

TEMPERATURE_SETTING (object) or CONSUMPTION_SETTING (object)
One of
$type
required
string
Value: "TEMPERATURE"
temperature
required
number <float> (Temperature)
Example: "-13.5"

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

hysteresis
number <float> (Temperature)
Example: "-13.5"

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

object
from
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
to
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
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

created
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Response samples

Content type
application/json
[
  • {
    • "id": "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "contact": {
      • "id": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
      • "target": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
      • "label": "My iPhone"
      },
    • "category": "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED",
    • "languageCode": "CS",
    • "component": {
      • "id": "SECTION_<OBJECT_JA100F:242566>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        }
      },
    • "settings": {
      • "$type": "TEMPERATURE",
      • "temperature": -13.5,
      • "hysteresis": -13.5
      },
    • "validity": {
      • "from": "20:15",
      • "to": "20:15"
      },
    • "isCritical": true,
    • "soundCategory": "ALARM",
    • "canEdit": true,
    • "canRemove": true,
    • "created": "2019-08-24T14:15:22Z",
    • "role": "END_USER",
    • "sourceId": "OBJECT_JA100F:242566"
    }
]

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
Array (non-empty)
paramTypeId
required
string (ParameterType)
Value: "CLOUD-ENTITY-ID"
values
required
Array of strings non-empty [ items non-empty ]
Example: ["OBJECT_JA100F:54421"]

Responses

Response Schema: application/json
Array (>= 0 items)
entityId
required
string (EntityId)
Value: "SECURITY-SYSTEM-CONFIGURATION-TOOL"
operationId
required
string (OperationId)
Enum: "END-USER-VIEW" "INSTALLER-VIEW"
Array of objects non-empty
Array (non-empty)
paramTypeId
required
string (ParameterType)
Value: "CLOUD-ENTITY-ID"
values
required
Array of strings non-empty [ items non-empty ]
Example: ["OBJECT_JA100F:54421"]
Array of objects non-empty unique
Array (non-empty)
key
string
Enum: "DISTRIBUTOR_ENTITY_ID" "INSTALLER_COMPANY_ID"
string or boolean or string or number
One of
string

Request samples

Content type
application/json
[
  • {
    • "entityId": "SECURITY-SYSTEM-CONFIGURATION-TOOL",
    • "operationId": "END-USER-VIEW",
    • "parameters": [
      • {
        • "paramTypeId": "CLOUD-ENTITY-ID",
        • "values": [
          • "OBJECT_JA100F:54421"
          ]
        }
      ]
    }
]

Response samples

Content type
application/json
[
  • {
    • "entityId": "SECURITY-SYSTEM-CONFIGURATION-TOOL",
    • "operationId": "END-USER-VIEW",
    • "parameters": [
      • {
        • "paramTypeId": "CLOUD-ENTITY-ID",
        • "values": [
          • "OBJECT_JA100F:54421"
          ]
        }
      ],
    • "meta": [
      • {
        • "key": "DISTRIBUTOR_ENTITY_ID",
        • "value": "string"
        }
      ]
    }
]

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" … 4 more
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" … 3 more
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 Schema: application/json
required
Array of objects (ProcessManagerRequestLists)
Array
cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

object
requestId
required
integer <int64> (DbId) >= 1
Example: "242566"
state
required
string (ProcessState)
Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
type
required
string (ProcessType)
Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" … 4 more

CONFIGURATION is deprecated, use CONFIGURATION_DOWNLOAD instead

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

objectId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
parentRequestId
integer <int64> (DbId) >= 1
Example: "242566"
scheduledAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

completedAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

success
boolean
Default: true

Only available for completed status

appAccount
string non-empty
Example: "api.rpc"
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

remainingAttempts
integer >= 0

Returns only for unfinished requests and tells how many attempts (including the currently running one) remain.

object

Only available for non-success status

code
required
string (ProcessErrorType)
Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" … 3 more
debugMessage
string non-empty
Example: "Cannot connect to device via YTUN"
details
object or array
Example: [{"test":"best"}]

Log detail in JSON, can be JSON object or array of JSON objects

Array of objects non-empty
Array (non-empty)
name
required
string non-empty
Example: "WithArcNumberRelease"
value
string non-empty
Example: "1"
required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "requestId": 242566,
        • "parentRequestId": 242566,
        • "state": "CREATED",
        • "type": "SETTING",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "scheduledAt": "2019-08-24T14:15:22Z",
        • "completedAt": "2019-08-24T14:15:22Z",
        • "success": true,
        • "appAccount": "api.rpc",
        • "user": {
          • "userLogin": "tomas.janda@jablotron.cz",
          • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
          },
        • "remainingAttempts": 0,
        • "objectId": "OBJECT_JA100F:242566",
        • "error": {
          • "code": "CANCELED_BY_OTHER_PROCESS",
          • "debugMessage": "Cannot connect to device via YTUN"
          },
        • "details": [
          • {
            • "test": "best"
            }
          ],
        • "params": [
          • {
            • "name": "WithArcNumberRelease",
            • "value": "1"
            }
          ]
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

Register user account

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

User account registration params

loginName
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

invokedUserId
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

ARC List

Authorizations:
KongResolverOAuthJCS
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 Schema: application/json
Array (>= 0 items)
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

hasDefaultTemplate
boolean
Default: false

Indicates whether the DIRECT ARC has a default template set

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

Available only for CLOUD ARC

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

Available only for CLOUD ARC

photoVerificationUrlBase
string <uri>
Example: "https://arc-verification.jablotron.cloud/12541/akdsjfhkjs/:objectNumber"
object
required
object (ApiConnection)

Available only for CLOUD ARC, DIRECT ARC has always NONE

mode
required
string
Enum: "API" "JA_ARC" "NONE"
distributorsCount
integer <int32> (Counter) >= 0
Example: "6"
usersCount
integer <int32> (Counter) >= 0
Example: "6"

Response samples

Content type
application/json
[]

Get list of distributors

Authorizations:
KongResolverOAuthJCS

Responses

Response Schema: application/json
Array (non-empty)
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

required
object (DistributorSettings)
directArcEnabled
required
boolean
objectTransferEnabled
required
boolean
maintainedByJablonet
required
boolean
simLockEnabled
required
boolean
affiliateRegistered
required
boolean
required
object
arcsCount
required
integer <int32> (Counter) >= 0
Example: "6"
usersCount
required
integer <int32> (Counter) >= 0
Example: "6"
preparedForApi
required
boolean
rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

helpdeskLogin
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

description
string (Description) [ 1 .. 255 ] characters
Example: "Common description of entity up to 255 characters"
object (ApiSettings)
authorizationKey
required
string (AuthorizationKey) = 32 characters
Example: "b0d2f6a2d76a354d3a37f64b8ad08019"
pairedSoftwareKey
string >= 5 characters
Example: "221B368D7F5F597867F525971F28FF75"
isJaArc
boolean
object (DistributorCompanyInfo)
COMPANY_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

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": {
      • "directArcEnabled": true,
      • "objectTransferEnabled": true,
      • "maintainedByJablonet": true,
      • "simLockEnabled": true,
      • "affiliateRegistered": true
      },
    • "api": {
      • "authorizationKey": "b0d2f6a2d76a354d3a37f64b8ad08019",
      • "pairedSoftwareKey": "221B368D7F5F597867F525971F28FF75",
      • "isJaArc": true
      },
    • "contacts": {
      • "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"
      },
    • "meta": {
      • "arcsCount": 6,
      • "usersCount": 6,
      • "preparedForApi": true
      }
    }
]

Create object manager request

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"
invokedUserId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

Responses

Response Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

Request samples

Content type
application/json
Example
{
  • "$type": "RECONFIGURATION",
  • "invokedUserId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
}

Response samples

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

Register Dial controller and create CLOUD account (deprecated path) Deprecated

Deprecated endpoint path kept for backward compatibility. Please use /api/{v1}/devices/dial-controller/register.

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Registration params

ownerLoginName
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

required
DEVICE_IDENTITY (string) or REGISTRATION_KEY (string)
One of
string (DEVICE_IDENTITY) ^DEVICE_((JACLOUDSN:[A-F\d]{8})|(JASNV1:[\d]{...
serviceName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

Responses

Response Schema: application/json
serviceEntityId
required
string (ServiceEntityId) ^SERVICE_(\w+):([\d]+)$
Example: "SERVICE_JA100F:242566"
objectEntityId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"

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"
}

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 Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

state
required
string (ProcessState)
Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
type
required
string (ProcessType)
Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" … 4 more

CONFIGURATION is deprecated, use CONFIGURATION_DOWNLOAD instead

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

scheduledAt
string <date-time> (DateTime)

Only available for CREATED status

completedAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

success
boolean
Default: true

Only available for completed status

object

Only available for non-success status

code
required
string (ProcessErrorType)
Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" … 3 more
debugMessage
string non-empty
Example: "Cannot connect to device via YTUN"
object non-empty
userName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originUserName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originRequestId
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

remainingAttempts
integer >= 0

Returns only for unfinished requests and tells how many attempts (including the currently running one) remain.

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": {
    • "code": "CANCELED_BY_OTHER_PROCESS",
    • "debugMessage": "Cannot connect to device via YTUN"
    },
  • "meta": {
    • "userName": "tomas.janda@jablotron.cz",
    • "originUserName": "tomas.janda@jablotron.cz",
    • "originRequestId": "DCD-1254445521",
    • "remainingAttempts": 0
    }
}

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" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
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 Schema: application/json
required
Array of objects >= 0 items unique
Array (>= 0 items)
required
object (MaintenanceReportNodeBase)
objectId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
timeZone
required
string
Default: "UTC"
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" … 409 more
Example: "Europe/Prague"

IANA timezone definition

name
required
string [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

required
object
registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
required
SERIAL_NUMBER_HEX (string) or SERIAL_NUMBER_DEC (string)
One of
string (SERIAL_NUMBER_HEX) ^[A-F\d]{8}
family
required
string (DeviceFamily)
Enum: "ATHOS" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 13 more
Example: "JA100F"
model
required
string (DeviceModel)
Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: "JA107K"
officialName
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"
phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

configurationDownloadDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

configurationSetDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

required
object
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
object
installerCompanyId
required
number (IntId) >= 1

Common Int id

name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
object
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
arcObjectNumber
string^[\dA-F]{4,8}$
Example: "F13D"
cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "objectId": "OBJECT_JA100F:242566",
        • "timeZone": "Europe/Prague",
        • "name": "My House",
        • "installer": {
          • "installerCompanyId": 1,
          • "name": "Company s.r.o."
          },
        • "distributor": {
          • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
          • "name": "Company s.r.o."
          },
        • "arc": {
          • "arcId": "ARC_CLOUD:00008808",
          • "name": "Company s.r.o."
          },
        • "arcObjectNumber": "F13D",
        • "device": {
          • "registrationKey": "LAS6D-U2VBG-UHX65",
          • "serialNumber": "F9301214",
          • "phoneNumber": "+420739259931",
          • "family": "JA100F",
          • "model": "JA107K",
          • "officialName": "JA-101K LAN 3G",
          • "configurationDownloadDate": "2019-08-24T14:15:22Z",
          • "configurationSetDate": "2019-08-24T14:15:22Z"
          }
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

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" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
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 Schema: application/json
required
Array of objects >= 0 items unique
Array (>= 0 items)
required
object (MaintenanceReportNodeBase)
objectId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
timeZone
required
string
Default: "UTC"
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" … 409 more
Example: "Europe/Prague"

IANA timezone definition

name
required
string [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

required
object
registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
required
SERIAL_NUMBER_HEX (string) or SERIAL_NUMBER_DEC (string)
One of
string (SERIAL_NUMBER_HEX) ^[A-F\d]{8}
family
required
string (DeviceFamily)
Enum: "ATHOS" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 13 more
Example: "JA100F"
model
required
string (DeviceModel)
Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: "JA107K"
officialName
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"
phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

configurationDownloadDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

configurationSetDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

required
object
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
required
object
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
arcObjectNumber
required
string^[\dA-F]{4,8}$
Example: "F13D"
object
installerCompanyId
required
number (IntId) >= 1

Common Int id

name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "objectId": "OBJECT_JA100F:242566",
        • "timeZone": "Europe/Prague",
        • "name": "My House",
        • "installer": {
          • "installerCompanyId": 1,
          • "name": "Company s.r.o."
          },
        • "distributor": {
          • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
          • "name": "Company s.r.o."
          },
        • "arc": {
          • "arcId": "ARC_CLOUD:00008808",
          • "name": "Company s.r.o."
          },
        • "arcObjectNumber": "F13D",
        • "device": {
          • "registrationKey": "LAS6D-U2VBG-UHX65",
          • "serialNumber": "F9301214",
          • "phoneNumber": "+420739259931",
          • "family": "JA100F",
          • "model": "JA107K",
          • "officialName": "JA-101K LAN 3G",
          • "configurationDownloadDate": "2019-08-24T14:15:22Z",
          • "configurationSetDate": "2019-08-24T14:15:22Z"
          }
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

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" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
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 Schema: application/json
required
Array of objects >= 0 items unique
Array (>= 0 items)
required
object (MaintenanceReportNodeBase)
objectId
required
string (OBJECT_ENTITY) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
timeZone
required
string
Default: "UTC"
Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" … 409 more
Example: "Europe/Prague"

IANA timezone definition

name
required
string [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

required
object
registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
required
SERIAL_NUMBER_HEX (string) or SERIAL_NUMBER_DEC (string)
One of
string (SERIAL_NUMBER_HEX) ^[A-F\d]{8}
family
required
string (DeviceFamily)
Enum: "ATHOS" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 13 more
Example: "JA100F"
model
required
string (DeviceModel)
Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: "JA107K"
officialName
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"
phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

configurationDownloadDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

configurationSetDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

required
object
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
required
object
installerCompanyId
required
number (IntId) >= 1

Common Int id

name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
object
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
arcObjectNumber
string^[\dA-F]{4,8}$
Example: "F13D"
cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "objectId": "OBJECT_JA100F:242566",
        • "timeZone": "Europe/Prague",
        • "name": "My House",
        • "installer": {
          • "installerCompanyId": 1,
          • "name": "Company s.r.o."
          },
        • "distributor": {
          • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
          • "name": "Company s.r.o."
          },
        • "arc": {
          • "arcId": "ARC_CLOUD:00008808",
          • "name": "Company s.r.o."
          },
        • "arcObjectNumber": "F13D",
        • "device": {
          • "registrationKey": "LAS6D-U2VBG-UHX65",
          • "serialNumber": "F9301214",
          • "phoneNumber": "+420739259931",
          • "family": "JA100F",
          • "model": "JA107K",
          • "officialName": "JA-101K LAN 3G",
          • "configurationDownloadDate": "2019-08-24T14:15:22Z",
          • "configurationSetDate": "2019-08-24T14:15:22Z"
          }
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

Change Installer company owner

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

Id of installerCompany

Request Body schema: application/json

Company information

invokedUserId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

keepCurrentOwnerInCompany
required
boolean
Default: true

If true, current owner will be kept in the company with role INSTALLER

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
non-empty
object non-empty
registrationKey
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
serialNumber
string (SerialNumber) ^[A-F\d]{8}
Example: "F9301214"
firmware
string non-empty
Example: "MD6112.05.1"

Current firmware in device

hardware
string non-empty
Example: "MD6112.05.1"

Current hardware version in device

object non-empty
imsi
string^\d{14,15}$
Example: "230015123456789"
imei
string^\d{15}$
Example: "490154203237518"
operator
string non-empty
Example: "Vodafone CZ"
rssi
integer [ 0 .. 100 ]
Example: "95"
spn
string non-empty
Example: "JABLOTRON SDC"

Response samples

Content type
application/json
{
  • "centralUnit": {
    • "registrationKey": "LAS6D-U2VBG-UHX65",
    • "serialNumber": "F9301214",
    • "firmware": "MD6112.05.1",
    • "hardware": "MD6112.05.1"
    },
  • "gsm": {
    • "imsi": "230015123456789",
    • "imei": "490154203237518",
    • "operator": "Vodafone CZ",
    • "rssi": 95,
    • "spn": "JABLOTRON SDC"
    }
}

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 Schema: application/json
Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

status
required
string (SectionStatusType)
Enum: "DISARMED" "ARMED_PARTIALLY" "ARMED_FULL" "MAINTENANCE" "SERVICE" "UNKNOWN"

Current state of section

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
statusDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

partialArmEnabled
boolean (PartialArmEnabled)

Section has enabled partially arm

Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

status
required
string (ActorStatusType)
Enum: "ON" "OFF" "UNKNOWN"

Current state of actor

controllable
required
boolean
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
statusDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

reaction
string (ActorReactionType)
Enum: "PULSE" "SWITCH" "COPY" "COPY_AFTER_TIME" "PULSE_EXTENDED" "INVERT" "ACTOR_DISABLED"
interval
string (DateInterval) ^-?P[\dYMDTHS]+$
Example: "-P1DT10M"

Date time interval format

Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
arcConnectionStatus
string
Default: "NONE"
Enum: "NONE" "REQUESTED" "CONNECTED"

One of connection state: REQUESTED => user has sent request to ARC, but ARC not yet accepted. CONNECTED => camera is connected to ARC

object (LastPictureModel)
Deprecated
url
required
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

occurredAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

macAddress
string (MacAddress) ^[\da-z]{2}:[\da-z]{2}:[\da-z]{2}:[\da-z]{2}:...
Example: "54:c4:15:8c:56:df"
Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

streamUrl
required
string
Example: "rtsp://wowzaec2demo.streamlock.net/vod/mp4:BigBuckBunny_115k.mp4"
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
object (LastPictureModel)
url
required
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

occurredAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
currentTemperature
number <float> (Temperature)
Example: "-13.5"

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

currentTemperatureTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

heatingState
string (HeatingState)
Enum: "NOT_CONFIGURED" "HEATING" "BLOCKED" "STANDBY"

Current status of heating status

object (ThermometerExtendedSettings)
minimumTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

maximumTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

triggerTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

Array of THERMOSTAT_V2 (object) or THERMOSTAT (object) non-empty unique
Array (non-empty)
One of
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

$type
required
string
Value: "THERMOSTAT_V2"
floorThermometerEnabled
required
boolean
Default: false
required
object (ThermostatBaseSettings)
minimumTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

maximumTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

economyTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

comfortTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

standbyTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

required
object (ThermostatV2Meta)
measurables
required
Array of strings (Measurable) non-empty unique
Items Enum: "TEMPERATURE" "FLOOR_TEMPERATURE" "HUMIDITY" "CO2_CONCENTRATION"
Example: [["TEMPERATURE","CO2_CONCENTRATION"]]
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
currentTemperature
number <float> (Temperature)
Example: "-13.5"

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

currentTemperatureTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object (ThermostatV2Mode)
temperature
required
number <float> (Temperature)
Example: "-13.5"

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

lastChange
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

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

Current thermostat mode

calendarMode
string (CalendarMode)
Enum: "ECONOMIC" "COMFORT" "ECONOMIC_FORCED"

ECONOMIC_FORCED - switched forced to economic - section is armed

currentTemperatureFloor
number <float> (Temperature)
Example: "-13.5"

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

currentTemperatureFloorTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

currentHumidity
integer (Percent) [ 0 .. 100 ]

Value in percent without decimal

currentHumidityTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

currentCo2Concentration
integer (PartsPerMillion) >= 0

Integer value >= 0

currentCo2ConcentrationTime
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

actorState
string (ThermostatActorState)
Enum: "NOT_CONFIGURED" "ACTIVE" "BLOCKED" "STANDBY"

Current status of actor

ventilationState
string (ThermostatActorState)
Enum: "NOT_CONFIGURED" "ACTIVE" "BLOCKED" "STANDBY"

Current status of actor

thermostatMode
string (OperationalMode)
Enum: "HEATING" "COOLING"

Current thermostat mode

Array of objects (BasicComponentModelWithPermissions) non-empty unique
Array (non-empty)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

isConfigured
required
boolean
manualConsumptionAlignment
required
boolean
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (Permissions) non-empty
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentShare
boolean (BoolVal)
photoRead
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
componentControl
boolean (BoolVal)
componentConfigure
boolean (BoolVal)
notificationModify
boolean (BoolVal)
gpsPositionRead
boolean (BoolVal)
gpsHistoryRead
boolean (BoolVal)
cameraStreamRead
boolean (BoolVal)
cameraRecordRead
boolean (BoolVal)
videoClipRead
boolean (BoolVal)
videoClipModify
boolean (BoolVal)
jaPayRead
boolean (BoolVal)
jaPayModify
boolean (BoolVal)
object
required
object (PulseMeterUserSettingsWithMode)
unit
required
string (PulseMeterUnits)
Enum: "KWH" "L" "PCS" "M3" "PULSES"

Units of consumption

displayMode
required
string (PulseMeterDisplayMode)
Enum: "SINGLE" "DUAL"
currency
string (Currency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" … 155 more

Allowed CLOUD currencies

totalConsumption
required
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

lastMeasureDate
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

totalConsumptionLo
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

totalConsumptionHi
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

totalCost
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

totalCostLo
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

totalCostHi
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

currentMonthConsumption
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

currentMonthConsumptionLo
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

currentMonthConsumptionHi
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

currentMonthCost
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

currentMonthCostLo
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

currentMonthCostHi
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

todayConsumptionLo
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

todayConsumptionHi
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

todayConsumption
number <float> (Consumption)
Example: "15.2365"

Consumption value, can be negative!

todayCostLo
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

todayCostHi
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

todayCost
number <float> (Price)
Example: "1.52"

How much cost something, can be negative!

Response samples

Content type
application/json
{
  • "sections": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "status": "DISARMED",
      • "statusDate": "2019-08-24T14:15:22Z",
      • "partialArmEnabled": true
      }
    ],
  • "actors": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "status": "ON",
      • "statusDate": "2019-08-24T14:15:22Z",
      • "reaction": "PULSE",
      • "interval": "-P1DT10M",
      • "controllable": true
      }
    ],
  • "cameras": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "arcConnectionStatus": "NONE",
      • "lastPicture": {},
      • "macAddress": "54:c4:15:8c:56:df"
      }
    ],
  • "customCameras": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "streamUrl": "rtsp://wowzaec2demo.streamlock.net/vod/mp4:BigBuckBunny_115k.mp4"
      }
    ],
  • "cameraDetectors": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "lastPicture": {}
      }
    ],
  • "thermometers": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "currentTemperature": -13.5,
      • "currentTemperatureTime": "2019-08-24T14:15:22Z",
      • "heatingState": "NOT_CONFIGURED",
      • "settings": {
        • "minimumTemperature": -13.5,
        • "maximumTemperature": -13.5,
        • "triggerTemperature": -13.5
        }
      }
    ],
  • "thermostats": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "currentTemperature": -13.5,
      • "currentTemperatureTime": "2019-08-24T14:15:22Z",
      • "currentMode": {
        • "calendarMode": "ECONOMIC",
        • "mode": "MANUAL",
        • "temperature": -13.5,
        • "lastChange": "2019-08-24T14:15:22Z"
        },
      • "currentTemperatureFloor": -13.5,
      • "currentTemperatureFloorTime": "2019-08-24T14:15:22Z",
      • "currentHumidity": 100,
      • "currentHumidityTime": "2019-08-24T14:15:22Z",
      • "currentCo2Concentration": 0,
      • "currentCo2ConcentrationTime": "2019-08-24T14:15:22Z",
      • "actorState": "NOT_CONFIGURED",
      • "ventilationState": "NOT_CONFIGURED",
      • "thermostatMode": "HEATING",
      • "floorThermometerEnabled": false,
      • "settings": {
        • "minimumTemperature": -13.5,
        • "maximumTemperature": -13.5,
        • "economyTemperature": -13.5,
        • "comfortTemperature": -13.5,
        • "standbyTemperature": -13.5
        },
      • "meta": {
        • "measurables": [
          • [
            • "TEMPERATURE",
            • "CO2_CONCENTRATION"
            ]
          ]
        },
      • "$type": "THERMOSTAT_V2"
      }
    ],
  • "pulseMeters": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "permissions": {
        • "stateView": false,
        • "historyRead": false,
        • "componentShare": false,
        • "photoRead": false,
        • "componentNameModify": false,
        • "componentControl": false,
        • "componentConfigure": false,
        • "notificationModify": false,
        • "gpsPositionRead": false,
        • "gpsHistoryRead": false,
        • "cameraStreamRead": false,
        • "cameraRecordRead": false,
        • "videoClipRead": false,
        • "videoClipModify": false,
        • "jaPayRead": false,
        • "jaPayModify": false
        },
      • "isConfigured": true,
      • "manualConsumptionAlignment": true,
      • "summary": {
        • "lastMeasureDate": "2019-08-24T14:15:22Z",
        • "totalConsumption": 15.2365,
        • "totalConsumptionLo": 15.2365,
        • "totalConsumptionHi": 15.2365,
        • "totalCost": 1.52,
        • "totalCostLo": 1.52,
        • "totalCostHi": 1.52,
        • "currentMonthConsumption": 15.2365,
        • "currentMonthConsumptionLo": 15.2365,
        • "currentMonthConsumptionHi": 15.2365,
        • "currentMonthCost": 1.52,
        • "currentMonthCostLo": 1.52,
        • "currentMonthCostHi": 1.52,
        • "todayConsumptionLo": 15.2365,
        • "todayConsumptionHi": 15.2365,
        • "todayConsumption": 15.2365,
        • "todayCostLo": 1.52,
        • "todayCostHi": 1.52,
        • "todayCost": 1.52,
        • "meta": {
          • "unit": "KWH",
          • "currency": "AED",
          • "displayMode": "SINGLE"
          }
        }
      }
    ]
}

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 Schema: application/json
required
object
serviceMode
boolean (BoolVal)
maintenance
boolean (BoolVal)
ALARM_DETAILS (object) or BoolVal (boolean)
One of
non-empty
intrusion
boolean (BoolVal)
fire
boolean (BoolVal)
flood
boolean (BoolVal)
gas
boolean (BoolVal)
panic
boolean (BoolVal)
sabotage
boolean (BoolVal)
health
boolean (BoolVal)
overCode
boolean (BoolVal)
trouble
boolean (BoolVal)
Array of SECURITY_SYSTEM_SECTION (object) or ACTOR (object)
Array
One of
$type
string
Value: "SECURITY_SYSTEM_SECTION"
state
string
Enum: "ARMED" "ARMED_PARTIAL" "DISARMED" "MAINTENANCE" "SERVICE"
count
number [ 0 .. 16 ]

Response samples

Content type
application/json
{
  • "global": {
    • "serviceMode": false,
    • "maintenance": false,
    • "alarm": {
      • "intrusion": false,
      • "fire": false,
      • "flood": false,
      • "gas": false,
      • "panic": false,
      • "sabotage": false,
      • "health": false,
      • "overCode": false
      },
    • "trouble": false
    },
  • "components": [
    • {
      • "$type": "SECURITY_SYSTEM_SECTION",
      • "state": "ARMED",
      • "count": 16
      }
    ]
}

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 Schema: application/json
non-empty
Array of objects non-empty
Array (non-empty)
occurredAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

type
required
string (TroubleTypes)
Enum: "FAULT" "SABOTAGE" "BATTERY_LOW" "ACCUMULATOR_LOW" "PERIPHERAL_LOST" "POWER_DISCONNECTED" "CLOUD_CONNECTION_ERROR" "ARC_CONNECTION_ERROR" "MAIN_CHANNEL_CONNECTION_ERROR"

Type of active fault, must also support a value outside this list (feature request) and translate to default FAULT

object (ComponentModel)
DEVICE_COMPONENT (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (ComponentModel)
DEVICE_COMPONENT (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

Array of objects non-empty
Array (non-empty)
occurredAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

type
required
string (AlarmType)
Enum: "INTRUSION" "FIRE" "FLOOD" "GAS" "PANIC" "SABOTAGE" "HEALTH" "OVER_CODE"

Type of alarm

object (ComponentModel)
DEVICE_COMPONENT (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (ComponentModel)
DEVICE_COMPONENT (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

Array of objects (StateDetail) non-empty unique
Array (non-empty)
occurredAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object (ComponentModel)
DEVICE_COMPONENT (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (ComponentModel)
DEVICE_COMPONENT (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (StateDetail)
occurredAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object (ComponentModel)
DEVICE_COMPONENT (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

object (ComponentModel)
DEVICE_COMPONENT (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

Response samples

Content type
application/json
{
  • "troubles": [
    • {
      • "occurredAt": "2019-08-24T14:15:22Z",
      • "subject": {
        • "id": "SECTION_<OBJECT_JA100F:12345>:1",
        • "name": "PIR Bedroom",
        • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
        • "defaultNameTVar": {
          • "entityId": "5"
          }
        },
      • "invoker": {
        • "id": "SECTION_<OBJECT_JA100F:12345>:1",
        • "name": "PIR Bedroom",
        • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
        • "defaultNameTVar": {
          • "entityId": "5"
          }
        },
      • "type": "FAULT"
      }
    ],
  • "alarms": [
    • {
      • "occurredAt": "2019-08-24T14:15:22Z",
      • "subject": {
        • "id": "SECTION_<OBJECT_JA100F:12345>:1",
        • "name": "PIR Bedroom",
        • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
        • "defaultNameTVar": {
          • "entityId": "5"
          }
        },
      • "invoker": {
        • "id": "SECTION_<OBJECT_JA100F:12345>:1",
        • "name": "PIR Bedroom",
        • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
        • "defaultNameTVar": {
          • "entityId": "5"
          }
        },
      • "type": "INTRUSION"
      }
    ],
  • "maintenances": [
    • {
      • "occurredAt": "2019-08-24T14:15:22Z",
      • "subject": {
        • "id": "SECTION_<OBJECT_JA100F:12345>:1",
        • "name": "PIR Bedroom",
        • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
        • "defaultNameTVar": {
          • "entityId": "5"
          }
        },
      • "invoker": {
        • "id": "SECTION_<OBJECT_JA100F:12345>:1",
        • "name": "PIR Bedroom",
        • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
        • "defaultNameTVar": {
          • "entityId": "5"
          }
        }
      }
    ],
  • "service": {
    • "occurredAt": "2019-08-24T14:15:22Z",
    • "subject": {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        }
      },
    • "invoker": {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        }
      }
    }
}

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

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

Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
action
required
string (SectionControlCommands)
Enum: "ARM" "PARTIAL_ARM" "ARM_FORCE" "PARTIAL_ARM_FORCE" "DISARM"
Array of objects (Authorizations) [ 1 .. 2 ] items unique

Authorization data for control to identify the user on the device

Array ([ 1 .. 2 ] items)
type
required
string
Default: "CODE"
Enum: "CODE" "RFID"

Type of authorization value

required
JA100_CODE (string) or DIAL_CONTROLLER_CODE (string) or SERIAL_NUMBER_DEC (string)
Example: "2*1234"

For type CODE:

  • JA100+ - user code with or without prefix (20*1254, 1234, 1*12345678)
  • GD04K - UTF-8 string up to 30 bytes (Příliš žluťoučký kůň)

For type RFID

  • JA100+ serial number (1400-40-0000-0001)
Any of
string (JA100_CODE) ^([\d]{1,3}\*)?([\d]{4}|[\d]{6}|[\d]{8})$

For type CODE:

  • JA100+ - user code with or without prefix (20*1254, 1234, 1*12345678)
  • GD04K - UTF-8 string up to 30 bytes (Příliš žluťoučký kůň)

For type RFID

  • JA100+ serial number (1400-40-0000-0001)

Responses

Response Schema: application/json
required
Array of SECTION_CONTROL_STATUS (object) or ACTOR_CONTROL_STATUS (object) or PERIPHERAL_CONTROL_STATUS (object) or PICTURE_CONTROL_STATUS (object) or DEVICE_CONFIGURATION_STATUS (object) or DEVICE_STATUS (object) or DEVICE_EVENTS (object) or DEVICE_RESET (object) or CHECK_AUTHORIZATION (object) (ComponentControlResponseStatus) non-empty unique
Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
status
required
string (ControlResponseStatuses)
Enum: "SUCCESS" "NO_CHANGE" "NO_ACCESS" "NOT_READY_TO_ARM" "CAN_NOT_BE_CONTROLLED" "BLOCKED" "PARTIAL_ARM_NOT_ALLOWED" "INVALID_SECTION_STATE_FOR_ACTION" "UNKNOWN"
object
$type
required
string
Value: "BLOCKING_COMPONENTS"
bypassable
required
boolean
Default: false
required
Array of COMPONENT (string) or COMMUNICATOR (string) non-empty unique
Array (non-empty)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
clientTimerSeconds
integer [ 1 .. 60 ]
Default: 8

If returned, client is allowed to force ARM/PARTIAL_ARM after this time

object (Meta) non-empty
firmware
string
Example: "MD6112.05.1"

Current firmware in device

behavior
integer >= 0
Example: "55"

Behavior version of device

registrationKey
string
Example: "L2ASM-ZSVD3-UULS8"

Current registration key of device

Array of SECTION_STATE (object) or ACTOR_STATE (object) or COMPONENT_STATE (object) (ControlResponseStates) non-empty unique
Array (non-empty)
One of
componentId
required
string (SectionEntityId) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "SECTION_<OBJECT_JA100F:242566>:1"
state
required
string (SectionStates)
Enum: "ARM" "PARTIAL_ARM" "DISARM" "MAINTENANCE" "SERVICE" "BLOCK" "OFF" "UNKNOWN"
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

hasActiveAlarms
boolean
canBeControlled
boolean

Request samples

Content type
application/json
{
  • "authorizations": [
    • {
      • "type": "CODE",
      • "value": "2*1234"
      }
    ],
  • "controls": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "action": "ARM"
      }
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    • "firmware": "MD6112.05.1",
    • "behavior": 55,
    • "registrationKey": "L2ASM-ZSVD3-UULS8"
    },
  • "controls": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "status": "SUCCESS",
      • "details": {
        • "$type": "BLOCKING_COMPONENTS",
        • "bypassable": false,
        • "clientTimerSeconds": 8,
        • "components": [
          • "COMPONENT_<OBJECT_JA100F:242566>:25"
          ]
        }
      }
    ],
  • "states": [
    • {
      • "componentId": "SECTION_<OBJECT_JA100F:242566>:1",
      • "state": "ARM",
      • "name": "PIR Bedroom",
      • "hasActiveAlarms": true,
      • "canBeControlled": true
      }
    ]
}

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 Schema: application/json
name
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

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

Access level of installer company

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

Object history expiration, default is NONE - Lifetime

objectRegistrationDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

voiceNotificationPrefix
string (VoiceNotificationPrefix) [ 1 .. 50 ] characters
Example: "My house"
object
family
required
string (DeviceFamily)
Enum: "ATHOS" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 13 more
Example: "JA100F"
model
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"
registrationKey
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

object
date
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

version
required
string
Example: "MD6112.07.1.2dbg"
object
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
shareContactInformation
required
boolean
Default: false
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

logo
string <uri>

URL to installer company logo

object
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
email
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

logo
string <uri>

URL to installer company logo

object
timeZoneList
required
Array of strings (TimeZone) non-empty unique
Items Enum: "Africa/Abidjan" "Africa/Accra" "Africa/Addis_Ababa" "Africa/Algiers" "Africa/Asmara" "Africa/Bamako" "Africa/Bangui" "Africa/Banjul" "Africa/Bissau" "Africa/Blantyre" … 409 more
Example: ["Europe/Prague"]

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": {
    • "family": "JA100F",
    • "model": "JA-101K LAN 3G",
    • "registrationKey": "LAS6D-U2VBG-UHX65",
    • "phoneNumber": "+420739259931",
    • "firmware": {
      • "date": "2019-08-24T14:15:22Z",
      • "version": "MD6112.07.1.2dbg"
      }
    },
  • "installerCompany": {
    • "name": "Company s.r.o.",
    • "email": "tomas.janda@jablotron.cz",
    • "phoneNumber": "+420739259931",
    • "shareContactInformation": false,
    • "logo": "http://example.com"
    },
  • "distributor": {
    • "name": "Company s.r.o.",
    • "email": "tomas.janda@jablotron.cz",
    • "phoneNumber": "+420739259931",
    • "logo": "http://example.com"
    },
  • "meta": {
    • "timeZoneList": [
      • "Europe/Prague"
      ]
    }
}

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
Example: "My House"

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" … 409 more
Example: "Europe/Prague"

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

One of
[ 1 .. 50 ] characters
string (VoiceNotificationPrefix) [ 1 .. 50 ] characters

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
role
string (ServiceAccessRole)
Enum: "OWNER" "READ" "CONTROL" "SHARE" "CUSTOM"
object (ServiceGlobalPermissionViewAndModify)
modify
required
boolean
view
required
boolean
object (ServiceGlobalPermissionViewAndModify)
modify
required
boolean
view
required
boolean
object (ServiceGlobalPermissionViewAndModify)
modify
required
boolean
view
required
boolean
object (ServiceGlobalPermissionViewAndModify)
modify
required
boolean
view
required
boolean
object (ServiceGlobalPermissionView)
view
required
boolean
object (DeviceConfigurationPermissionView)
view
required
boolean
deviceConfigurationId
required
string >= 5 characters
Example: "DEVICE_CLOUDSN:F0500001"
object (ServiceGlobalPermissionViewAndModify)
modify
required
boolean
view
required
boolean

Response samples

Content type
application/json
{
  • "role": "OWNER",
  • "timeZone": {
    • "view": true,
    • "modify": true
    },
  • "historyExpiration": {
    • "view": true,
    • "modify": true
    },
  • "installerAccessLevel": {
    • "view": true,
    • "modify": true
    },
  • "voiceNotificationPrefix": {
    • "view": true,
    • "modify": true
    },
  • "installerCompany": {
    • "view": true
    },
  • "deviceConfiguration": {
    • "view": true,
    • "deviceConfigurationId": "DEVICE_CLOUDSN:F0500001"
    },
  • "jaPay": {
    • "view": true,
    • "modify": true
    }
}

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 Schema: application/json
required
object (SharingDetailMe)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

role
required
string (ServiceAccessRole)
Enum: "OWNER" "READ" "CONTROL" "SHARE" "CUSTOM"
canModifySharing
required
boolean

Information, if current user can share service to another user

required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

object

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

createdDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Array of objects (SharedAccountForList) non-empty

List of users with access to selected service and current user

Array (non-empty)
canModify
required
boolean

User can be edited by current user

canDelete
required
boolean

User can be deleted by current user

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

role
required
string (ServiceAccessRole)
Enum: "OWNER" "READ" "CONTROL" "SHARE" "CUSTOM"
object non-empty
Array of objects (AccessComponentBase) non-empty unique
Array (non-empty)
$type
required
string
Enum: "SECTION" "ACTOR" "THERMOMETER" "THERMOSTAT" "PULSE_METER" "CAMERA_PIR" "CAMERA"
required
COMPONENT (string) or SECTION (string) or ACTOR (string) or JABLOTRON_CAMERA (string)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

Array of objects (GlobalPermissionItem) non-empty unique
Array (non-empty)
$type
required
string
Enum: "JA_PAY_READ" "JA_PAY_MODIFY"

Response samples

Content type
application/json
{
  • "me": {
    • "userLogin": "tomas.janda@jablotron.cz",
    • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
    • "role": "OWNER",
    • "canModifySharing": true,
    • "owner": {
      • "userLogin": "tomas.janda@jablotron.cz",
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
      },
    • "sharingUser": {
      • "userLogin": "tomas.janda@jablotron.cz",
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
      • "createdDate": "2019-08-24T14:15:22Z"
      }
    },
  • "accesses": [
    • {
      • "userLogin": "tomas.janda@jablotron.cz",
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
      • "role": "OWNER",
      • "canModify": true,
      • "canDelete": true
      }
    ],
  • "serviceSharingPermissions": {
    • "components": [
      • {
        • "$type": "SECTION",
        • "id": "COMPONENT_<OBJECT_JA100F:242566>:25",
        • "name": "PIR Bedroom",
        • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
        • "defaultNameTVar": {
          • "entityId": "5"
          }
        }
      ],
    • "global": [
      • {
        • "$type": "JA_PAY_READ"
        }
      ]
    }
}

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

role
required
string (ServiceAccessRole)
Enum: "OWNER" "READ" "CONTROL" "SHARE" "CUSTOM"
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

Array of objects (UserComponentForSharing) non-empty
Array (non-empty)
required
COMPONENT (string) or SECTION (string) or ACTOR (string) or JABLOTRON_CAMERA (string)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
required
SECTION_PERMISSIONS (object) or ACTOR_PERMISSIONS (object) or THERMOMETER_PERMISSIONS (object) or THERMOSTAT_PERMISSIONS (object) or PULSE_METER_PERMISSIONS (object) or CAMERA_PIR_PERMISSIONS (object) or CAMERA_PERMISSIONS (object) (ComponentPermissionItem)
One of
non-empty
$type
required
string
Value: "SECTION_PERMISSIONS"
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentControl
boolean (BoolVal)
notificationModify
boolean (BoolVal)
componentShare
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
Array of objects (PermissionGroupGlobal) non-empty unique
Array (non-empty)
$type
required
string
Enum: "JA_PAY_READ" "JA_PAY_MODIFY"

Responses

Response Schema: application/json
userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

Request samples

Content type
application/json
{
  • "userLogin": "tomas.janda@jablotron.cz",
  • "role": "OWNER",
  • "components": [
    • {
      • "id": "COMPONENT_<OBJECT_JA100F:242566>:25",
      • "permissions": {
        • "$type": "SECTION_PERMISSIONS",
        • "stateView": false,
        • "historyRead": false,
        • "componentControl": false,
        • "notificationModify": false,
        • "componentShare": false,
        • "componentNameModify": false
        }
      }
    ],
  • "global": [
    • {
      • "$type": "JA_PAY_READ"
      }
    ]
}

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 Schema: application/json
Any of
non-empty
Array of objects (AccessComponentUserAccess) non-empty
Array (non-empty)
$type
required
string
Enum: "SECTION" "ACTOR" "THERMOMETER" "THERMOSTAT" "PULSE_METER" "CAMERA_PIR" "CAMERA"
required
COMPONENT (string) or SECTION (string) or ACTOR (string) or JABLOTRON_CAMERA (string)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

defaultNameTK
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

Array of objects non-empty
Array (non-empty)
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

required
SECTION_PERMISSIONS (object) or ACTOR_PERMISSIONS (object) or THERMOMETER_PERMISSIONS (object) or THERMOSTAT_PERMISSIONS (object) or PULSE_METER_PERMISSIONS (object) or CAMERA_PIR_PERMISSIONS (object) or CAMERA_PERMISSIONS (object) (ComponentPermissionItem)
One of
non-empty
$type
required
string
Value: "SECTION_PERMISSIONS"
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentControl
boolean (BoolVal)
notificationModify
boolean (BoolVal)
componentShare
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
Array of objects (GlobalPermissionWithAccess) non-empty unique
Array (non-empty)
$type
required
string
Enum: "JA_PAY_READ" "JA_PAY_MODIFY"
accesses
Array of strings (CLOUD_USER) non-empty unique [ items^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$ ]
Example: ["USER_<OEM_JABLOTRON:Jablotron>:52325"]

Response samples

Content type
application/json
Example
{
  • "components": [
    • {
      • "$type": "SECTION",
      • "id": "COMPONENT_<OBJECT_JA100F:242566>:25",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "accesses": [
        • {
          • "userLogin": "tomas.janda@jablotron.cz",
          • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
          • "permissions": {
            • "$type": "SECTION_PERMISSIONS",
            • "stateView": false,
            • "historyRead": false,
            • "componentControl": false,
            • "notificationModify": false,
            • "componentShare": false,
            • "componentNameModify": false
            }
          }
        ]
      }
    ],
  • "global": [
    • {
      • "$type": "JA_PAY_READ",
      • "accesses": [
        • "USER_<OEM_JABLOTRON:Jablotron>:52325"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 (non-empty)
required
COMPONENT (string) or SECTION (string) or ACTOR (string) or JABLOTRON_CAMERA (string)
One of
string (COMPONENT) ^COMPONENT_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
required
SECTION_PERMISSIONS (object) or ACTOR_PERMISSIONS (object) or THERMOMETER_PERMISSIONS (object) or THERMOSTAT_PERMISSIONS (object) or PULSE_METER_PERMISSIONS (object) or CAMERA_PIR_PERMISSIONS (object) or CAMERA_PERMISSIONS (object) (ComponentPermissionItem)
One of
non-empty
$type
required
string
Value: "SECTION_PERMISSIONS"
stateView
boolean (BoolVal)
historyRead
boolean (BoolVal)
componentControl
boolean (BoolVal)
notificationModify
boolean (BoolVal)
componentShare
boolean (BoolVal)
componentNameModify
boolean (BoolVal)
Array of objects
Array
$type
required
string
Enum: "JA_PAY_READ" "JA_PAY_MODIFY"
allowed
required
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "role": "OWNER",
  • "components": [
    • {
      • "id": "COMPONENT_<OBJECT_JA100F:242566>:25",
      • "permissions": {
        • "$type": "SECTION_PERMISSIONS",
        • "stateView": false,
        • "historyRead": false,
        • "componentControl": false,
        • "notificationModify": false,
        • "componentShare": false,
        • "componentNameModify": false
        }
      }
    ],
  • "global": [
    • {
      • "$type": "JA_PAY_READ",
      • "allowed": true
      }
    ]
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array (>= 0 items)
id
required
string (NotificationSettingId) ^(?:SECURITY_SYSTEM|HOME_AUTOMATION)-[0-9(a-f...
Example: "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f"
required
object (NotificationContactBase)
id
required
string <uuid> (UuidString)
Example: "296ffe8b-2f9e-4c69-939d-5b996b73681f"
required
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
Any of
[ 1 .. 128 ] characters
string (APP_INSTANCE_ID) [ 1 .. 128 ] characters
label
string or null (ContactLabel) [ 1 .. 64 ] characters
Example: "My iPhone"
category
required
string (schemas-NotificationCategory) ^[A-Z\.\_]{1,}[A-Z]$
Example: "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED"

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" … 15 more
canEdit
required
boolean (CanEdit)

User can edit this entity

canRemove
required
boolean (CanEdit)

User can edit this entity

object (NotificationComponentBase)
required
SECTION (string) or ACTOR (string) or COMPONENT (string) (NotificationSettingComponent)
One of
string (SECTION) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

TEMPERATURE_SETTING (object) or CONSUMPTION_SETTING (object)
One of
$type
required
string
Value: "TEMPERATURE"
temperature
required
number <float> (Temperature)
Example: "-13.5"

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

hysteresis
number <float> (Temperature)
Example: "-13.5"

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

object
from
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
to
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
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

created
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Response samples

Content type
application/json
[
  • {
    • "id": "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "contact": {
      • "id": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
      • "target": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
      • "label": "My iPhone"
      },
    • "category": "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED",
    • "languageCode": "CS",
    • "component": {
      • "id": "SECTION_<OBJECT_JA100F:242566>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        }
      },
    • "settings": {
      • "$type": "TEMPERATURE",
      • "temperature": -13.5,
      • "hysteresis": -13.5
      },
    • "validity": {
      • "from": "20:15",
      • "to": "20:15"
      },
    • "isCritical": true,
    • "soundCategory": "ALARM",
    • "canEdit": true,
    • "canRemove": true,
    • "created": "2019-08-24T14:15:22Z"
    }
]

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
Example: "contact-01"

Custom client identification of object

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

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" … 15 more
TEMPERATURE_SETTING (object) or CONSUMPTION_SETTING (object)
One of
$type
required
string
Value: "TEMPERATURE"
temperature
required
number <float> (Temperature)
Example: "-13.5"

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

hysteresis
number <float> (Temperature)
Example: "-13.5"

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

object
from
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
to
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
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)
One of
string (SECTION) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$

Responses

Request samples

Content type
application/json
[
  • {
    • "clientCustomId": "contact-01",
    • "category": "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED",
    • "languageCode": "CS",
    • "settings": {
      • "$type": "TEMPERATURE",
      • "temperature": -13.5,
      • "hysteresis": -13.5
      },
    • "validity": {
      • "from": "20:15",
      • "to": "20:15"
      },
    • "isCritical": true,
    • "soundCategory": "ALARM",
    • "componentId": "SECTION_<OBJECT_JA100F:242566>:1"
    }
]

Response samples

Content type
application/json
[
  • {
    • "clientCustomId": "contact-01",
    • "id": "SECURITY_SYSTEM-85ba5dea-52b2-4408-a4f9-50a3d774972a",
    • "result": {
      • "success": true
      }
    }
]

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 ]
Array (non-empty)
type
string (ContactType)
Enum: "SMS" "VOICE" "PUSH" "EMAIL"
Example: "PUSH"
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
Any of
[ 1 .. 128 ] characters
string (APP_INSTANCE_ID) [ 1 .. 128 ] characters

Responses

Response Schema: application/json
Array (>= 0 items)
id
required
string <uuid> (UuidString)
Example: "296ffe8b-2f9e-4c69-939d-5b996b73681f"
required
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
Any of
[ 1 .. 128 ] characters
string (APP_INSTANCE_ID) [ 1 .. 128 ] characters
type
required
string (ContactType)
Enum: "SMS" "VOICE" "PUSH" "EMAIL"
Example: "PUSH"
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

active
required
boolean (Active)

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

valid
required
boolean (Valid)

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

canEdit
required
boolean (CanEdit)

User can edit this entity

canRemove
required
boolean (CanEdit)

User can edit this entity

created
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

label
string or null (ContactLabel) [ 1 .. 64 ] characters
Example: "My iPhone"
settingsCount
number
Example: "5"

Current settings under this contact and service

Request samples

Content type
application/json
{
  • "active": true,
  • "valid": true,
  • "targetType": [
    • {
      • "type": "PUSH",
      • "target": "296ffe8b-2f9e-4c69-939d-5b996b73681f"
      }
    ]
}

Response samples

Content type
application/json
[
  • {
    • "id": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "target": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "label": "My iPhone",
    • "type": "PUSH",
    • "owner": {
      • "userLogin": "tomas.janda@jablotron.cz",
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
      },
    • "active": true,
    • "valid": true,
    • "settingsCount": 5,
    • "canEdit": true,
    • "canRemove": true,
    • "created": "2019-08-24T14:15:22Z"
    }
]

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 Schema: application/json
Array (>= 0 items)
required
SECTION (string) or ACTOR (string) or COMPONENT (string) (NotificationSettingComponent)
One of
string (SECTION) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

type
required
string
Enum: "SECTION" "ACTOR" "THERMOMETER" "THERMOSTAT" "PULSE_METER"
allowedCategories
required
Array of strings (schemas-NotificationCategory) non-empty unique [ items^[A-Z\.\_]{1,}[A-Z]$ ]
Example: ["SECURITY_SYSTEM.CONSUMPTION_EXCEEDED"]
name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

PULSE_METER_SETTINGS (object)
One of
unit
required
string (PulseMeterUnits)
Enum: "KWH" "L" "PCS" "M3" "PULSES"

Units of consumption

$type
required
string
Value: "PULSE_METER_SETTINGS"
currency
string (Currency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" … 155 more

Allowed CLOUD currencies

Response samples

Content type
application/json
[
  • {
    • "id": "SECTION_<OBJECT_JA100F:242566>:1",
    • "name": "PIR Bedroom",
    • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
    • "defaultNameTVar": {
      • "entityId": "5"
      },
    • "type": "SECTION",
    • "allowedCategories": [
      • "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED"
      ],
    • "meta": {
      • "unit": "KWH",
      • "currency": "AED",
      • "$type": "PULSE_METER_SETTINGS"
      }
    }
]

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...
Example: "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f"
languageCode
string (LanguageCode)
Enum: "CS" "DA" "DE" "EL" "EN" "ES" "FI" "FR" "HR" "HU" … 15 more
TEMPERATURE_SETTING (object) or CONSUMPTION_SETTING (object)
One of
$type
required
string
Value: "TEMPERATURE"
temperature
required
number <float> (Temperature)
Example: "-13.5"

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

hysteresis
number <float> (Temperature)
Example: "-13.5"

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

object or null
One of
from
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
to
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
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
[
  • {
    • "id": "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "languageCode": "CS",
    • "settings": {
      • "$type": "TEMPERATURE",
      • "temperature": -13.5,
      • "hysteresis": -13.5
      },
    • "validity": {
      • "from": "20:15",
      • "to": "20:15"
      },
    • "isCritical": true,
    • "soundCategory": "ALARM"
    }
]

Response samples

Content type
application/json
[
  • {
    • "clientCustomId": "contact-01",
    • "id": "SECURITY_SYSTEM-85ba5dea-52b2-4408-a4f9-50a3d774972a",
    • "result": {
      • "success": true
      }
    }
]

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...
Example: "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f"

Responses

Request samples

Content type
application/json
[
  • {
    • "id": "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f"
    }
]

Response samples

Content type
application/json
[
  • {
    • "clientCustomId": "contact-01",
    • "id": "SECURITY_SYSTEM-85ba5dea-52b2-4408-a4f9-50a3d774972a",
    • "result": {
      • "success": true
      }
    }
]

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 Schema: application/json
id
required
string (NotificationSettingId) ^(?:SECURITY_SYSTEM|HOME_AUTOMATION)-[0-9(a-f...
Example: "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f"
required
object (NotificationContactBase)
id
required
string <uuid> (UuidString)
Example: "296ffe8b-2f9e-4c69-939d-5b996b73681f"
required
APP_INSTANCE_ID (string) or PHONE_NUMBER (string) or EMAIL (string) (Target)
Any of
[ 1 .. 128 ] characters
string (APP_INSTANCE_ID) [ 1 .. 128 ] characters
label
string or null (ContactLabel) [ 1 .. 64 ] characters
Example: "My iPhone"
category
required
string (schemas-NotificationCategory) ^[A-Z\.\_]{1,}[A-Z]$
Example: "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED"

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" … 15 more
canEdit
required
boolean (CanEdit)

User can edit this entity

canRemove
required
boolean (CanEdit)

User can edit this entity

object (NotificationComponentBase)
required
SECTION (string) or ACTOR (string) or COMPONENT (string) (NotificationSettingComponent)
One of
string (SECTION) ^SECTION_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

TEMPERATURE_SETTING (object) or CONSUMPTION_SETTING (object)
One of
$type
required
string
Value: "TEMPERATURE"
temperature
required
number <float> (Temperature)
Example: "-13.5"

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

hysteresis
number <float> (Temperature)
Example: "-13.5"

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

object
from
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
to
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
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

created
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Response samples

Content type
application/json
{
  • "id": "SECURITY_SYSTEM-296ffe8b-2f9e-4c69-939d-5b996b73681f",
  • "contact": {
    • "id": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "target": "296ffe8b-2f9e-4c69-939d-5b996b73681f",
    • "label": "My iPhone"
    },
  • "category": "SECURITY_SYSTEM.CONSUMPTION_EXCEEDED",
  • "languageCode": "CS",
  • "component": {
    • "id": "SECTION_<OBJECT_JA100F:242566>:1",
    • "name": "PIR Bedroom",
    • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
    • "defaultNameTVar": {
      • "entityId": "5"
      }
    },
  • "settings": {
    • "$type": "TEMPERATURE",
    • "temperature": -13.5,
    • "hysteresis": -13.5
    },
  • "validity": {
    • "from": "20:15",
    • "to": "20:15"
    },
  • "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
Example: "contact-01"

Custom client identification of object

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

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    • "clientCustomId": "contact-01",
    • "id": "SECURITY_SYSTEM-85ba5dea-52b2-4408-a4f9-50a3d774972a",
    • "result": {
      • "success": true
      }
    }
]

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)
Any of
[ 1 .. 128 ] characters
string (APP_INSTANCE_ID) [ 1 .. 128 ] characters
label
string or null (ContactLabel) [ 1 .. 64 ] characters
Example: "My iPhone"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
$type
required
string
Currency (string) or null
One of
string (Currency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" … 155 more

Allowed CLOUD currencies

PulseMeterPrice (number) or null
One of
>= 0.01
number <double> (PulseMeterPrice) >= 0.01
PulseMeterPrice (number) or null
One of
>= 0.01
number <double> (PulseMeterPrice) >= 0.01
displayMode
string (PulseMeterDisplayMode)
Enum: "SINGLE" "DUAL"

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
One of
string (Currency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" … 155 more

Allowed CLOUD currencies

PulseMeterPrice (number) or null
One of
>= 0.01
number <double> (PulseMeterPrice) >= 0.01
PulseMeterPrice (number) or null
One of
>= 0.01
number <double> (PulseMeterPrice) >= 0.01
displayMode
string (PulseMeterDisplayMode)
Enum: "SINGLE" "DUAL"

Responses

Response Schema: application/json
$type
required
string
Currency (string) or null
One of
string (Currency)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" … 155 more

Allowed CLOUD currencies

PulseMeterPrice (number) or null
One of
>= 0.01
number <double> (PulseMeterPrice) >= 0.01
PulseMeterPrice (number) or null
One of
>= 0.01
number <double> (PulseMeterPrice) >= 0.01
displayMode
string (PulseMeterDisplayMode)
Enum: "SINGLE" "DUAL"

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

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

Current thermostat mode

temperature
number <float> (Temperature)
Example: "-13.5"

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

Responses

Response Schema: application/json
$type
required
string
mode
required
string
Enum: "MANUAL" "CALENDAR" "MANUAL_TEMPORARY" "STANDBY"

Current thermostat mode

temperature
number <float> (Temperature)
Example: "-13.5"

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

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
Example: "15.2365"

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

wantedTotalValueLo
number <float> (WantedConsumption) >= 0
Example: "15.2365"

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

wantedTotalValue
number <float> (WantedConsumption) >= 0
Example: "15.2365"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Register Dial controller device to CLOUD

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Registration params

required
DEVICE_IDENTITY (string) or REGISTRATION_KEY (string)
One of
string (DEVICE_IDENTITY) ^DEVICE_((JACLOUDSN:[A-F\d]{8})|(JASNV1:[\d]{...
serviceName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

Responses

Response Schema: application/json
serviceEntityId
required
string (ServiceEntityId) ^SERVICE_(\w+):([\d]+)$
Example: "SERVICE_JA100F:242566"
objectEntityId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"

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 Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

state
required
string (ProcessState)
Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
type
required
string (ProcessType)
Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" … 4 more

CONFIGURATION is deprecated, use CONFIGURATION_DOWNLOAD instead

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

scheduledAt
string <date-time> (DateTime)

Only available for CREATED status

completedAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

success
boolean
Default: true

Only available for completed status

object

Only available for non-success status

code
required
string (ProcessErrorType)
Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" … 3 more
debugMessage
string non-empty
Example: "Cannot connect to device via YTUN"
object non-empty
userName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originUserName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originRequestId
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

remainingAttempts
integer >= 0

Returns only for unfinished requests and tells how many attempts (including the currently running one) remain.

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": {
    • "code": "CANCELED_BY_OTHER_PROCESS",
    • "debugMessage": "Cannot connect to device via YTUN"
    },
  • "meta": {
    • "userName": "tomas.janda@jablotron.cz",
    • "originUserName": "tomas.janda@jablotron.cz",
    • "originRequestId": "DCD-1254445521",
    • "remainingAttempts": 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: "RECONFIGURATION"

Responses

Response Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

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 Schema: application/json
Array (non-empty)
id
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
name
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
deviceModel
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"

Response samples

Content type
application/json
[
  • {
    • "id": "OBJECT_JA100F:242566",
    • "name": "My House",
    • "createdAt": "2019-08-24T14:15:22Z",
    • "registrationKey": "LAS6D-U2VBG-UHX65",
    • "deviceModel": "JA-101K LAN 3G"
    }
]

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 Schema: application/json
finalState
required
boolean

Returns true only when all necessary steps are finished

unfinishedSteps
Array of strings (DependencyType) non-empty unique
Items Enum: "OBJECT_SETUP" "USER_SERVICE" "ARC" "CUSTOMER"

List of unfinished steps returned when finalState is false

recommendedStep
string (DependencyType)
Enum: "OBJECT_SETUP" "USER_SERVICE" "ARC" "CUSTOMER"

Recommended step to continue for a client

Response samples

Content type
application/json
{
  • "finalState": true,
  • "unfinishedSteps": [
    • "OBJECT_SETUP"
    ],
  • "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 Schema: application/json
finalState
required
boolean

Returns true only when both device setting and configuration download steps are completed. False does not distinguish unfinished and failed historical processing.

required
object (ObjectSettingStepStatus)

Current status of a single configuration setup step derived from the object state and an optionally active setting request.

finished
required
boolean

Returns true when the configuration step is completed according to the object state.

finishedAt
string <date-time> (DateTime)

Date and time when the configuration step was completed. Omitted when the step is not completed.

object (ProcessManagerRequestBase)

Currently active request for the configuration step. Omitted when there is no active request. Historical failed requests are not included.

requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

state
required
string (ProcessState)
Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
type
required
string (ProcessType)
Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" … 4 more

CONFIGURATION is deprecated, use CONFIGURATION_DOWNLOAD instead

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

scheduledAt
string <date-time> (DateTime)

Only available for CREATED status

completedAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

success
boolean
Default: true

Only available for completed status

object

Only available for non-success status

code
required
string (ProcessErrorType)
Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" … 3 more
debugMessage
string non-empty
Example: "Cannot connect to device via YTUN"
object non-empty
userName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originUserName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originRequestId
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

remainingAttempts
integer >= 0

Returns only for unfinished requests and tells how many attempts (including the currently running one) remain.

required
object (ConfigurationDownloadStepStatus)

Current status of a single configuration setup step derived from the object state and an optionally active setting request.

finished
required
boolean

Returns true when the configuration step is completed according to the object state.

shouldBeProcessedManually
required
boolean

Returns true when manual processing of configuration download is currently allowed by business logic.

finishedAt
string <date-time> (DateTime)

Date and time when the configuration step was completed. Omitted when the step is not completed.

object (ProcessManagerRequestBase)

Currently active request for the configuration step. Omitted when there is no active request. Historical failed requests are not included.

requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

state
required
string (ProcessState)
Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
type
required
string (ProcessType)
Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" … 4 more

CONFIGURATION is deprecated, use CONFIGURATION_DOWNLOAD instead

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

scheduledAt
string <date-time> (DateTime)

Only available for CREATED status

completedAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

success
boolean
Default: true

Only available for completed status

object

Only available for non-success status

code
required
string (ProcessErrorType)
Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" … 3 more
debugMessage
string non-empty
Example: "Cannot connect to device via YTUN"
object non-empty
userName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originUserName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originRequestId
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

remainingAttempts
integer >= 0

Returns only for unfinished requests and tells how many attempts (including the currently running one) remain.

recommendedStep
string (RecommendedStepStatus)
Enum: "DOWNLOAD_CONFIGURATION" "RECONFIGURATION"

Recommended next setup step. Send this field only when at least one setup step is unfinished. Value configurationDownloadStep maps from DOWNLOAD_CONFIGURATION and value settingStep maps from RECONFIGURATION.

Response samples

Content type
application/json
{
  • "finalState": true,
  • "settingStep": {
    • "finished": true,
    • "finishedAt": "2019-08-24T14:15:22Z",
    • "activeRequest": {
      • "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": {
        • "code": "CANCELED_BY_OTHER_PROCESS",
        • "debugMessage": "Cannot connect to device via YTUN"
        },
      • "meta": {
        • "userName": "tomas.janda@jablotron.cz",
        • "originUserName": "tomas.janda@jablotron.cz",
        • "originRequestId": "DCD-1254445521",
        • "remainingAttempts": 0
        }
      }
    },
  • "configurationDownloadStep": {
    • "finished": true,
    • "finishedAt": "2019-08-24T14:15:22Z",
    • "activeRequest": {
      • "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": {
        • "code": "CANCELED_BY_OTHER_PROCESS",
        • "debugMessage": "Cannot connect to device via YTUN"
        },
      • "meta": {
        • "userName": "tomas.janda@jablotron.cz",
        • "originUserName": "tomas.janda@jablotron.cz",
        • "originRequestId": "DCD-1254445521",
        • "remainingAttempts": 0
        }
      },
    • "shouldBeProcessedManually": true
    },
  • "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 Schema: application/json
finalState
required
boolean
Example: "true"

Indicates whether current form state is final and can be submitted.

required
Array of objects (DynamicFormGroupDefinition) non-empty
Example: [{"id":"CUSTOMER","translationKey":"JAPARTNER:Customer","order":1}]

Ordered list of groups that define form sections in UI.

Array (non-empty)
id
required
string^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$
Example: "CUSTOMER_TYPE"

Stable identifier of form group referenced by attributes via groupId.

translationKey
required
string
Example: "SecuritySystem:Control panel"

Localization key used as group title in UI.

order
required
integer >= 1
Example: "1"

Display order of the group in form layout.

required
Array of GROUP (object) or ATTRIBUTE (any) (DynamicFormItem) non-empty
Example: [{"id":"CUSTOMER_TYPE","type":"ATTRIBUTE","format":"ENUM","required":true,"groupOrder":1,"translationKey":"JAPARTNER:Customer type","groupId":"CUSTOMER","values":[{"value":"PERSON","translationKey":"JAPARTNER:Person"},{"value":"COMPANY","translationKey":"JAPARTNER:Company"}],"value":null}]

Top-level form items. Each item is either standalone attribute or nested conditional group.

Array (non-empty)
One of
type
required
string
Value: "GROUP"
Example: "GROUP"

Discriminator indicating this item is a nested group.

required
DynamicFormDependencyWithValue (object) or DynamicFormDependencyWithoutValue (object)
Example: {"attributeId":"customerType","operator":"EQUAL","value":"PERSON"}

Condition that controls visibility of conditional group item.

Comparison rules for clients:

  • EQUAL (case-insensitive): compares value.
  • NOT_EQUAL (case-insensitive): logical negation of EQUAL.
  • CONTAIN (case-insensitive): supported only for STRING and SET.
  • NOT_CONTAIN (case-insensitive): logical negation of CONTAIN.
  • EMPTY: compared attribute has no value.
  • NOT_EMPTY: compared attribute has some value.

Type-specific behavior:

  • STRING, BOOLEAN, UINT, INT, FLOAT: compared directly against value.
  • DATETIME: both compared values must be converted to UTC and normalized to the same format before comparison.
  • ENUM: compares selected enum value 1:1.
  • SET with EQUAL / NOT_EQUAL: compares full set content, order does not matter.
  • SET with CONTAIN / NOT_CONTAIN: checks whether all provided enum values are present in set.

Examples:

  • EQUAL + ENUM: value: "PERSON"
  • EQUAL + SET: value: ["PERSON","COMPANY"] (same set in any order is equal)
  • EQUAL + STRING: value: "John Doe"
  • EQUAL + NUMBER: value: 10.5
  • EQUAL + BOOLEAN: value: true
  • EQUAL + DATETIME: value: "2026-04-27T10:34:56Z"
  • CONTAIN + STRING: value: "john"
  • CONTAIN + SET: value: ["PERSON","COMPANY"]
  • EMPTY / NOT_EMPTY: without value
One of
attributeId
required
string^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$
Example: "CUSTOMER_TYPE"

ID of controlling attribute whose value is evaluated.

operator
required
string
Enum: "EQUAL" "NOT_EQUAL" "CONTAIN" "NOT_CONTAIN"
Example: "EQUAL"

Comparison operator used for dependency evaluation.

required
(DEPENDENCY_SINGLE_VALUE (ENUM (string) or STRING (string) or NUMBER (number) or DATE (string) or BOOLEAN (boolean))) or (Array of DEPENDENCY_MULTI_VALUE (ENUM (string) or STRING (string) or NUMBER (number) or DATE (string) or BOOLEAN (boolean)))
Example: "PERSON"

Compared value used by selected operator.

Expected shape by operator and compared attribute format:

  • EQUAL / NOT_EQUAL + scalar formats (ENUM, STRING, BOOLEAN, DATETIME, UINT, INT, FLOAT): single value.
  • EQUAL / NOT_EQUAL + SET: array of values; order is ignored during comparison.
  • CONTAIN / NOT_CONTAIN + STRING: single value.
  • CONTAIN / NOT_CONTAIN + SET: array of values; all provided values must be contained in the compared set.

Datetime note:

  • For DATETIME, compared values must be converted to UTC and normalized to the same format before evaluation.
One of
Any of
string (ENUM) ^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$

Enum-like dependency value in SCREAMING_SNAKE_CASE format.

groupId
required
string^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$
Example: "CUSTOMER_TYPE"

Target top-level group where this nested group belongs.

required
Array of any (ATTRIBUTE) non-empty
Example: [{"id":"personName","type":"ATTRIBUTE","format":"NAME_AND_SURNAME","value":null,"required":true,"groupOrder":1,"translationKey":"JAPARTNER:Name and surname","groupId":"CUSTOMER"}]

Nested attributes rendered when dependency is satisfied.

Array (non-empty)
id
required
string^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$
Example: "CUSTOMER_TYPE"

Stable identifier of attribute in response and request payloads.

type
required
string
Value: "ATTRIBUTE"
Example: "ATTRIBUTE"

Discriminator indicating this item is attribute definition.

required
required
boolean
Example: "true"

Indicates whether attribute value must be provided before submission.

groupOrder
required
integer >= 1
Example: "1"

Display order inside parent group.

translationKey
required
string
Example: "SecuritySystem:Control panel"

Localization key used as field label in UI.

groupId
required
string^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$
Example: "CUSTOMER_TYPE"

ID of top-level group where attribute is rendered.

formElementType
required
string
Enum: "SELECT" "RADIO_GROUP" "TEXT_INPUT" "TEXTAREA" "MULTISELECT" "CHECKBOX" "DATE_TIME_PICKER" "NUMBER_INPUT" "EMAIL_INPUT" "PHONE_INPUT"
Example: "SELECT"

Recommended form control used to render this attribute in UI.

format
required
string
Example: "ENUM"

Declares attribute format as enum (string values only).

required
Array of objects (DynamicFormAllowedValue) non-empty
Example: [{"value":"PERSON","translationKey":"JAPARTNER:Person"}]

List of allowed enum options available to user.

Array (non-empty)
value
required
string
Example: "PERSON"

Unique identifier of the allowed value.

translationKey
required
string
Example: "SecuritySystem:Control panel"

Localization key used for value label in selectors.

value
required
string or null
Example: null

Current selected enum value, null when not selected yet.

Response samples

Content type
application/json
{
  • "finalState": true,
  • "groups": [
    • {
      • "id": "CUSTOMER",
      • "translationKey": "JAPARTNER:Customer",
      • "order": 1
      }
    ],
  • "attributes": [
    • {
      • "id": "CUSTOMER_TYPE",
      • "type": "ATTRIBUTE",
      • "format": "ENUM",
      • "required": true,
      • "groupOrder": 1,
      • "translationKey": "JAPARTNER:Customer type",
      • "groupId": "CUSTOMER",
      • "values": [
        • {
          • "value": "PERSON",
          • "translationKey": "JAPARTNER:Person"
          },
        • {
          • "value": "COMPANY",
          • "translationKey": "JAPARTNER:Company"
          }
        ],
      • "value": null
      }
    ]
}

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 Schema: application/json
finalState
required
boolean

Returns true only when the service is created and ready to use

required
Array of objects (DependencyItem) non-empty
Array (non-empty)
type
required
string (DependencyType)
Enum: "OBJECT_SETUP" "USER_SERVICE" "ARC" "CUSTOMER"
finished
required
boolean
required
object (ServiceStatus)
isCreated
required
boolean

Returns true only when the service is created and ready to use

allAvailableServiceTypesCreated
boolean

Returns true only when all service types are created and ready to use

object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

Array of objects (ServiceStatusServiceDetail) non-empty
Array (non-empty)
isMainServiceType
required
boolean

Returns true only when the service is main service type

name
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

type
required
string (ServiceType)
Enum: "AMBIENTA" "ATHOS" "ATHOS2" "AURA" "AZOR" "FUTURA" "FUTURA2" "GD04K" "JA10" "JA100" … 8 more
Example: "JA100F"
id
required
string (ServiceEntityId) ^SERVICE_(\w+):([\d]+)$
Example: "SERVICE_JA100F:242566"
createdAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object
objectName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

Response samples

Content type
application/json
{
  • "finalState": true,
  • "dependencies": [
    • {
      • "type": "OBJECT_SETUP",
      • "finished": true
      }
    ],
  • "serviceStatus": {
    • "isCreated": true,
    • "allAvailableServiceTypesCreated": true,
    • "owner": {
      • "userLogin": "tomas.janda@jablotron.cz",
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
      },
    • "services": [
      • {
        • "isMainServiceType": true,
        • "name": "My House",
        • "id": "SERVICE_JA100F:242566",
        • "type": "JA100F",
        • "createdAt": "2019-08-24T14:15:22Z"
        }
      ]
    },
  • "meta": {
    • "objectName": "My House"
    }
}

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
Example: "My House"

Name of object or service

type
string (ServiceType)
Enum: "AMBIENTA" "ATHOS" "ATHOS2" "AURA" "AZOR" "FUTURA" "FUTURA2" "GD04K" "JA10" "JA100" … 8 more
Example: "JA100F"

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

Responses

Response Schema: application/json
id
required
string (ServiceEntityId) ^SERVICE_(\w+):([\d]+)$
Example: "SERVICE_JA100F:242566"

Request samples

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

Response samples

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

Update object customer attributes

Update customer attributes for an object entity.

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

Attributes to be updated

Array (non-empty)
id
required
string^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$
Example: "CUSTOMER_TYPE"

Stable identifier of attribute in response and request payloads.

value
required
Array of strings or numbers or booleans or arrays or null or string or number or boolean or null
Example: "PERSON"

Updated attribute value, null to remove attribute.

Responses

Request samples

Content type
application/json
[
  • {
    • "id": "CUSTOMER_TYPE",
    • "value": "PERSON"
    }
]

Response samples

Content type
application/json
[
  • {
    • "id": "CUSTOMER_TYPE",
    • "debugMessage": "Value must contain two letters and six digits, only for debug reason"
    }
]

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...
Example: "LAS6D-U2VBG-UHX65"
authorizationCode
required
string (IndexaAuthorizationCode) ^[A-F0-9]{16}$
Example: "A1B2C3D4E5F60708"
masterCode
required
string (JA100Code) ^([\d]{1,3}\*)?([\d]{4}|[\d]{6}|[\d]{8})$
Example: "2*1234"
msisdn
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

objectName
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

Responses

Response Schema: application/json
objectEntityId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Get logged user information

Authorizations:
KongResolverOAuthJCS

Responses

Response Schema: application/json
non-empty
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

PHONE_NUMBER (string) or null
One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

NAME_AND_SURNAME (string) or null
One of
[ 1 .. 70 ] characters
string (NAME_AND_SURNAME) [ 1 .. 70 ] characters

Name of a person, each part of name must be maximal 30 characters long

newsletterAllowed
boolean

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
One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

NAME_AND_SURNAME (string) or null
One of
[ 1 .. 70 ] characters
string (NAME_AND_SURNAME) [ 1 .. 70 ] characters

Name of a person, each part of name must be maximal 30 characters long

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Installer

Installer resources

Get companies for logged installer

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

Array of included objects

Responses

Response Schema: application/json
Array (non-empty)
companyId
required
number (IntId) >= 1

Common Int id

name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
required
object
role
required
string (InstallerRole)
Enum: "INSTALLER" "ADMIN" "GROUP_ADMIN" "OWNER"
Array of objects (DistributorBase) non-empty unique
Array (non-empty)
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

Response samples

Content type
application/json
[
  • {
    • "companyId": 1,
    • "name": "Company s.r.o.",
    • "me": {
      • "role": "INSTALLER"
      },
    • "distributors": [
      • {
        • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
        • "name": "Company s.r.o.",
        • "countryCode": "CZ",
        • "rgapCountry": "CZ"
        }
      ]
    }
]

Get company information

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

Id of installerCompany

Responses

Response Schema: application/json
companyId
required
number (IntId) >= 1

Common Int id

name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
affiliateRegistered
required
boolean
Default: false

ignored in PATCH, only for admin view

required
Array of objects (DistributorBase) non-empty
Array (non-empty)
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

required
object
role
required
string (InstallerRole)
Enum: "INSTALLER" "ADMIN" "GROUP_ADMIN" "OWNER"
required
object (InstallerGlobalRights)
companyView
required
boolean
companyModify
required
boolean
groupView
required
boolean
groupModify
required
boolean
groupCreate
required
boolean
groupRemove
required
boolean
userView
required
boolean
userCreate
required
boolean
userModify
required
boolean
userRemove
required
boolean
adminModify
required
boolean
adminRemove
required
boolean
ownerModify
required
boolean
cin
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters
Example: "885255412"

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

companyLogoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "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",
  • "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": {
    • "userLogin": "tomas.janda@jablotron.cz",
    • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
    },
  • "distributors": [
    • {
      • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
      • "name": "Company s.r.o.",
      • "countryCode": "CZ",
      • "rgapCountry": "CZ"
      }
    ],
  • "me": {
    • "role": "INSTALLER",
    • "permissions": {
      • "companyView": true,
      • "companyModify": true,
      • "groupView": true,
      • "groupModify": true,
      • "groupCreate": true,
      • "groupRemove": true,
      • "userView": true,
      • "userCreate": true,
      • "userModify": true,
      • "userRemove": true,
      • "adminModify": true,
      • "adminRemove": true,
      • "ownerModify": true
      }
    }
}

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
Example: "885255412"

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

affiliateRegistered
boolean

ignored in PATCH, only for admin view

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

name
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."

Responses

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "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",
  • "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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
required
Array of objects (ThermometerList) >= 0 items
Array (>= 0 items)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

state
required
string (ThermometerState)
Enum: "SET" "PREPARED" "LIMIT_REACHED"
required
object
minTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

maxTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

object (CloudThermostatSettingGet)

Available only for state SET

required
object (ActorBaseModel)
id
required
string (ActorEntityId) ^ACTOR_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "ACTOR_<OBJECT_JA100F:242566>:5"
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

temperature
required
number <float> (Temperature)
Example: "-13.5"

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

Array of objects (ActorBaseModel) non-empty
Array (non-empty)
id
required
string (ActorEntityId) ^ACTOR_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "ACTOR_<OBJECT_JA100F:242566>:5"
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

Response samples

Content type
application/json
{
  • "thermometers": [
    • {
      • "id": "SECTION_<OBJECT_JA100F:12345>:1",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "state": "SET",
      • "setting": {
        • "actor": {
          • "id": "ACTOR_<OBJECT_JA100F:242566>:5",
          • "name": "PIR Bedroom",
          • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
          • "defaultNameTVar": {
            • "entityId": "5"
            }
          },
        • "temperature": -13.5
        },
      • "meta": {
        • "minTemperature": -13.5,
        • "maxTemperature": -13.5
        }
      }
    ],
  • "actors": [
    • {
      • "id": "ACTOR_<OBJECT_JA100F:242566>:5",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        }
      }
    ]
}

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 Schema: application/json
required
object (ThermometerDetail)
required
DEVICE_COMPONENT (string) or CUSTOM_CAMERA (string) or JABLOTRON_CAMERA (string)
One of
string (DEVICE_COMPONENT) ^(SECTION|COMPONENT|ACTOR|USER)_<(OBJECT_(\w+...

Unique identification of component e.g. SECTION_<OBJECT_JA100F:12345>:1, OASiS - SECTION_<OBJECT_JA100F:12345>:ALL

defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

state
required
string (ThermometerState)
Enum: "SET" "PREPARED" "LIMIT_REACHED"
required
object
minTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

maxTemperature
required
number <float> (Temperature)
Example: "-13.5"

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

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

object (CloudThermostatSettingGet)

Available only for state SET

required
object (ActorBaseModel)
id
required
string (ActorEntityId) ^ACTOR_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "ACTOR_<OBJECT_JA100F:242566>:5"
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

temperature
required
number <float> (Temperature)
Example: "-13.5"

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

Array of objects (ActorBaseModel) non-empty
Array (non-empty)
id
required
string (ActorEntityId) ^ACTOR_<(OBJECT_(\w+):[\d]+)>:([\d]+)$
Example: "ACTOR_<OBJECT_JA100F:242566>:5"
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

Response samples

Content type
application/json
{
  • "thermometer": {
    • "id": "SECTION_<OBJECT_JA100F:12345>:1",
    • "name": "PIR Bedroom",
    • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
    • "defaultNameTVar": {
      • "entityId": "5"
      },
    • "state": "SET",
    • "setting": {
      • "actor": {
        • "id": "ACTOR_<OBJECT_JA100F:242566>:5",
        • "name": "PIR Bedroom",
        • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
        • "defaultNameTVar": {
          • "entityId": "5"
          }
        },
      • "temperature": -13.5
      },
    • "meta": {
      • "minTemperature": -13.5,
      • "maxTemperature": -13.5
      }
    },
  • "actors": [
    • {
      • "id": "ACTOR_<OBJECT_JA100F:242566>:5",
      • "name": "PIR Bedroom",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        }
      }
    ]
}

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]+)$
Example: "ACTOR_<OBJECT_JA100F:242566>:5"
temperature
number <float> (Temperature)
Example: "-13.5"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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]+)$
Example: "ACTOR_<OBJECT_JA100F:242566>:5"
temperature
required
number <float> (Temperature)
Example: "-13.5"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
$type
required
string
Value: "THERMOSTAT_SETTINGS"
economyTemperature
number <float> (Temperature)
Example: "-13.5"

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

comfortTemperature
number <float> (Temperature)
Example: "-13.5"

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

standbyTemperature
number <float> (Temperature)
Example: "-13.5"

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

hysteresis
number <float> (Temperature)
Example: "-13.5"

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

calibration
number <float> (Temperature)
Example: "-13.5"

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

object (ThermostatCalendar)
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
calendarGrouping
string
Default: "SEPARATE"
Enum: "WEEK" "WORKING_DAYS" "SEPARATE"
overheatTemperature
number <float> (Temperature)
Example: "-13.5"

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

freezeTemperature
number <float> (Temperature)
Example: "-13.5"

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

minimumTemperature
number <float> (Temperature)
Example: "-13.5"

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

maximumTemperature
number <float> (Temperature)
Example: "-13.5"

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

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

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": {
    • "monday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "tuesday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "wednesday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "thursday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "friday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "saturday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "sunday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ]
    },
  • "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)
Example: "-13.5"

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

comfortTemperature
number <float> (Temperature)
Example: "-13.5"

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

standbyTemperature
number <float> (Temperature)
Example: "-13.5"

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

hysteresis
number <float> (Temperature)
Example: "-13.5"

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

calibration
number <float> (Temperature)
Example: "-13.5"

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

object (ThermostatCalendar)
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
required
Array of objects (ThermostatCalendarDay) = 4 items
Array (= 4 items)
start
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
end
required
string (HoursAndMinutes) ^(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]$
Example: "20:15"
calendarGrouping
string
Default: "SEPARATE"
Enum: "WEEK" "WORKING_DAYS" "SEPARATE"
overheatTemperature
number <float> (Temperature)
Example: "-13.5"

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

freezeTemperature
number <float> (Temperature)
Example: "-13.5"

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

minimumTemperature
number <float> (Temperature)
Example: "-13.5"

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

maximumTemperature
number <float> (Temperature)
Example: "-13.5"

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": {
    • "monday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "tuesday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "wednesday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "thursday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "friday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "saturday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ],
    • "sunday": [
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        },
      • {
        • "start": "20:15",
        • "end": "20:15"
        }
      ]
    },
  • "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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Get logged user information

Authorizations:
KongResolverOAuthJCS

Responses

Response Schema: application/json
non-empty
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

PHONE_NUMBER (string) or null
One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

NAME_AND_SURNAME (string) or null
One of
[ 1 .. 70 ] characters
string (NAME_AND_SURNAME) [ 1 .. 70 ] characters

Name of a person, each part of name must be maximal 30 characters long

newsletterAllowed
boolean

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
One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

NAME_AND_SURNAME (string) or null
One of
[ 1 .. 70 ] characters
string (NAME_AND_SURNAME) [ 1 .. 70 ] characters

Name of a person, each part of name must be maximal 30 characters long

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

state
required
string (ProcessState)
Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
type
required
string (ProcessType)
Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" … 4 more

CONFIGURATION is deprecated, use CONFIGURATION_DOWNLOAD instead

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

scheduledAt
string <date-time> (DateTime)

Only available for CREATED status

completedAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

success
boolean
Default: true

Only available for completed status

object

Only available for non-success status

code
required
string (ProcessErrorType)
Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" … 3 more
debugMessage
string non-empty
Example: "Cannot connect to device via YTUN"
object non-empty
userName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originUserName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originRequestId
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

remainingAttempts
integer >= 0

Returns only for unfinished requests and tells how many attempts (including the currently running one) remain.

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": {
    • "code": "CANCELED_BY_OTHER_PROCESS",
    • "debugMessage": "Cannot connect to device via YTUN"
    },
  • "meta": {
    • "userName": "tomas.janda@jablotron.cz",
    • "originUserName": "tomas.janda@jablotron.cz",
    • "originRequestId": "DCD-1254445521",
    • "remainingAttempts": 0
    }
}

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 Schema: application/json
objectName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

deviceOfficialName
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"
serialNumber
required
string (SerialNumber) ^[A-F\d]{8}
Example: "F9301214"
registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

phoneNumber
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

arcObjectNumber
string (ObjectNumber) ^[\dA-F]{4,8}$
Example: "F13D"
installerCompany
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
lastEventDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object non-empty
signalStrength
integer (GsmSignalStrength) [ 0 .. 100 ]
Example: "95"
lastDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

operator
string
Example: "Vodafone Czech Republic"
gsmGeneration
string
Example: "4G"
object non-empty
version
string
Example: "MD6112.07.1.2dbg"
date
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

object non-empty
method
string
Enum: "LAN" "GSM" "EXTERNAL_COMMUNICATOR" "UNKNOWN"
date
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

gate
string
Enum: "MAIN_CHANNEL" "BACKUP_CHANNEL" "CLOUD_GATEWAY"
settingSuccessDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

configurationSuccessDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

Array of objects non-empty
Array (non-empty)
index
required
integer [ 0 .. 255 ]
type
required
string
Example: "JA-150EM-DIN"
activationState
required
string
Enum: "ENABLED" "DISABLED" "INPUT_DISABLED" "TAMPER_DISABLED"
defaultNameTK
required
string (DefaultNameTK) non-empty
Example: "SecuritySystem:Intrusion alarm activation"

Default translation key when name in configuration does not exist

required
object (DefaultNameTVar)
entityId
string
Example: "5"

Value to be replaced in defaultNameTK, for example User no. {{entityId}}

name
string (ComponentEntityName) [ 1 .. 24 ] characters
Example: "PIR Bedroom"

Name of component

serialNumber
string (SerialNumberDec) ^[\d]{4}-[\d]{2}-[\d]{4}-[\d]{4}$
Example: "1400-40-1234-5678"
swName
string
Example: "MD6112.07.1.2dbg"
activeSabotageDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

activeGeneralFaultDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

activeBatteryFaultDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

activeAccumulatorFaultDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

activeMainCommunicationChannelFaultDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

activeLostFaultDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

activePowerSupplyFaultDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

serviceModeDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

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": {
    • "signalStrength": 95,
    • "lastDate": "2019-08-24T14:15:22Z",
    • "operator": "Vodafone Czech Republic",
    • "gsmGeneration": "4G"
    },
  • "firmware": {
    • "version": "MD6112.07.1.2dbg",
    • "date": "2019-08-24T14:15:22Z"
    },
  • "connection": {
    • "method": "LAN",
    • "date": "2019-08-24T14:15:22Z",
    • "gate": "MAIN_CHANNEL"
    },
  • "settingSuccessDate": "2019-08-24T14:15:22Z",
  • "configurationSuccessDate": "2019-08-24T14:15:22Z",
  • "peripherals": [
    • {
      • "index": 255,
      • "type": "JA-150EM-DIN",
      • "name": "PIR Bedroom",
      • "serialNumber": "1400-40-1234-5678",
      • "swName": "MD6112.07.1.2dbg",
      • "defaultNameTK": "SecuritySystem:Intrusion alarm activation",
      • "defaultNameTVar": {
        • "entityId": "5"
        },
      • "activeSabotageDate": "2019-08-24T14:15:22Z",
      • "activeGeneralFaultDate": "2019-08-24T14:15:22Z",
      • "activeBatteryFaultDate": "2019-08-24T14:15:22Z",
      • "activeAccumulatorFaultDate": "2019-08-24T14:15:22Z",
      • "activeMainCommunicationChannelFaultDate": "2019-08-24T14:15:22Z",
      • "activeLostFaultDate": "2019-08-24T14:15:22Z",
      • "activePowerSupplyFaultDate": "2019-08-24T14:15:22Z",
      • "serviceModeDate": "2019-08-24T14:15:22Z",
      • "activationState": "ENABLED"
      }
    ]
}

Get list of distributors

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution

Responses

Response Schema: application/json
Array (non-empty)
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

required
object (DistributorSettings)
directArcEnabled
required
boolean
objectTransferEnabled
required
boolean
maintainedByJablonet
required
boolean
simLockEnabled
required
boolean
affiliateRegistered
required
boolean
required
object
arcsCount
required
integer <int32> (Counter) >= 0
Example: "6"
usersCount
required
integer <int32> (Counter) >= 0
Example: "6"
preparedForApi
required
boolean
rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

helpdeskLogin
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

description
string (Description) [ 1 .. 255 ] characters
Example: "Common description of entity up to 255 characters"
object (ApiSettings)
authorizationKey
required
string (AuthorizationKey) = 32 characters
Example: "b0d2f6a2d76a354d3a37f64b8ad08019"
pairedSoftwareKey
string >= 5 characters
Example: "221B368D7F5F597867F525971F28FF75"
isJaArc
boolean
object (DistributorCompanyInfo)
COMPANY_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

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": {
      • "directArcEnabled": true,
      • "objectTransferEnabled": true,
      • "maintainedByJablonet": true,
      • "simLockEnabled": true,
      • "affiliateRegistered": true
      },
    • "api": {
      • "authorizationKey": "b0d2f6a2d76a354d3a37f64b8ad08019",
      • "pairedSoftwareKey": "221B368D7F5F597867F525971F28FF75",
      • "isJaArc": true
      },
    • "contacts": {
      • "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"
      },
    • "meta": {
      • "arcsCount": 6,
      • "usersCount": 6,
      • "preparedForApi": true
      }
    }
]

Create distributor company

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
Request Body schema: application/json

Distributor attributes

distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

helpdeskLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

required
object (DistributorSettings)
directArcEnabled
required
boolean
objectTransferEnabled
required
boolean
maintainedByJablonet
required
boolean
simLockEnabled
required
boolean
affiliateRegistered
required
boolean
rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

description
string (Description) [ 1 .. 255 ] characters
Example: "Common description of entity up to 255 characters"

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": {
    • "directArcEnabled": true,
    • "objectTransferEnabled": true,
    • "maintainedByJablonet": true,
    • "simLockEnabled": true,
    • "affiliateRegistered": true
    }
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

required
object (DistributorSettings)
directArcEnabled
required
boolean
objectTransferEnabled
required
boolean
maintainedByJablonet
required
boolean
simLockEnabled
required
boolean
affiliateRegistered
required
boolean
required
object
activeObjectsCount
required
integer <int32> (Counter) >= 0
Example: "6"
preparedForApi
required
boolean
rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

helpdeskLogin
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

description
string (Description) [ 1 .. 255 ] characters
Example: "Common description of entity up to 255 characters"
object (ApiSettings)
authorizationKey
required
string (AuthorizationKey) = 32 characters
Example: "b0d2f6a2d76a354d3a37f64b8ad08019"
pairedSoftwareKey
string >= 5 characters
Example: "221B368D7F5F597867F525971F28FF75"
isJaArc
boolean
object (DistributorCompanyInfo)
COMPANY_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

Array of objects non-empty unique
Array (non-empty)
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
activeObjectsCount
required
integer <int32> (Counter) >= 0
Example: "6"
hasDefaultTemplate
boolean
Default: false

Indicates whether the DIRECT ARC has a default template set

customName
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
disabledFunctions
Array of strings (DisabledFunctions) non-empty unique
Items Enum: "REMOTE_CONTROL" "CAMERA_MANAGEMENT" "COMMUNICATION_NUMBER_MODIFICATION" "ARC_TRANSFER_MODIFICATION" "DOWNLOAD_CONFIGURATION" "REGISTRATION"

Returned only if the ARC has at least one disabled function.

Array of objects (DistributorUser) non-empty unique
Array (non-empty)
distributorUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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

RFC 3339 Date and Time with TimeZone offset specification

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": {
    • "directArcEnabled": true,
    • "objectTransferEnabled": true,
    • "maintainedByJablonet": true,
    • "simLockEnabled": true,
    • "affiliateRegistered": true
    },
  • "api": {
    • "authorizationKey": "b0d2f6a2d76a354d3a37f64b8ad08019",
    • "pairedSoftwareKey": "221B368D7F5F597867F525971F28FF75",
    • "isJaArc": true
    },
  • "contacts": {
    • "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"
    },
  • "arcs": [
    • {
      • "arcId": "ARC_CLOUD:00008808",
      • "name": "Company s.r.o.",
      • "hasDefaultTemplate": false,
      • "customName": "Company s.r.o.",
      • "activeObjectsCount": 6,
      • "disabledFunctions": [
        • "REMOTE_CONTROL"
        ]
      }
    ],
  • "users": [
    • {
      • "distributorUserId": 242566,
      • "user": {
        • "userLogin": "tomas.janda@jablotron.cz",
        • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
        },
      • "lastLoggedDate": "2019-08-24T14:15:22Z",
      • "role": "USER",
      • "modules": [
        • "OBJECTS"
        ]
      }
    ],
  • "meta": {
    • "activeObjectsCount": 6,
    • "preparedForApi": true
    }
}

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" … 241 more
Example: "CZ"

Supported country code from CLOUD

CountryCode (string) or null
One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

EMAIL (string) or null
One of
string <email> (EMAIL)

Email address

Description (string) or null
One of
[ 1 .. 255 ] characters
string (Description) [ 1 .. 255 ] characters
object
directArcEnabled
boolean
objectTransferEnabled
boolean
maintainedByJablonet
boolean
simLockEnabled
boolean

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": {
    • "directArcEnabled": true,
    • "objectTransferEnabled": true,
    • "maintainedByJablonet": true,
    • "simLockEnabled": true
    }
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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

Response Schema: application/json
authorizationKey
required
string (AuthorizationKey) = 32 characters
Example: "b0d2f6a2d76a354d3a37f64b8ad08019"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array (>= 0 items)
distributorUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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

RFC 3339 Date and Time with TimeZone offset specification

Response samples

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

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)
Example: "tomas.janda@jablotron.cz"

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

Response Schema: application/json
distributorUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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

RFC 3339 Date and Time with TimeZone offset specification

Request samples

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

Response samples

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

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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]+)$
Example: "ARC_CLOUD:00008808"
customName
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

name
string >= 3 characters
Example: "UP TEST"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Get installer company information

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

Id of installerCompany

Responses

Response Schema: application/json
companyId
required
number (IntId) >= 1

Common Int id

name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
cin
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters
Example: "885255412"

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

affiliateRegistered
boolean

ignored in PATCH, only for admin view

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

companyLogoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "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",
  • "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": {
    • "userLogin": "tomas.janda@jablotron.cz",
    • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
    }
}

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
Example: "885255412"

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

affiliateRegistered
boolean

ignored in PATCH, only for admin view

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

name
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."

Responses

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "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",
  • "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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array (>= 0 items)
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

hasDefaultTemplate
boolean
Default: false

Indicates whether the DIRECT ARC has a default template set

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

Available only for CLOUD ARC

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

Available only for CLOUD ARC

photoVerificationUrlBase
string <uri>
Example: "https://arc-verification.jablotron.cloud/12541/akdsjfhkjs/:objectNumber"
object
required
object (ApiConnection)

Available only for CLOUD ARC, DIRECT ARC has always NONE

mode
required
string
Enum: "API" "JA_ARC" "NONE"
distributorsCount
integer <int32> (Counter) >= 0
Example: "6"
usersCount
integer <int32> (Counter) >= 0
Example: "6"

Response samples

Content type
application/json
[]

Create ARC

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution
Request Body schema: application/json

ARC attributes

countryCode
required
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

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

arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
$type
string
outputPort
integer (OutputPort) [ 1 .. 65535 ]
Example: "30005"

Available only for CLOUD ARC

disabledFunctions
Array of strings (DisabledFunctionsForAdministratorRequest) >= 0 items unique
Items Enum: "REMOTE_CONTROL" "CAMERA_MANAGEMENT" "COMMUNICATION_NUMBER_MODIFICATION" "ARC_TRANSFER_MODIFICATION" "DOWNLOAD_CONFIGURATION" "REGISTRATION"

Optional list of disabled ARC functions. If omitted, the current value is preserved on update and no functions are disabled on create.

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

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

Description (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 255 ] characters
string (Description) [ 1 .. 255 ] characters

null only for PATCH to remove current value

boolean or null

null only for PATCH to remove current value

One of
boolean

null only for PATCH to remove current value

Responses

Response Schema: application/json
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"

Request samples

Content type
application/json
Example
{
  • "$type": "ARC_CLOUD",
  • "countryCode": "CZ",
  • "outputId": "SP1",
  • "driverType": "KROND",
  • "outputPort": 30005,
  • "disabledFunctions": [
    • "REMOTE_CONTROL"
    ],
  • "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 Schema: application/json
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

required
object
required
object
mode
required
string
Enum: "API" "JA_ARC" "NONE"
activeObjectsCount
integer <int32> (Counter) >= 0
Example: "6"
activeCamerasCount
integer <int32> (Counter) >= 0
Example: "6"
autoTransferDisabled
required
boolean
hasDefaultTemplate
boolean
Default: false

Indicates whether the DIRECT ARC has a default template set

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

Available only for CLOUD ARC

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

Available only for CLOUD ARC

photoVerificationUrlBase
string <uri>
Example: "https://arc-verification.jablotron.cloud/12541/akdsjfhkjs/:objectNumber"
outputPort
integer [ 1 .. 65535 ]
Example: "30005"
helpdeskEmail
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

description
string (Description) [ 1 .. 255 ] characters
Example: "Common description of entity up to 255 characters"
disabledFunctions
Array of strings (DisabledFunctions) non-empty unique
Items Enum: "REMOTE_CONTROL" "CAMERA_MANAGEMENT" "COMMUNICATION_NUMBER_MODIFICATION" "ARC_TRANSFER_MODIFICATION" "DOWNLOAD_CONFIGURATION" "REGISTRATION"

Returned only if the ARC has at least one disabled function.

Array of objects (NotificationList)
Array
notificationId
required
integer <int64> (DbId) >= 1
Example: "242566"
targetType
required
string
Value: "EMAIL"
target
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

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" … 15 more
lastUpdate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

lastUpdateUserId
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

Array of objects (DistributorUnderArcListForAdmin) >= 0 items unique
Array (>= 0 items)
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

required
object (ApiConnection)

Available only for CLOUD ARC, DIRECT ARC has always NONE

mode
required
string
Enum: "API" "JA_ARC" "NONE"
activeObjectsCount
required
integer <int32> (Counter) >= 0
Example: "6"
rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

Array of objects (ListOfUsers)
Array
arcUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
lastLoggedDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

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,
  • "disabledFunctions": [
    • "REMOTE_CONTROL"
    ],
  • "notificationContacts": [
    • {
      • "notificationId": 242566,
      • "lastUpdate": "2019-08-24T14:15:22Z",
      • "lastUpdateUserId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
      • "targetType": "EMAIL",
      • "target": "tomas.janda@jablotron.cz",
      • "categories": [
        • "ARC_CONNECTED"
        ],
      • "languageCode": "CS"
      }
    ],
  • "distributors": [
    • {
      • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
      • "name": "Company s.r.o.",
      • "countryCode": "CZ",
      • "rgapCountry": "CZ",
      • "connectedToApi": {
        • "mode": "API"
        },
      • "activeObjectsCount": 6
      }
    ],
  • "users": [
    • {
      • "arcUserId": 242566,
      • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325",
      • "lastLoggedDate": "2019-08-24T14:15:22Z",
      • "userLogin": "tomas.janda@jablotron.cz",
      • "role": "USER"
      }
    ],
  • "meta": {
    • "activeObjectsCount": 6,
    • "activeCamerasCount": 6,
    • "connectedToApi": {
      • "mode": "API"
      }
    }
}

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
Example: "Company s.r.o."
countryCode
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

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
One of
[ 1 .. 65535 ]
integer (OutputPort) [ 1 .. 65535 ]

Available only for CLOUD ARC

OutputId (string) or null
One of
string (OutputId)
Enum: "SP1" "SP2" "SP3" "SP4" "SP5" "SP6" "SP7"

Available only for CLOUD ARC

EMAIL (string) or null
One of
string <email> (EMAIL)

Email address

Description (string) or null
One of
[ 1 .. 255 ] characters
string (Description) [ 1 .. 255 ] characters
autoTransferDisabled
boolean

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

disabledFunctions
Array of strings (DisabledFunctionsForAdministratorRequest) >= 0 items unique
Items Enum: "REMOTE_CONTROL" "CAMERA_MANAGEMENT" "COMMUNICATION_NUMBER_MODIFICATION" "ARC_TRANSFER_MODIFICATION" "DOWNLOAD_CONFIGURATION" "REGISTRATION"

Optional list of disabled ARC functions. If omitted, the current value is preserved on update and no functions are disabled on create.

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,
  • "disabledFunctions": [
    • "REMOTE_CONTROL"
    ]
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array
arcUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
lastLoggedDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

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"
    }
]

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)
Example: "tomas.janda@jablotron.cz"

Email address

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

Responses

Response Schema: application/json
arcUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

role
required
string (UserRole)
Enum: "USER" "ADMINISTRATOR"
lastLoggedDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Get list of RGAP countries

Authorizations:
KongResolverOAuthJCSAdminJCSRoleResolution

Responses

Response Schema: application/json
Array
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

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]+)$
Example: "ARC_DIRECT:9463"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Common

Common resources

Get microservice catalog information

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

Responses

Response Schema: application/json
required
object

Metadata of running MS

name
required
string

Name of MS

description
required
string

Description of MS

owner
required
string

Owner of MS

repositoryUrl
required
string

URL to repository of MS

documentationUrl
string

URL to documentation of MS

tags
Array of strings
Example: [["php","cv1.5"]]

Well-known tags

object

Environment configuration

Array of objects

List of environment variables

Array
name
required
string
Example: "LOGGER_TYPE"
description
string
Example: "TYPE:string;REQUIRED:true;ENUM:CLI|FILE"

Serialized string of "type", "required" and "enum" values, key:value separated with semicolon (;), values separated with pipe sign (|)

Array of objects

List of feature flags

Array
name
required
string
type
required
string
Enum: "boolean" "string" "int" "double"
description
string
required
Array of objects

List of dependencies of running MS

Array
type
required
string
Examples: "resource" "resource:galeraDatabase" "resource:bucket" "microservice"

Type of dependency

name
required
string
Examples: "dev-api-installer-logos" "nekronos-ro" "nekronos-rw" "db.galera" "service.s3"

Name of dependency in Backstage

Response samples

Content type
application/json
{
  • "service": {
    • "name": "string",
    • "description": "string",
    • "owner": "string",
    • "repositoryUrl": "string",
    • "documentationUrl": "string",
    • "tags": [
      • [
        • "php",
        • "cv1.5"
        ]
      ],
    • "environment": {
      • "variables": [
        • {
          • "name": "LOGGER_TYPE",
          • "description": "TYPE:string;REQUIRED:true;ENUM:CLI|FILE"
          }
        ]
      },
    • "featureFlags": [
      • {
        • "name": "string",
        • "description": "string",
        • "type": "boolean"
        }
      ]
    },
  • "dependencies": [
    • {
      • "type": "resource",
      • "name": "dev-api-installer-logos"
      }
    ]
}

Public

Public resources

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.

Request Body schema: application/json

Account registration params

authorizationCode
required
string (IndexaAuthorizationCode) ^[A-F0-9]{16}$
Example: "A1B2C3D4E5F60708"
registrationKey
required
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
loginName
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Register Dial controller and create CLOUD account

Request Body schema: application/json

Registration params

ownerLoginName
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

required
DEVICE_IDENTITY (string) or REGISTRATION_KEY (string)
One of
string (DEVICE_IDENTITY) ^DEVICE_((JACLOUDSN:[A-F\d]{8})|(JASNV1:[\d]{...
serviceName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

Responses

Response Schema: application/json
serviceEntityId
required
string (ServiceEntityId) ^SERVICE_(\w+):([\d]+)$
Example: "SERVICE_JA100F:242566"
objectEntityId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"

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"
}

Distributor

Get allowed device models for object list filter

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

Id of distributor

Responses

Response Schema: application/json
Array (non-empty)
id
required
string (DeviceModel)
Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: "JA107K"
name
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"

Response samples

Content type
application/json
[
  • {
    • "id": "JA101KLAN3G",
    • "name": "JA-101K LAN 3G"
    },
  • {
    • "id": "JA103K",
    • "name": "JA-103K"
    }
]

Get active objects connected to given distributor

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

Id of distributor

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

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

Registration key

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

Device phone number (LIKE)

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

Id of object

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

Name of object (LIKE)

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

ARC object number (EQUAL)

deviceModel[]
Array of strings (DeviceModel) non-empty unique
Items Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: deviceModel[]=JA107K&deviceModel[]=JA103K&deviceModel[]=JA151KRY

Device model

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

Id of distributor installer company (EQUAL)

ArcEntityId (string) or string

Cloud entity id of ARC or NONE for objects without ARC

withLabels[]
Array of strings (ObjectLabels) non-empty
Items Enum: "HISTORIC" "FOR_REVIEW" "UNFINISHED" "NOT_SET" "COMMUNICATION_SMS"
Example: withLabels[]=HISTORIC&withLabels[]=FOR_REVIEW

List of wanted object labels, if HISTORIC is not specified only ACTIVE objects are filtered

Responses

Response Schema: application/json
required
Array of objects (schemas-ListOfObjects) >= 0 items unique
Array (>= 0 items)
required
object (schemas-ObjectListSchema)
objectId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"
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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

required
object
family
required
string (DeviceFamily)
Enum: "ATHOS" "AURA" "AZOR" "CCU" "CU07" "CU07A" "CU08" "FUTURA" "FUTURA2" "GD04K" … 13 more
Example: "JA100F"
model
required
string (DeviceModel)
Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: "JA107K"
officialName
required
string (DeviceModelOfficialName)
Example: "JA-101K LAN 3G"
registrationKey
string (RegistrationKey) ^([0-9A-HJKMNP-Za-hjkmnp-z]{5}-[0-9A-HJKMNP-Z...
Example: "LAS6D-U2VBG-UHX65"
object (DeviceSimCard)
phoneNumber
required
string (PhoneNumber) ^\+[\d]{5,19}$
Example: "+420739259931"

Internation phone number with + prefix

simCardId
required
string (SimCardEntityId) ^SIM_(CUSTOMER|DISTRIBUTOR|SDC):([0-9(a-f|A-F...
Example: "SIM_SDC:46c41735-c931-4bf0-a03a-f39275beea8"
registrationDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

configurationDownloadDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

configurationSetDate
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

name
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

required
object (ObjectMeta)
allowedActions
required
Array of strings (AllowedObjectActions) non-empty unique
Items Enum: "SETTING" "RESET" "CONFIGURATION_DOWNLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "DEACTIVATE_OBJECT" "SDC_LOG"

List of allowed actions for object

arcObjectNumber
string (ObjectNumber) ^[\dA-F]{4,8}$
Example: "F13D"
object (Arc)
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
object (DistributorInstaller)
distributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
object
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

labels
Array of strings (ObjectLabels) non-empty unique
Items Enum: "HISTORIC" "FOR_REVIEW" "UNFINISHED" "NOT_SET" "COMMUNICATION_SMS"
cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "objectId": "OBJECT_JA100F:242566",
        • "timeZone": "Europe/Prague",
        • "name": "My House",
        • "arcObjectNumber": "F13D",
        • "arc": {
          • "arcId": "ARC_CLOUD:00008808",
          • "name": "Company s.r.o."
          },
        • "installer": {
          • "distributorInstallerId": 242566,
          • "name": "Company s.r.o."
          },
        • "owner": {
          • "userLogin": "tomas.janda@jablotron.cz"
          },
        • "device": {
          • "registrationKey": "LAS6D-U2VBG-UHX65",
          • "family": "JA100F",
          • "model": "JA107K",
          • "officialName": "JA-101K LAN 3G",
          • "sim": {
            • "phoneNumber": "+420739259931",
            • "simCardId": "SIM_SDC:46c41735-c931-4bf0-a03a-f39275beea8"
            },
          • "registrationDate": "2019-08-24T14:15:22Z",
          • "configurationDownloadDate": "2019-08-24T14:15:22Z",
          • "configurationSetDate": "2019-08-24T14:15:22Z"
          },
        • "labels": [
          • "HISTORIC"
          ],
        • "meta": {
          • "allowedActions": [
            • "SETTING"
            ]
          }
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

Export objects connected to given distributor

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

Id of distributor

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

Registration key

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

Device phone number (LIKE)

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

Id of object

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

Name of object (LIKE)

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

ARC object number (EQUAL)

deviceModel[]
Array of strings (DeviceModel) non-empty unique
Items Enum: "AURA" "AZ10K" "CA1802" "CA1803BT" "CA2103" "CU07" "CU07A" "CU08" "CU08A" "FUTURA" … 29 more
Example: deviceModel[]=JA107K&deviceModel[]=JA103K&deviceModel[]=JA151KRY

Device model

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

Id of distributor installer company (EQUAL)

ArcEntityId (string) or string

Cloud entity id of ARC or NONE for objects without ARC

withLabels[]
Array of strings (ObjectLabels) non-empty
Items Enum: "HISTORIC" "FOR_REVIEW" "UNFINISHED" "NOT_SET" "COMMUNICATION_SMS"
Example: withLabels[]=HISTORIC&withLabels[]=FOR_REVIEW

List of wanted object labels, if HISTORIC is not specified only ACTIVE objects are filtered

Responses

Response Schema: application/json
csv
required
string <base64> <application/csv>

Response samples

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

Update bulk objects attributes

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

Id of distributor

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

objectReviewState
string
Enum: "REVIEWED" "FOR_REVIEW"

Responses

Response Schema: application/json
objectReviewStateUpdateCount
integer <int32> >= 0

Request samples

Content type
application/json
{
  • "objectReviewState": "REVIEWED"
}

Response samples

Content type
application/json
{
  • "objectReviewStateUpdateCount": 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: "RECONFIGURATION"

Responses

Response Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

Request samples

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

Response samples

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

Deactivate an object

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

Cloud entity id of Object

query Parameters
confirmSubscriptionCancellation
boolean
Default: false

Confirm subscription cancellation when deactivating.

If it is not provided or is false, error 422 is returned when checking for active subscriptions on the object

If it is not sent, it behaves as if it were false

forceDeactivation
boolean
Default: false

Force deactivation when a reset device has failed

If true is returned and the device reset fails, the device will still be deactivated, but the object ID will not be released and the CLOUD device code will not be reset.

If it is not sent, it behaves as if it were false

Responses

Response Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

Response samples

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

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 Schema: application/json
required
Array of objects (ListOfObjectLogs) >= 0 items unique
Array (>= 0 items)
required
object
actionLogId
required
number (IntId) >= 1

Common Int id

actionType
required
string^[A-Z_]+$
Example: "CONFIGURATION_DOWNLOAD_REQUEST"

Specific action of the object, the list of items can grow, therefore it is not as enum

logDate
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

actionNameTk
required
string
Example: "ObjectLog:Registration key modify"

Action log name translation key

object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "actionLogId": 1,
        • "actionType": "CONFIGURATION_DOWNLOAD_REQUEST",
        • "actionNameTk": "ObjectLog:Registration key modify",
        • "logDate": "2019-08-24T14:15:22Z",
        • "user": {
          • "userLogin": "tomas.janda@jablotron.cz",
          • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
          }
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

Get distributor companies for logged user

Authorizations:
KongResolverOAuthJCS

Responses

Response Schema: application/json
Array (non-empty)
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

required
object
role
required
string (DistributorRole)
Enum: "USER" "ADMINISTRATOR"
modules
required
Array of strings (DistributorModules) >= 0 items unique
Items Enum: "OBJECTS" "INSTALLER_COMPANIES" "SETTINGS" "JA_PAY" "SN_LANG" "HELPDESK"
rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

Response samples

Content type
application/json
[
  • {
    • "distributorId": "DISTRIBUTOR_DEFAULT:0012",
    • "name": "Company s.r.o.",
    • "countryCode": "CZ",
    • "rgapCountry": "CZ",
    • "me": {
      • "role": "USER",
      • "modules": [
        • "OBJECTS"
        ]
      }
    }
]

Get ARC list for objects module

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

Id of distributor

Responses

Response Schema: application/json
Array (>= 0 items)
arcId
required
string (ArcEntityId) ^ARC_(CLOUD|DIRECT):([\d]+)$
Example: "ARC_CLOUD:00008808"
arcType
required
string (ArcType)
Enum: "CLOUD" "DIRECT"
Example: "CLOUD"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
objectCount
required
integer <int32> (Counter) >= 0
Example: "6"

Response samples

Content type
application/json
[
  • {
    • "arcId": "ARC_CLOUD:00008808",
    • "arcType": "CLOUD",
    • "name": "Company s.r.o.",
    • "objectCount": 6
    }
]

Get an installer company list with at least one active object

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

Id of distributor

search
string non-empty

Fulltext search in supported fields based on resource

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 Schema: application/json
required
Array of objects (DistributorInstallerCompaniesWithActiveObjects) >= 0 items unique
Array (>= 0 items)
required
object (InstallerCompanyWithOwner)
companyId
required
number >= 1

Common Int id

name
required
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters
Example: "Company s.r.o."
required
object
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

distributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"
required
object
objectsCount
required
integer <int32> (Counter) >= 0
Example: "6"
cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "companyId": 1,
        • "name": "Company s.r.o.",
        • "ownerAccount": {
          • "userLogin": "tomas.janda@jablotron.cz"
          },
        • "distributorInstallerId": 242566,
        • "meta": {
          • "objectsCount": 6
          }
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

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 Schema: application/json
distributorId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
countryCode
required
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

affiliateRegistered
required
boolean (InstallerAffiliate)

Company is registered in affiliate

required
object
role
required
string (DistributorRole)
Enum: "USER" "ADMINISTRATOR"
modules
required
Array of strings (DistributorModules) >= 0 items unique
Items Enum: "OBJECTS" "INSTALLER_COMPANIES" "SETTINGS" "JA_PAY" "SN_LANG" "HELPDESK"
rgapCountry
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more
Example: "CZ"

Supported country code from CLOUD

COMPANY_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

companyLogoUrl
string <uri> (AttachmentUri)
Example: "https://img-cdn.jablonet.net/1635490678/65FA0685F2F38?X-Amz-Date=20211029T063758Z&X-Amz-Expires=1200"

URL for downloading the attachment with parameters X-Amz-Date and X-Amz-Expires

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": {
    • "role": "USER",
    • "modules": [
      • "OBJECTS"
      ]
    }
}

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

One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

Iban (string) or null

null only for PATCH to remove current value

One of
[ 15 .. 34 ] characters
string (Iban) [ 15 .. 34 ] characters ^[A-Z]{2}[\dA-Z\s]+$

Company IBAN, in human or machine format, returned always in machine

vatPayer
boolean (VatPayer)

Company is payer of VAT

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

SwiftCode (string) or null

null only for PATCH to remove current value

One of
string (SwiftCode) ^[A-Z]{4}([A-Z]{2})[A-Z\d]{2}(:?[A-Z\d]{3})?$...

null only for PATCH to remove current value

BANK_ACCOUNT_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 8 .. 30 ] characters
string (BANK_ACCOUNT_NUMBER) [ 8 .. 30 ] characters

null only for PATCH to remove current value

NAME_OF_SUBJECT (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 70 ] characters
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters

null only for PATCH to remove current value

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

CountryCode (string) or null

null only for PATCH to remove current value

One of
string (CountryCode)
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AQ" … 241 more

Supported country code from CLOUD

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

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

One of
string <byte> (LogoData)

Binary logo encoded in base64 string (used for upload/change)

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

name
string >= 3 characters
Example: "UP TEST"

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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 Schema: application/json
Array (>= 0 items)
distributorUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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

RFC 3339 Date and Time with TimeZone offset specification

Response samples

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

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)
Example: "tomas.janda@jablotron.cz"

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

Response Schema: application/json
distributorUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

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

RFC 3339 Date and Time with TimeZone offset specification

Request samples

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

Response samples

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

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": [
    • "OBJECTS"
    ]
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Get distributor customer forms definitions

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

Cloud entity id of distributor

Responses

Response Schema: application/json
Array (non-empty)
type
required
string
Enum: "ALARM_BUILDING" "ALARM_CAR" "HVAC"
required
Array of objects
Array
translationKey
required
string
Example: "SecuritySystem:Control panel"

Localization key used as a field label in UI.

required
Array of objects non-empty
Array (non-empty)
id
required
integer <int64> (DistributorAttributeSettingId) >= 1
Example: "242566"

Unique identifier of attribute definition for this distributor and segment type

translationKey
required
string
Example: "SecuritySystem:Control panel"

Localization key used as a field label in UI.

defaultBehavior
required
string (FormSettingBehavior)
Enum: "REQUIRED" "OPTIONAL" "HIDDEN"

Default behavior for attribute value.

canBeOverwrite
required
boolean
distributorBehavior
string (FormSettingBehavior)
Enum: "REQUIRED" "OPTIONAL" "HIDDEN"

Default behavior for attribute value.

dependsOn
integer <int64> (DistributorAttributeSettingId) >= 1
Example: "242566"

Unique identifier of attribute definition for this distributor and segment type

Response samples

Content type
application/json
[
  • {
    • "type": "ALARM_BUILDING",
    • "groups": [
      • {
        • "translationKey": "JAPARTNER:Customer type",
        • "dependsOn": 242566,
        • "attributes": [
          • {
            • "id": 242566,
            • "translationKey": "JAPARTNER:Customer type",
            • "defaultBehavior": "REQUIRED",
            • "distributorBehavior": "REQUIRED",
            • "canBeOverwrite": true
            }
          ]
        }
      ]
    }
]

Update distributor customer form settings

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

Wanted behavior

Array (non-empty)
id
required
integer <int64> (DistributorAttributeSettingId) >= 1
Example: "242566"

Unique identifier of attribute definition for this distributor and segment type

behavior
required
string (FormSettingBehavior)
Enum: "REQUIRED" "OPTIONAL" "HIDDEN"

Default behavior for attribute value.

Responses

Request samples

Content type
application/json
[
  • {
    • "id": 242566,
    • "behavior": "REQUIRED"
    }
]

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Create installer company under distributor

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

Installer company attributes

cin
required
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters
Example: "885255412"

Company identification number

ownerLoginName
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

Responses

Response Schema: application/json
distributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "ownerLoginName": "tomas.janda@jablotron.cz",
  • "name": "Company s.r.o."
}

Response samples

Content type
application/json
{
  • "distributorInstallerId": 242566,
  • "name": "Company s.r.o."
}

Get information about given login and related installer companies

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

Cloud entity id of distributor

loginName
required
string <email> (EMAIL)
Example: tomas.janda@jablotron.cz

Login name of cloud user account

Responses

Response Schema: application/json
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

Array of objects (DistributorInstallerCompanyByLoginCompany) non-empty

Companies where given loginName already participates (owner/member).

Array (non-empty)
installerCompanyId
required
integer <int64> (DbId) >= 1
Example: "242566"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
required
COMPANY_IDENTIFICATION_NUMBER (string) or null
One of
[ 3 .. 32 ] characters
string (COMPANY_IDENTIFICATION_NUMBER) [ 3 .. 32 ] characters

Company identification number

role
required
string (InstallerRole)
Enum: "INSTALLER" "ADMIN" "GROUP_ADMIN" "OWNER"
object (DistributorInstallerCompanyByLoginDistributor)
distributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"
name
required
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."
cin
required
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters
Example: "885255412"

Company identification number

Response samples

Content type
application/json
{
  • "userAccount": {
    • "userLogin": "tomas.janda@jablotron.cz",
    • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
    },
  • "companies": [
    • {
      • "installerCompanyId": 242566,
      • "name": "Company s.r.o.",
      • "cin": "885255412",
      • "role": "INSTALLER",
      • "distributor": {
        • "distributorInstallerId": 242566,
        • "name": "Company s.r.o.",
        • "cin": "885255412"
        }
      }
    ]
}

Get detail of an installer company

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

Cloud entity id of distributor

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

Id of distributor installer company

Responses

Response Schema: application/json
cin
required
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters
Example: "885255412"

Company identification number

name
required
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters
Example: "Company s.r.o."
required
object
objectsCount
required
integer <int32> (Counter) >= 0
Example: "6"
deletionBlockedReason
Array of strings non-empty unique
Items Value: "ACTIVE_OBJECTS"
companyId
required
number >= 1

Common Int id

distributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"
required
Array of objects (DistributorInstallerCompanyMembers) non-empty

List of members of the company

Array (non-empty)
installerUserId
required
integer <int64> (DbId) >= 1
Example: "242566"
role
required
string (InstallerRole)
Enum: "INSTALLER" "ADMIN" "GROUP_ADMIN" "OWNER"
required
object (UserAccountDetail)

Common object of cloud user detail

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

trainings
required
Array of strings (Trainings) >= 0 items unique
Items Enum: "ZK1" "ZKM" "ZK2"

List of installer's completed trainings

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "Company s.r.o.",
  • "distributorInstallerId": 242566,
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "meta": {
    • "objectsCount": 6,
    • "deletionBlockedReason": [
      • "ACTIVE_OBJECTS"
      ]
    },
  • "members": [
    • {
      • "installerUserId": 242566,
      • "role": "INSTALLER",
      • "memberAccount": {
        • "userLogin": "tomas.janda@jablotron.cz",
        • "userId": "USER_<OEM_JABLOTRON:Jablotron>:52325"
        },
      • "trainings": [
        • "ZK1"
        ]
      }
    ]
}

Update an installer company

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

Cloud entity id of distributor

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

Id of distributor installer company

Request Body schema: application/json
non-empty
cin
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters
Example: "885255412"

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

name
string (CommonCompanyName) [ 1 .. 70 ] characters
Example: "Company s.r.o."

Responses

Request samples

Content type
application/json
{
  • "cin": "885255412",
  • "tin": "CZ885255412",
  • "street": "Pod Houbou 15",
  • "city": "Jablonec nad Nisou",
  • "zip": "466 01",
  • "phoneNumber": "+420739259931",
  • "email": "tomas.janda@jablotron.cz",
  • "name": "Company s.r.o."
}

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Delete installer company from distributor

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

Cloud entity id of distributor

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

Id of distributor installer company

Responses

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Change owner of installer company

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

Cloud entity id of distributor

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

Id of distributor installer company

Request Body schema: application/json

Company information

userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

keepCurrentOwnerInCompany
required
boolean
Default: true

If true, current owner will be kept in the company with role INSTALLER

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Get an installer company list

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

Id of distributor

search
string non-empty

Fulltext search in supported fields based on resource

loginName
string <email> (EMAIL)
Example: loginName=tomas.janda@jablotron.cz

Login name of cloud user account (equal)

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

orderBy
string
Enum: "ACTIVE_OBJECTS" "NAME" "IDENTIFICATION" "CREATED"

Order by field

direction
string
Enum: "ASC" "DESC"

Order direction

Responses

Response Schema: application/json
required
Array of objects (DistributorInstallerCompanies) >= 0 items unique
Array (>= 0 items)
required
object (InstallerCompanyWithOwner)
companyId
required
number >= 1

Common Int id

name
required
string (NAME_OF_SUBJECT) [ 1 .. 70 ] characters
Example: "Company s.r.o."
required
object
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

distributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"
required
object
objectsCount
required
integer <int32> (Counter) >= 0
Example: "6"
installersCount
required
integer <int32> (Counter) >= 0
Example: "6"
deletionBlockedReason
Array of strings non-empty unique
Items Value: "ACTIVE_OBJECTS"
cin
string (CompanyIdentificationNumber) [ 3 .. 32 ] characters
Example: "885255412"

Company identification number

TAX_IDENTIFICATION_NUMBER (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 18 ] characters
string (TAX_IDENTIFICATION_NUMBER) [ 3 .. 18 ] characters

Company tax identification number

STREET (string) or null

null only for PATCH to remove current value

One of
[ 3 .. 64 ] characters
string (STREET) [ 3 .. 64 ] characters

Company street

CITY (string) or null

null only for PATCH to remove current value

One of
[ 1 .. 64 ] characters
string (CITY) [ 1 .. 64 ] characters

Company city

ZIP (string) or null

null only for PATCH to remove current value

One of
string (ZIP) ^[\d A-Z\-]{4,10}$

Company zip code

PHONE_NUMBER (string) or null

null only for PATCH to remove current value

One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

EMAIL (string) or null

null only for PATCH to remove current value

One of
string <email> (EMAIL)

Email address

cursor
required
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

required
object
hasNextPage
boolean
hasPreviousPage
boolean
startCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

endCursor
string (Cursor)
Example: "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"

Cursor value used together with limit in query request params as first=limit&after=cursorValue and last=limit&before=cursorValue

Response samples

Content type
application/json
{
  • "items": [
    • {
      • "node": {
        • "companyId": 1,
        • "name": "Company s.r.o.",
        • "ownerAccount": {
          • "userLogin": "tomas.janda@jablotron.cz"
          },
        • "distributorInstallerId": 242566,
        • "cin": "885255412",
        • "tin": "CZ885255412",
        • "street": "Pod Houbou 15",
        • "city": "Jablonec nad Nisou",
        • "zip": "466 01",
        • "phoneNumber": "+420739259931",
        • "email": "tomas.janda@jablotron.cz",
        • "meta": {
          • "objectsCount": 6,
          • "installersCount": 6,
          • "deletionBlockedReason": [
            • "ACTIVE_OBJECTS"
            ]
          }
        },
      • "cursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
      }
    ],
  • "pageInfo": {
    • "hasNextPage": true,
    • "hasPreviousPage": true,
    • "startCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd",
    • "endCursor": "WyIyMDIxLTA4LTIxVDIxOjQ1OjM2WiJd"
    }
}

Get an CSV export of installer companies

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

Id of distributor

search
string non-empty

Fulltext search in supported fields based on resource

loginName
string <email> (EMAIL)
Example: loginName=tomas.janda@jablotron.cz

Login name of cloud user account (equal)

orderBy
string
Enum: "ACTIVE_OBJECTS" "NAME" "IDENTIFICATION" "CREATED"

Order by field

direction
string
Enum: "ASC" "DESC"

Order direction

Responses

Response Schema: application/json
csv
required
string <base64> <application/csv>

Response samples

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

Transfer installer company

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Installer company attributes

sourceDistributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"
targetDistributorInstallerId
required
integer <int64> (DbId) >= 1
Example: "242566"

Responses

Response Schema: application/json
objects
required
integer <int32> (Counter) >= 0
Example: "6"

Number of transferred objects

Request samples

Content type
application/json
{
  • "sourceDistributorInstallerId": 242566,
  • "targetDistributorInstallerId": 242566
}

Response samples

Content type
application/json
{
  • "objects": 6
}

Update installer's completed trainings

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

Cloud entity id of distributor

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

Id of distributor installer company

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

Entity id of wanted CLOUD user

Request Body schema: application/json
Array (>= 0 items)
string (Training)
Enum: "ZK1" "ZKM" "ZK2"

Installer training type

Responses

Request samples

Content type
application/json
[
  • "ZK1"
]

Response samples

Content type
application/json
{
  • "errorId": "2b826f5a-d0ff-4764-a007-350fffd5bbdc",
  • "httpCode": 200,
  • "errors": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Get logged user information

Authorizations:
KongResolverOAuthJCS

Responses

Response Schema: application/json
non-empty
userLogin
required
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

userId
required
string (CloudUserEntity) ^USER_<OEM_([A-Z]+):([a-zA-Z\d]+)>:(\d+)$
Example: "USER_<OEM_JABLOTRON:Jablotron>:52325"

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

PHONE_NUMBER (string) or null
One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

NAME_AND_SURNAME (string) or null
One of
[ 1 .. 70 ] characters
string (NAME_AND_SURNAME) [ 1 .. 70 ] characters

Name of a person, each part of name must be maximal 30 characters long

newsletterAllowed
boolean

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
One of
string (PHONE_NUMBER) ^\+[\d]{5,19}$

Internation phone number with + prefix

NAME_AND_SURNAME (string) or null
One of
[ 1 .. 70 ] characters
string (NAME_AND_SURNAME) [ 1 .. 70 ] characters

Name of a person, each part of name must be maximal 30 characters long

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": [
    • {
      • "code": "UNAUTHENTICATED.TOKEN_EXPIRED",
      • "message": "You are not allowed to control area \"Hall\".",
      • "debug": "User is not allowed to arm security system section.",
      • "context": "Some information for better debugging",
      • "stack": [
        • "ValidationError: Parameters validation failed at <anonymous>"
        ]
      }
    ]
}

Reserve device registration for distributor

Authorizations:
KongResolverOAuthJCS
Request Body schema: application/json

Reservation params

distributorEntityId
required
string (DistributorId) ^DISTRIBUTOR_DEFAULT:(\d{4})$
Example: "DISTRIBUTOR_DEFAULT:0012"
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)
Any of
string (DEVICE_IDENTITY) ^DEVICE_((JACLOUDSN:[A-F\d]{8})|(JASNV1:[\d]{...
objectName
required
string (ObjectOrServiceName) [ 1 .. 64 ] characters
Example: "My House"

Name of object or service

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

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" … 409 more
Example: "Europe/Prague"

IANA timezone definition

Responses

Response Schema: application/json
objectEntityId
required
string (ObjectEntityId) ^OBJECT_(\w+):([\d]+)$
Example: "OBJECT_JA100F:242566"

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"
}

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 Schema: application/json
requestId
required
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

state
required
string (ProcessState)
Enum: "CREATED" "IN_PROGRESS" "COMPLETED"
type
required
string (ProcessType)
Enum: "SETTING" "RESET" "CONFIGURATION" "CONFIGURATION_DOWNLOAD" "CONFIGURATION_UPLOAD" "ROAMING_ACTIVATE" "ROAMING_DEACTIVATE" "TRACKING_START" "GSM_RESTART" "SYNC_STATES" … 4 more

CONFIGURATION is deprecated, use CONFIGURATION_DOWNLOAD instead

createdAt
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

scheduledAt
string <date-time> (DateTime)

Only available for CREATED status

completedAt
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

success
boolean
Default: true

Only available for completed status

object

Only available for non-success status

code
required
string (ProcessErrorType)
Enum: "CANCELED_BY_OTHER_PROCESS" "BAD_REQUEST" "UNAUTHORIZED" "NOT_FOUND" "NOT_ACCEPTABLE" "TIMEOUT" "CONFLICT" "UNUSABLE_SIM_CARD" "UNPROCESSABLE" "PROCESS_TIMEOUT" … 3 more
debugMessage
string non-empty
Example: "Cannot connect to device via YTUN"
object non-empty
userName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originUserName
string <email> (Email)
Example: "tomas.janda@jablotron.cz"

Email address

originRequestId
string (DeviceRequestId) >= 5 characters
Example: "DCD-1254445521"

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

remainingAttempts
integer >= 0

Returns only for unfinished requests and tells how many attempts (including the currently running one) remain.

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": {
    • "code": "CANCELED_BY_OTHER_PROCESS",
    • "debugMessage": "Cannot connect to device via YTUN"
    },
  • "meta": {
    • "userName": "tomas.janda@jablotron.cz",
    • "originUserName": "tomas.janda@jablotron.cz",
    • "originRequestId": "DCD-1254445521",
    • "remainingAttempts": 0
    }
}

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 Schema: application/json
dateTime
required
string <date-time> (DateTime)

RFC 3339 Date and Time with TimeZone offset specification

id
required
integer <int64>
Example: "35562"
email
string <email>
Example: "tomas.janda@jablotron.cz"

Response samples

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