Introduction

What is PubSub?

Publish/subscribe messaging, is a form of asynchronous machine-2-machine (M2M) communication that can be used in event driven domains.

The main elements in a pub/sub messaging model are:

topics: identify an actual communication channel
messages: the content that is transmitted on a topic
publishers: generate and publish messages to a topic
subscribers: subscribe to a topic to receive messages
broker: brings publishers and subscribers together by providing the mechanism for receiving messages from publishers and forwarding messages to subscribers for the respective topics.
clients: are applications that connect to brokers and can be publishers and/or subscribers.

Any message published to a topic is immediately received by all of the subscribers to the topic. A publisher doesn't need to know who is going to receive the messages that are sent and the subscribers don't know or need to know who sent the message.

The Pub/sub model allows a loose coupling between client applications in order to increase performance, reliability and scalability.

Intro PubSub

This Documentation was generated by asyncapi v.2.0. The corresponding yaml file can be found here

Xesar 3 PubSub Interface

Xesar 3 comes with a broker and the backend publishes and subscribes various topics. A summary of these topics is presented in the following tables:

Topic	What	Description	XS3 Server is	Session
xs3/1/ces/{EventName}	System Events	Emits system events that are generated by commands from the interfaces (M2M or Human UI)	Publisher	NOT required
xs3/1/ase	Access Control System Events	Emits access control system events that are generated by the EVVA access control components when they are collected by the system through the maintenance or the virtual network.	Publisher	NOT required
xs3/1/cmd/{CommandName}	Command Requests	Receives commands to enable uses cases on the M2M interface	Subscriber	Required
xs3/1/q	Query Requests	Receives queries for data collected in the system.	Subscriber	Required
xs3/1/{User ID}/q	Query Results	Emits answers to previously received queries.	Publisher	Required
xs3/1/{User ID}/err		Emits errors for previously received queries or commands.	Publisher	Required

Xesar 3 Events

Xesar 3 will emit two different types of events:

System Events: these events are caused by the administration of the system through the human and M2M interfaces. This is also called jorna.
Access Protocol Events: these events are registered at EVVA components and collected by maintenance and virtual network.

PubSub Events

Connections

Xesar 3 is an access control system, thus security is relevant in all aspects of the system. All clients have to provide authentication and authorization for operations that request data or change the system state.

In order to establish a connection to the included broker, each client requires a certificate for unique identification and authentication. The package with the certificate can be obtained through the user interface.

PubSub Session PubSub Session End

The broker address is included in the downloaded package, the corresponding port will depend on your system setup, the default TLS port is 1883.

You will need to handle two key=value pairs on your own:

username={Your username}
password={Your user's password}

Session

Each client is bound to a specific user and the user can have authorizations through the groups with their respective permissions. Given that the broker does not know about the XS3 Server Client per design, authorization requires a session for the user.

Topic	What	Description	XS3 Server is	Session
xs3/1/cmd/Login	Login requests	Receives a login to establish a session	Subscriber	NOT required
xs3/1/{User ID}/LoggedIn	Login response	Emits session information upon successful login	Publisher	Required
xs3/1/cmd/Logout	Logout requests	Receives a logout command with a session token	Publisher	Required
xs3/1/ces/LoggedOut	Logout responses	Emits logout events happening in the system	Publisher	NOT Required

To establish a session a client connects to the broker and publishes a login message. If successful a session token is returned; if not, a system event is issued to notify about an authorized login attempt. The latter allows to observe the system and allows to take defensive security measures.

To end a session a client sends a logout command. If the logout is successful, a corresponding system event is issued.

Access Protocol Events

All access protocol events are issued to a topic with the p$refix xs3/1/ase. To allow easier handling, the events are additionally bundled into groups. Thus they can be subscribed separately or by groups. Subscriptions can be simplified by using single level (+) or multi-level (#) wildcard subscriptions. Please note, that the delivery of these event may happen with quite a delay (because events are picked up over time through maintenance tasks and identification media providing a virtual network).

The following table lists interesting events in the access control system:

Event Name	Event Number (Hex)	Event Number (Dec)	Group
NORMAL_OPENING	0x0001	1	MediumEvents
EMERGENCY_OPENING	0x0002	2	MediumEvents
MANUAL_OPENING_STARTED	0x0003	3	MediumEvents
MANUAL_OPENING_FINISHED	0x0004	4	MediumEvents
MEDIA_RESTRICTED	0x0005	5	MediumEvents
PROLONGED_NORMAL_OPENING	0x0007	7	MediumEvents
PROLONGED_MASTER_KEY_OPENING	0x0008	8	MediumEvents
OPENING_MASTER_KEY_IGNORED_BLACKLIST	0x0009	9	MediumEvents
OPENING_MASTER_KEY_PROLONGED_IGNORED_BLACKLIST	0x000A	10	MediumEvents
KILL_MEDIUM	0x0401	1025	MediumEvents
TIMED_OPENING_STARTED	0x0101	257	EvvaComponent
TIMED_OPENING_FINISHED	0x0102	258	EvvaComponent
TIMED_OPENING_SKIPPED	0x0103	259	EvvaComponent
TIME_CHANGE_EXECUTED	0x0201	513	EvvaComponent
BATTERY_EMPTY	0x0B01	2817	EvvaComponent
FW_UPDATE_PERFORMED	0x0501	1281	MaintenanceComponent
PANIC_EXIT	0x0A01	2561	MaintenanceComponent
RTC_ERROR	0x0A02	2562	MaintenanceComponent
RTC_OFFSET	0xAB03	43779	AdministrationComponent

Queries

The interface allows to query information from the server.

It provides following resources and requires the given permissions:

Ressource	Description	Item Permission	List Permission
identification-media	Provides data for identification media	ViewMedium	ViewAllIdentificationMedia
authorization-profiles	Provides data for authorization profiles	ViewAuthorizationProfile	ViewAllAuthorizationProfiles
access-protocol	Provides access protocol entries	ViewAccessProtocol	ViewAccessProtocol
persons	Provides data for people (holders of identification media)	ViewAllPersons	ViewAllPersons
installation-points	Provides data for installation-points	ViewInstallationPoint	ViewAllInstallationPoints
zones	Provides data for zones (sets of installation points)	ViewZone	ViewAllZones
evva-components	Provides data for components	ViewInstallationPoint	ViewAllInstallationPoints
calendars	Provides data for calendars in the system	ViewCalendar	ViewAllCalendars
office-modes	Provides data for office-mode configuration	ViewAllOfficeModes	ViewAllOfficeModes
time-profiles	Provides data for time profile configuration	ViewTimeProfile	ViewAllTimeProfiles

Publishing queries

To publish a query use the topic:

xs3/1/q

Following example shows the fields to be set for a valid query request (publish):

{
    "requestId": "dbb19a4e-7b8a-4339-b14d-843b4c9a67f3",
    "token": "2610b015-4085-4b0e-a192-cc4c40442e84",
    "resource": "installation-points",
    "id": "1657d066-3cb0-4925-8c7d-7b7deba40a1f",
    "params": null
}

requestId: is used as a $reference value and is given in the returned query response so that the client can build a relation between a query request and the resulting response. This field is required. The requestId must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier). Please consult the documentation of your development language as UUID support is available in all major programming languages.
token: Required. This is the login token you receive after logging in via the LoginCommand. This is also a valid UUID.
resource: Required. The name of the entity you want to query (e.g. 'persons').
id: Optional. The id of a specific entity. This is again a valid UUID. If specified you get a single entity, otherwise you receive the list of all entities.
params: Optional. The api query parameters (see below)

Api query parameter

Structure of the optional params field. Example to get insecure installation points.

{
    "pageOffset": 0,
    "pageLimit": 50,
    "sort": "name",
    "language": "de",
    "filters": [{
       "type": eq
        "field": secure;
        "value": false;
    }]
}

Receiving the entity or list of entities

Api query response

After a query was successfully received, one of two situations can occur. A success is confirmed by publishing a query response to the query response topic:

xs3/1/<userId>/q

In case of an error, an error message is published to the error topic:

xs3/1/err/<userId>

The api query response structure is as follows:

{
    "requestId": "dbb19a4e-7b8a-4339-b14d-843b4c9a67f3",
    "response": {},
}

requestId: The above mentioned $reference value for the query.
response: The queried entity. Either a single entity (e.g. an installation point) or a list of entities (e.g. all installation points).

Response structure when querying a list:

{
    "data": [],
    "filterCount": 23,
    "totalCount": 50,
}

data: A list of single entities (see below).
filterCount: The count of entities, which matched the specified filters.
totalCount: The total count of entities.

Example for a single entity:

{
   "id": "e65c5393-5493-45ac-948f-7a485fcf4493"
   "name": "A Einbauort"
   "description": "Haupteingang"
   "accessId": 10
   "componentType": "Handle"
   "installationId": "A Einbauort"
   "installationType": ""
   ...
}

Given that the system may hold a huge number of entries, there are two mechanisms that can be used to handle them:

a paging mechanism that allows to obtain batches of entries
a filter mechanism that allows to filter results at server side

These two mechanisms can and should be combined as necessary.

Paging

This mechanism can be triggered by the specification of query parameters with a pageOffset and a pageLimit key:value pair. For easier handling, the recommended way is to retrieve a single entry, inspect the filterCount and then retrieve the corresponding amount of pages gradually.

Filtering

Queries can be made with a params object that contains a filter.

Query with Filters example

PUB: xs3/1/524e50d2-f54c-43d9-87cd-2e925c885d9f/q

{
    "requestId":"b57952fc-c167-4338-bc31-564ff5575a57",
    "token":"JDJhJDEwJGZ4RWpXM3liS1QuUVhadGF0b3ZzenVMaWthNVR1U0FzUnU1bnhuckNWZzNDSnMwSVF2U0dL",
    "resource":"access-protocol",
    "params": {
        "pageOffset":0,
        "pageLimit":50,
        "filters":[
            {
                "type":"eq",
                "field":"eventType",
                "value":"BATTERY_EMPTY"
            }
        ]
    }
}

Journal Filters

Journal Filter example

{
  "type":"eq",
  "field":"category",
  "value":"installationPoints"
}

Filter by	Field name	Filter type(s)
Entry Category	category	eq
User	userName	contains
Action	actionType	eq
Date, since	createdAt	gte

Category Values
installationPoints
officeModes
identificationMedia
keycredits
persons
calendars
timeProfiles
authorizationProfiles
maintenanceComponents
codingStations
zones
users
userGroups
partitions

Action Values
create
update
delete

Date Value
YYYY-MM-DD

Access Protocol Filters

Filter by	Field name	Filter type(s)
Date (from, to)	timestampUtc	custom
Event Group	groupOfEvent	eq
Event Type	eventType	eq
Person	person	like
Installation Point Name	installationPointName	like
Installation Point ID	installationPointIdentifier	like
Identification Medium Label	identificationMediumLabel	like
Zone Identifiers	zoneIds	contains
Access Point

Date Value	Filters
YYYY-MM-DD	Entries from date
;YYYY-MM-DD	Entries to date
YYYY-MM-DD;YYYY-MM-DD	Entries from first date to second date

Event Group Values
MediumEvents
EvvaComponent
MaintenanceComponent
AdministrationComponent

Event Type Values	Event Group
OPENING_NORMAL	MediumEvents
OPENING_EMERGENCY	MediumEvents
MANUAL_OPENING_STARTED	MediumEvents
MANUAL_OPENING_FINISHED	MediumEvents
MEDIUM_RESTRICTED	MediumEvents
OPENING_NORMAL_PROLONGED	MediumEvents
OPENING_EMERGENCY_PROLONGED	MediumEvents
OPENING_EMERGENCY_INVALID_BLACKLIST_OR_TIME	MediumEvents
OPENING_EMERGENCY_PROLONGED_INVALID_BLACKLIST_OR_TIME	MediumEvents
KILL_MEDIUM	MediumEvents
TIMED_OPENING_STARTED	EvvaComponent
TIMED_OPENING_FINISHED	EvvaComponent
TIMED_OPENING_SKIPPED	EvvaComponent
TIME_CHANGE_EXECUTED	EvvaComponent
BATTERY_EMPTY	EvvaComponent
FW_UPDATE_PERFORMED	MaintenanceComponent
PANIC_EXIT	MaintenanceComponent
RTC_ERROR	MaintenanceComponent
RTC_OFFSET	AdministrationComponent

Changelog

[1.22.0]

Added

Added ResendSmartphoneAuthorizationsMapi command

Changed

Removed

[1.21.0]

Added

Added UnregisterSmartphoneMapi command for Smartphone

Changed

Removed

[1.20.0]

Added

Added REMOVED registration state to identification-media resource

Changed

Removed

[1.19.0]

Added

Added WithdrawAuthorizationProfileFromMediumMapi command for Smartphone

Changed

Removed

[1.18.0]

Added

Changed

Added bluetooth-state to configure Bluetooth for G2.1 components via installation-points
Added ConfigureBluetoothStateMapi

Removed

[1.17.0]

Added

Changed

Changed the query for installation-points resource to exclude bleStatus from non-baptized insallation-points

Removed

[1.16.0]

Added

Changed

Changed the timezone for syncedAt and issuedAt from UTC to installation timezone when querying identification-media

Removed

[1.15.0]

Added

Added standardTimeProfile to AuthorizationProfileDeleted

Changed

Define partitionId as not required for AddSmartphoneToInstallationMapi command

Removed

[1.14.0]

Added

Added registration code and registration code valid until to identification-media resource
Added registration state REGISTRATION_REQUESTED

Changed

Removed

[1.13.0]

Added

Added registration state when querying identification-media
Added PhoneNumberChanged event
Added medium state UNLINKED

Changed

Removed

[1.12.0]

Added

Add new command to set message language for smartphone
- Command name: SetMessageLanguageOnSmartphoneMapi
- Confirmed by event: MediumChanged

Changed

Removed

[1.11.0]

Added

Add new command to manually request a new Smartphone Registration Code
- Command name: RequestNewRegistrationCodeMapi
- Confirmed by event: NewRegistrationCodeRequested

Changed

Removed

[1.10.0]

Added

Added new fields to return of "evva-components" resource query
- bleMac
- btbFirmwareVersion
- fwVersion
- upgradeMedia
- serialNumber
Added new fields to return of "installation-points" resource query
- timeProfileId
- accessId
- secure

Changed

Removed

[1.9.0]

Added

Added new hardware status when querying identification-media
- hardwareStatus: NEW

Changed

Removed

[1.8.0]

Added

Added new states for pending revoked smartphone when querying identification-media
- softwareStatus: REVOKED
- mediumState: REVOKED

Changed

Removed

[1.7.0]

Added

Added AddSmartphoneToInstallationMapi command
Added SmartphoneAddedToInstallation event

Changed

Removed

[1.6.0]

Added

Added SetPhoneNumberOnSmartphoneMapi command

Changed

Removed

[1.5.0]

Added

Added phoneNumber parameter to MediumChanged event

Changed

Removed

[1.4.0]

Added

Added new command SetDefaultSmartphoneValidityDurationMapi
Added smartphoneValidityDuration parameter to PartitionChanged event

Changed

Removed

[1.3.0]

Added

PhoneNumber added to identification-media resource.
MediumType added to identification-media resource.

Changed

Removed

[1.2.1]

Added

Changed

Fixed layout of table in changelog.

Removed

[1.2.0]

Added

Changed

Bugfix for Event Numbers

Fixed event numbers of the following events:

Event Name	Old Event Number	New Event Number
OPENING_NORMAL_BLACKLISTED	(0x0001)	(0xA001)
OPENING_EMERGENCY_BLACKLISTED	(0x0002)	(0xA002)
MANUAL_OPENING_STARTED_BLACKLISTED	(0x0003)	(0xA003)
OPENING_NORMAL_PROLONGED_BLACKLISTED	(0x0007)	(0xA007)
OPENING_EMERGENCY_PROLONGED_BLACKLISTED	(0xA008)	(0xA008)
OPENING_EMERGENCY_INVALID_BLACKLIST_OR_TIME_BLACKLISTED	(0x0009)	(0xA009)
OPENING_EMERGENCY_PROLONGED_INVALID_BLACKLIST_OR_TIME_BLACKLISTED	(0x000A)	(0xA00A)
FW_UPDATED	NULL	(0xA501)
FW_UPDATED_PARTIAL_FAIL	NULL	(0xA502)
FW_UPDATED_TOTAL_FAIL	NULL	(0xA503)
NONCE_OFFSET	NULL	(0xAB04)
OPENING_NORMAL_REMOTE	(0x0001)	(0xB001)
MANUAL_OPENING_STARTED_REMOTE	(0x0003)	(0xB003)
MANUAL_OPENING_FINISHED_REMOTE	(0x0004)	(0xB004)
OPENING_NORMAL_PROLONGED_REMOTE	(0x0007)	(0xB007)
OPENING_NORMAL_SWITCH	(0x0001)	(0xC001)

Bugfix for Event Groups

Fixed event groups of the following events:

Event Name	Event Number (hex)	Old Event Group	New Event Group
OPENING_NORMAL_BLACKLISTED	(0xA001)	AdministrationComponent	MediumEvents
OPENING_EMERGENCY_BLACKLISTED	(0xA002)	AdministrationComponent	MediumEvents
MANUAL_OPENING_STARTED_BLACKLISTED	(0xA003)	AdministrationComponent	MediumEvents
OPENING_NORMAL_PROLONGED_BLACKLISTED	(0xA007)	AdministrationComponent	MediumEvents
OPENING_EMERGENCY_PROLONGED_BLACKLISTED	(0xA008)	AdministrationComponent	MediumEvents
OPENING_EMERGENCY_INVALID_BLACKLIST_OR_TIME_BLACKLISTED	(0xA009)	AdministrationComponent	MediumEvents
OPENING_EMERGENCY_PROLONGED_INVALID_BLACKLIST_OR_TIME_BLACKLISTED	(0xA00A)	AdministrationComponent	MediumEvents
OPENING_NORMAL_REMOTE	(0xB001)	MediumEvents	AdministrationComponent
MANUAL_OPENING_STARTED_REMOTE	(0xB003)	MediumEvents	AdministrationComponent
MANUAL_OPENING_FINISHED_REMOTE	(0xB004)	MediumEvents	AdministrationComponent
OPENING_NORMAL_PROLONGED_REMOTE	(0xB007)	MediumEvents	AdministrationComponent
OPENING_NORMAL_SWITCH	(0xC001)	MediumEvents	AdministrationComponent

Removed

[1.1.1]

Added

Changed

Fixed typo in the description of Access Protocol Events.

Removed

[1.1.0]

Added

Provide asyncapi.yaml

Changed

Removed

[1.0.0]

Added

Initial documentation

Changed

Removed

Operations

SUB xs3/1/ase/{groupOfEvent}/{eventNumber}

#Access Protocol Events

Accepts the following message:

EventLogEntryDto

Topic to subscribe to get the incoming logs for a given group of events and event number.
Event groups: NoGroup, MediumEvents, EvvaComponent, MaintenanceComponent, AdministrationComponent.

object

eventNumber

integer

format: int32

The identifier of the event type, e.g. 0x0001 for {@link EventType#NORMAL_OPENING}.

mediumIdentifier

integer

format: int64

Format: Long.

timestampComponentLocal

string

format: date-time

Format: LocalDateTime.

timestampUtc

string

format: date-time

Format: LocalDateTime.

eventType

string

Allowed values: NORMAL_OPENING, EMERGENCY_OPENING, MANUAL_OPENING_STARTED, MANUAL_OPENING_FINISHED, MEDIA_RESTRICTED, MEDIUM_CHANGED, PROLONGED_NORMAL_OPENING, PROLONGED_MASTER_KEY_OPENING, OPENING_MASTER_KEY_IGNORED_BLACKLIST, OPENING_MASTER_KEY_PROLONGED_IGNORED_BLACKLIST, OPENING_NORMAL_BLACKLISTED, OPENING_EMERGENCY_BLACKLISTED, MANUAL_OPENING_STARTED_BLACKLISTED, OPENING_NORMAL_PROLONGED_BLACKLISTED, OPENING_EMERGENCY_PROLONGED_BLACKLISTED, OPENING_EMERGENCY_INVALID_BLACKLIST_OR_TIME_BLACKLISTED, OPENING_EMERGENCY_PROLONGED_INVALID_BLACKLIST_OR_TIME_BLACKLISTED, OPENING_NORMAL_SWITCH, OPENING_NORMAL_REMOTE, MANUAL_OPENING_STARTED_REMOTE, MANUAL_OPENING_FINISHED_REMOTE, OPENING_NORMAL_PROLONGED_REMOTE, TIMED_OPENING_STARTED, TIMED_OPENING_FINISHED, TIMED_OPENING_SKIPPED, TIME_CHANGE_EXECUTED, INIT_DATA, UPDATE_KEY, PERMIT_INIT_TIME, INIT_TIME, SET_DOOR_ID, INIT_DOORAREAS, INIT_SPECIALDAY_RESET, INIT_SPECIALDAY, INIT_TIMED_OPENING, INIT_DST, INIT_PERMANENT_OPENING_ALLOWED, INIT_BLACKLIST, INIT_OPENING_TIME, KILL_MEDIUM, BLACKLIST_VERSION_ERROR, FW_UPDATE_PERFORMED, FW_UPDATED, FW_UPDATED_PARTIAL_FAIL, FW_UPDATED_TOTAL_FAIL, MIDNIGHT_DEBUG, PANIC_EXIT, RTC_ERROR, RTC_OFFSET, ED_DATA_ERROR, START_AND_ELOG, NONCE_OFFSET, BATTERY_EMPTY, EEPROM_REINITIALIZED, STARTING_UP, ELOG_INITIALIZED, DEBUG_MESSAGE, ABC_INITIALIZED, ABC_ADD_DELTABLACKLIST, UNEXPECTED_ABC_LOG_RESP, IO_INPUT_CHANGED, UNKNOWN.

identificationMediumId

string

format: uuid

Format: UUID.

receivedAt

string

format: date-time

Format: LocalDateTime. The UTC time when the log entry was received by the backend.

ttl

string

format: date-time

Format: LocalDateTime.

accessId

integer

format: int64

Format: Long.

installationPointName

string

object

entryIdentificator

integer

format: int32

rawValue

string

Bytes as hex string.

groupOfEvent

string

Allowed values: NoGroup, MediumEvents, EvvaComponent, MaintenanceComponent, AdministrationComponent.

person

string

installationPointId

string

format: uuid

Format: UUID.

personId

string

format: uuid

Format: UUID.

string

format: uuid

Format: UUID.

identificationMediumLabel

string

object

Format: Map. This is the parameter map taken from @{@link com.evva.xesar.communication.hardware.eventlog.EventLogEntryImpl} We keep this map because, @{@link EventLogEntryValue} does not contain all entries from the parameter map.

installationPointIdentifier

string

Additional properties are allowed.

Examples

{
  "eventNumber": 0,
  "mediumIdentifier": 0,
  "timestampComponentLocal": "2019-08-24T14:15:22Z",
  "timestampUtc": "2019-08-24T14:15:22Z",
  "eventType": "string",
  "identificationMediumId": "37afba11-94ad-41ed-a812-a05fb8239708",
  "receivedAt": "2019-08-24T14:15:22Z",
  "ttl": "2019-08-24T14:15:22Z",
  "accessId": 0,
  "installationPointName": "string",
  "eventValue": {
    "shopModeActivated": true,
    "timestampFrom": "2019-08-24T14:15:22Z",
    "fwVersionChanges": "string",
    "mediumIdentifier": 0,
    "errorCodes": "string",
    "doorOpening": true,
    "errorReaction": 0,
    "initializationReason": 0,
    "mediaRestrictedReason": 0,
    "accessId": 0,
    "timestampTo": "2019-08-24T14:15:22Z",
    "errorModule": 0,
    "inputState": 0,
    "keyType": 0,
    "mediaChangedReason": 0,
    "componentType": "string",
    "raw": "string",
    "inputNr": 0,
    "nonceInHardware": 0,
    "officeModeAllowed": true,
    "fwUpdatePerformed": true,
    "deltablacklistUid": 0,
    "fwUpdateStatus": "string",
    "nonceInSoftware": 0,
    "mediaUpgrade": true,
    "errorLocation": 0,
    "startingUp": "string",
    "errorNumber": "string"
  },
  "zoneIds": {},
  "entryIdentificator": 0,
  "rawValue": "string",
  "groupOfEvent": "string",
  "person": "string",
  "installationPointId": "39b25462-2580-44dc-b0a8-22fd6c03a023",
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "identificationMediumLabel": "string",
  "parameterMap": {},
  "installationPointIdentifier": "string"
}

This example has been generated automatically.

SUB xs3/1/ces/AddMediumToInstallationRequested

#System Events

Accepts the following message:

AddMediumToInstallationRequested

Required permission: AddIdentificationMedium

Commands confirmed by this event:

• RequestAddMediumToInstallationMapi

object

Examples

{
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "hardwareId": {},
  "mediumIdentifier": 0,
  "terminalId": "57e69e1b-2c00-4a26-b5e3-44617c6cc659",
  "label": "string"
}

This example has been generated automatically.

SUB xs3/1/ces/AuthorizationProfileAccessChanged

#System Events

Accepts the following message:

AuthorizationProfileAccessChanged

Whenever the authorization data of an authorization profile was changed, this is event is emitted.

For instance, when the standard time profile was changed, an installation point was added/removed, a specific time profile was assigned to a zone or a previously assigned time profile was unassigned. However, the event is not emitted if the access times of a time profile were changed, see {@link AuthorizationTimeProfileAccessTimesChanged} for this.

Required permission: ChangeAuthorizationProfileData

Commands confirmed by this event:

• ChangeAuthorizationProfileMapi

object

Examples

{
  "addedZones": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "addedInstallationPoints": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "addedTimeProfiles": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "individual": true,
  "standardTimeProfile": "4b454e4e-8c15-4284-9813-390c18525cfc",
  "media": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "zones": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "removedInstallationPoints": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "removedZones": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "installationPoints": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "manualOfficeMode": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "removedTimeProfiles": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "oldStandardTimeProfile": "744c8950-9164-46d1-a5fb-862273a21be7"
}

This example has been generated automatically.

SUB xs3/1/ces/AuthorizationProfileChanged

#System Events

Accepts the following message:

AuthorizationProfileChanged

Required permission: ChangeAuthorizationProfileData

Commands confirmed by this event:

• ChangeAuthorizationProfileMapi

object

Examples

SUB xs3/1/ces/AuthorizationProfileCreated

#System Events

Accepts the following message:

AuthorizationProfileCreated

Required permission: CreateAuthorizationProfile

Commands confirmed by this event:

• CreateAuthorizationProfileMapi

object

Examples

{
  "individual": true,
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "assignable": true
}

This example has been generated automatically.

SUB xs3/1/ces/AuthorizationProfileDeleted

#System Events

Accepts the following message:

AuthorizationProfileDeleted

Required permission: RemoveAuthorizationProfile

Commands confirmed by this event:

• DeleteAuthorizationProfileMapi

object

Examples

{
  "installationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "individual": true,
  "timeProfiles": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "standardTimeProfile": "4b454e4e-8c15-4284-9813-390c18525cfc",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "zones": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

This example has been generated automatically.

SUB xs3/1/ces/AuthorizationProfileInfoChanged

#System Events

Accepts the following message:

AuthorizationProfileInfoChanged

Required permission: ChangeAuthorizationProfileData

Commands confirmed by this event:

• ChangeAuthorizationProfileMapi

object

Examples

SUB xs3/1/ces/AuthorizationProfileWithdrawnFromMedium

#System Events

Accepts the following message:

AuthorizationProfileWithdrawnFromMedium

Withdraw means that we don't have the physical medium in our hands. We remove the authorizations. The next time the medium is updated, authorizations will be removed from the physical card. Most likely this will happen at an online-wallreader.

Required permission: WithdrawAllAuthorizations

Commands confirmed by this event:

• WithdrawAuthorizationProfileFromMediumMapi

object

Examples

{
  "accessBeginAt": "2019-08-24T14:15:22Z",
  "individualAuthorizationProfileIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
  "withdrawnAt": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "validFrom": "2019-08-24T14:15:22Z",
  "accessEndAt": "2019-08-24T14:15:22Z"
}

This example has been generated automatically.

SUB xs3/1/ces/AuthorizationTimeProfileChanged

#System Events

Accepts the following message:

AuthorizationTimeProfileChanged

Required permission: ChangeTimeProfile

Commands confirmed by this event:

• ChangeAuthorizationTimeProfileMapi

object

Examples

{
  "timeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "days": [
        "string"
      ]
    }
  ],
  "exceptionTimeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "validStandardTimeProfile": true
}

This example has been generated automatically.

SUB xs3/1/ces/AuthorizationTimeProfileCreated

#System Events

Accepts the following message:

AuthorizationTimeProfileCreated

Required permission: CreateTimeProfile

Commands confirmed by this event:

• CreateAuthorizationTimeProfileMapi

object

Examples

{
  "timeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "days": [
        "string"
      ]
    }
  ],
  "exceptionTimeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "validStandardTimeProfile": true
}

This example has been generated automatically.

SUB xs3/1/ces/AuthorizationTimeProfileDeleted

#System Events

Accepts the following message:

AuthorizationTimeProfileDeleted

Required permission: RemoveTimeProfile

Commands confirmed by this event:

• DeleteAuthorizationTimeProfileMapi

object

Examples

SUB xs3/1/ces/CalendarChanged

#System Events

Accepts the following message:

CalendarChanged

Required permission: ChangeCalendar

Commands confirmed by this event:

• ChangeCalendarMapi

object

Examples

SUB xs3/1/ces/CalendarCreated

#System Events

Accepts the following message:

CalendarCreated

Required permission: CreateCalendar

Commands confirmed by this event:

• CreateCalendarMapi

object

Examples

{
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "calendarIdentifier": 0,
  "name": "string",
  "specialDays": [
    "2019-08-24"
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/CalendarDeleted

#System Events

Accepts the following message:

CalendarDeleted

Required permission: RemoveCalendar

Commands confirmed by this event:

• DeleteCalendarMapi

object

Examples

SUB xs3/1/ces/CodingStationChanged

#System Events

Accepts the following message:

CodingStationChanged

Required permission: ChangeCodingStationData

Commands confirmed by this event:

• ChangeCodingStationMapi

object

Examples

SUB xs3/1/ces/CodingStationCreated

#System Events

Accepts the following message:

CodingStationCreated

Required permission: AddCodingStation

Commands confirmed by this event:

• CreateCodingStationMapi

object

Examples

{
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/CodingStationDeleted

#System Events

Accepts the following message:

CodingStationDeleted

Required permission: RemoveCodingStation

Commands confirmed by this event:

• DeleteCodingStationMapi

object

Examples

SUB xs3/1/ces/EvvaComponentAdded

#System Events

Accepts the following message:

EvvaComponentAdded

Required permission: ChangeInstallationPointData

Commands confirmed by this event:

• CreateInstallationPointMapi

• AddEvvaComponentMapi

object

Examples

{
  "batteryWarning": true,
  "serialNumber": "string",
  "onlineStatus": "string",
  "type": "string",
  "stateChangedAt": "2019-08-24T14:15:22Z",
  "nonce": 0,
  "componentParts": [
    {
      "serialNumber": "string",
      "hardwareVersion": {
        "hardwareComponentType": "string",
        "versionHardware": {},
        "productComponentType": "string",
        "subComponent": {}
      },
      "firmwareVersion": {
        "firmwareVariant": "string",
        "major": 0,
        "minor": 0,
        "majorBootloader": 0,
        "mechanicalVersion": "string",
        "internalRevision": "string",
        "electricalVersion": "string",
        "minorBootloader": 0,
        "firmwareUpdateFileFormatVersion": 0
      },
      "busAddress": 0
    }
  ],
  "useOddKey": true,
  "batteryCondition": "string",
  "evvaComponentId": "476bbfda-5922-42bd-9ac4-62e1d518be37",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "firmwareVersion": {
    "firmwareVariant": "string",
    "major": 0,
    "minor": 0,
    "majorBootloader": 0,
    "mechanicalVersion": "string",
    "internalRevision": "string",
    "electricalVersion": "string",
    "minorBootloader": 0,
    "firmwareUpdateFileFormatVersion": 0
  },
  "status": "string"
}

This example has been generated automatically.

SUB xs3/1/ces/EvvaComponentRemovalPrepared

#System Events

Accepts the following message:

EvvaComponentRemovalPrepared

Required permission: RemoveEvvaComponent

Commands confirmed by this event:

• PrepareRemovalOfEvvaComponentMapi

object

Examples

{
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "stateChangedAt": "2019-08-24T14:15:22Z",
  "linkedInstallationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

This example has been generated automatically.

SUB xs3/1/ces/EvvaComponentRemoved

#System Events

Accepts the following message:

EvvaComponentRemoved

Required permission: RemoveFaultyEvvaComponent

Commands confirmed by this event:

• ForceRemoveEvvaComponentMapi

object

Examples

{
  "accessId": 0,
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "lockedMediaWithAccess": [
    0
  ],
  "linkedInstallationPointIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "useOddKey": true,
  "forced": true,
  "maintenanceComponentId": "c2fc589c-80fe-4366-aa6b-2c9ce0c8e072",
  "stateChangedAt": "2019-08-24T14:15:22Z",
  "nonce": 0
}

This example has been generated automatically.

SUB xs3/1/ces/FindComponentPerformed

#System Events

Accepts the following message:

FindComponentPerformed

Required permission: SearchOnlineEvvaComponent

Commands confirmed by this event:

• FindComponentMapi

object

Examples

SUB xs3/1/ces/IndividualAuthorizationsAddedToMedium

#System Events

Accepts the following message:

IndividualAuthorizationsAddedToMedium

Required permission: any of:

• AssignInstallationPointIndividualAuthorization

• AssignZoneIndividualAuthorization

Commands confirmed by this event:

• AddInstallationPointAuthorizationToMediumMapi

• AddZoneAuthorizationToMediumMapi

object

Examples

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "authorizationProfiles": [
    {
      "authorizationName": "string",
      "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
      "timeProfileName": "string",
      "authorizationId": "fd01ce3c-0799-43be-b4cd-b95dd107d4d8",
      "installationPoint": true,
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ]
}

This example has been generated automatically.

SUB xs3/1/ces/IndividualAuthorizationsDeleted

#System Events

Accepts the following message:

IndividualAuthorizationsDeleted

Required permission: any of:

• RemoveInstallationPointIndividualAuthorization

• RemoveZoneIndividualAuthorization

Commands confirmed by this event:

• RemoveZoneAuthorizationFromMediumMapi

• RemoveInstallationPointAuthorizationFromMediumMapi

object

Examples

SUB xs3/1/ces/InstallationPointChanged

#System Events

Accepts the following message:

InstallationPointChanged

Required permission: any of:

• AssignOfficeModeTimeProfileToInstallationPoint

• ChangeInstallationPointData

• ConfigureLoggingPersonalDataForInstallationPoint

• ConfigureManualOfficeModeAndShopMode

• ConfigureMediaUpgrade

• ConfigureReleaseDuration

Commands confirmed by this event:

• ConfigureBluetoothStateMapi

• ConfigureManualOfficeModeAndShopModeMapi

• ChangeInstallationPointMapi

• ConfigureMediaUpgradeMapi

• ConfigureReleaseDurationMapi

• ConfigureOfficeModeTimeProfileMapi

• SetPersonalReferenceDurationForInstallationPointMapi

• AddEvvaComponentMapi

object

releaseDurationShort

integer

format: int32

bluetoothState

string

Settings for BLE Allowed values: ENABLED, DISABLED, NOT_SUPPORTED.

upgradeMedia

boolean

object

timeProfileName

string

description

string

array<string>

Array

timeProfileId

string

format: uuid

Format: UUID.

shopMode

boolean

aggregateId

string

format: uuid

Format: UUID.

releaseDurationLong

integer

format: int32

installationType

string

manualOfficeMode

boolean

name

string

installationId

string

object

openDoor

boolean

Additional properties are allowed.

Examples

{
  "releaseDurationShort": 0,
  "bluetoothState": "string",
  "upgradeMedia": true,
  "personalReferenceDurationOld": {
    "days": 0,
    "logMode": "string"
  },
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "timeProfileName": "string",
  "description": "string",
  "linkedInstallationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40",
  "shopMode": true,
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "releaseDurationLong": 0,
  "installationType": "string",
  "manualOfficeMode": true,
  "name": "string",
  "installationId": "string",
  "timeProfileData": {
    "timeSeries": [
      {
        "times": [
          {
            "start": "14:15:22Z",
            "end": "14:15:22Z"
          }
        ],
        "days": [
          "string"
        ]
      }
    ],
    "exceptionTimeSeries": [
      {
        "times": [
          {
            "start": "14:15:22Z",
            "end": "14:15:22Z"
          }
        ],
        "calendars": [
          0
        ]
      }
    ],
    "exceptionTimePointSeries": [
      {
        "calendars": [
          0
        ],
        "points": [
          "14:15:22Z"
        ]
      }
    ],
    "timePointSeries": [
      {
        "days": [
          "string"
        ],
        "points": [
          "14:15:22Z"
        ]
      }
    ]
  },
  "openDoor": true
}

This example has been generated automatically.

SUB xs3/1/ces/InstallationPointCreated

#System Events

Accepts the following message:

InstallationPointCreated

Required permission: AddInstallationPoint

Commands confirmed by this event:

• CreateInstallationPointMapi

object

componentType

string

The type of component installed in the installation point. Allowed values: Handle, Escutcheon, Cylinder, WallReader, WallReader2x, OnlineWallReader.

releaseDurationShort

integer

format: int32

instance

integer

format: int32

upgradeMedia

boolean

partitionId

string

format: uuid

Format: UUID.

object

timeProfileName

string

description

string

object

Format: ZoneOffsetTransition.

array<object>

Array

timeProfileId

string

format: uuid

Format: UUID.

accessId

integer

format: int64

Format: long.

shopMode

boolean

releaseDurationLong

integer

format: int32

installationType

string

manualOfficeMode

boolean

name

string

object

Format: ZoneOffsetTransition.

evvaComponentId

string

format: uuid

Format: UUID.

string

format: uuid

Format: UUID.

installationId

string

object

openDoor

boolean

Additional properties are allowed.

Examples

{
  "componentType": "string",
  "releaseDurationShort": 0,
  "instance": 0,
  "upgradeMedia": true,
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "timeProfileName": "string",
  "description": "string",
  "nextDstTransition": {},
  "linkedInstallationPoints": [
    {
      "accessId": 0,
      "componentType": "string",
      "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
      "evvaComponentId": "476bbfda-5922-42bd-9ac4-62e1d518be37",
      "installationPointProperties": {
        "releaseDurationShort": 0,
        "bluetoothState": "string",
        "upgradeMedia": true,
        "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
        "personalReferenceDuration": {
          "days": 0,
          "logMode": "string"
        },
        "description": "string",
        "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40",
        "shopMode": true,
        "releaseDurationLong": 0,
        "installationType": "string",
        "manualOfficeMode": true,
        "name": "string",
        "installationId": "string",
        "openDoor": true
      }
    }
  ],
  "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40",
  "accessId": 0,
  "shopMode": true,
  "releaseDurationLong": 0,
  "installationType": "string",
  "manualOfficeMode": true,
  "name": "string",
  "afterNextDstTransition": {},
  "evvaComponentId": "476bbfda-5922-42bd-9ac4-62e1d518be37",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "installationId": "string",
  "timeProfileData": {
    "timeSeries": [
      {
        "times": [
          {
            "start": "14:15:22Z",
            "end": "14:15:22Z"
          }
        ],
        "days": [
          "string"
        ]
      }
    ],
    "exceptionTimeSeries": [
      {
        "times": [
          {
            "start": "14:15:22Z",
            "end": "14:15:22Z"
          }
        ],
        "calendars": [
          0
        ]
      }
    ],
    "exceptionTimePointSeries": [
      {
        "calendars": [
          0
        ],
        "points": [
          "14:15:22Z"
        ]
      }
    ],
    "timePointSeries": [
      {
        "days": [
          "string"
        ],
        "points": [
          "14:15:22Z"
        ]
      }
    ]
  },
  "calendarData": {
    "calendars": {}
  },
  "openDoor": true
}

This example has been generated automatically.

SUB xs3/1/ces/InstallationPointDeleted

#System Events

Accepts the following message:

InstallationPointDeleted

Required permission: RemoveInstallationPoint

Commands confirmed by this event:

• DeleteInstallationPointMapi

object

Examples

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "zones": [
    0
  ],
  "authorizationProfiles": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "linkedInstallationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "timeProfile": "2fc96a7e-5427-494f-8b07-834b212fe10b"
}

This example has been generated automatically.

SUB xs3/1/ces/InstallationPointsInZoneChanged

#System Events

Accepts the following message:

InstallationPointsInZoneChanged

Required permission: any of:

• AssignInstallationPointToZone

• RemoveInstallationPointFromZone

Commands confirmed by this event:

• RemoveInstallationPointFromZoneMapi

• AddInstallationPointToZoneMapi

object

Examples

{
  "accessId": 0,
  "addedInstallationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "removedInstallationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

This example has been generated automatically.

SUB xs3/1/ces/LoggedOut

#Session

Accepts the following message:

LoggedOut

Required permission: LoginAdministrationComponent

Commands confirmed by this event:

• Logout

object

Examples

SUB xs3/1/ces/MediumAddedToInstallation

#System Events

Accepts the following message:

MediumAddedToInstallation

Required permission: AddIdentificationMedium

Commands confirmed by this event:

• RequestAddMediumToInstallationMapi

object

Examples

SUB xs3/1/ces/MediumAuthorizationProfileChanged

#System Events

Accepts the following message:

MediumAuthorizationProfileChanged

Required permission: AssignAuthorizationProfileToIdentificationMedium

Commands confirmed by this event:

• AssignAuthorizationProfileToMediumMapi

object

Examples

{
  "newAuthorizationProfileId": "c73689f5-2208-4569-a079-d0d17f283351",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "oldAuthorizationProfileId": "f27adbb8-1cf6-4e8f-8d78-7237e569109e"
}

This example has been generated automatically.

SUB xs3/1/ces/MediumChanged

#System Events

Accepts the following message:

MediumChanged

Required permission: any of:

• ChangeDisengagePeriodOnMedium

• ChangeValidityDurationOnMedium

• SetAuthorizationBeginAtOnMedium

• SetAuthorizationEndAtOnMedium

• SetMediumLabel

Commands confirmed by this event:

• SetAccessEndAtMapi

• SetDisengagePeriodOnMediumMapi

• SetPhoneNumberOnSmartphoneMapi

• AssignAuthorizationProfileToMediumMapi

• AssignPersonToMediumMapi

• SetAccessBeginAtMapi

• SetMessageLanguageOnSmartphoneMapi

• SetValidityDurationMapi

• SetLabelOnMediumMapi

object

Examples

{
  "accessBeginAt": "2019-08-24T14:15:22Z",
  "phoneNumber": "string",
  "disengagePeriod": "string",
  "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
  "validityDuration": 0,
  "messageLanguage": "string",
  "validUntil": "2019-08-24T14:15:22Z",
  "changedAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "label": "string",
  "validFrom": "2019-08-24T14:15:22Z",
  "accessEndAt": "2019-08-24T14:15:22Z"
}

This example has been generated automatically.

SUB xs3/1/ces/MediumLocked

#System Events

Accepts the following message:

MediumLocked

Required permission: LockMedium

Commands confirmed by this event:

• LockMediumMapi

object

Examples

{
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "installationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "mediumIdentifier": 0,
  "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
  "individualAuthorizations": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validityEnd": "2019-08-24T14:15:22Z",
  "zones": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "hasMasterKeyAccess": true
}

This example has been generated automatically.

SUB xs3/1/ces/MediumPersonChanged

#System Events

Accepts the following message:

MediumPersonChanged

Required permission: AssignMediumToPerson

Commands confirmed by this event:

• AssignPersonToMediumMapi

object

Examples

{
  "oldPersonId": "883385ad-9b37-4eec-a71f-e5f5467c73dd",
  "newPersonId": "21848cac-75f1-463e-a5d8-8a2e7b09d04d",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/NewRegistrationCodeRequested

#System Events

Accepts the following message:

NewRegistrationCodeRequested

Required permission: ChangeIssuedMedium

Commands confirmed by this event:

• RequestNewRegistrationCodeMapi

object

Examples

SUB xs3/1/ces/OfficeModeTimeProfileChanged

#System Events

Accepts the following message:

OfficeModeTimeProfileChanged

Required permission: ChangeTimeProfile

Commands confirmed by this event:

• ChangeOfficeModeTimeProfileMapi

object

Examples

{
  "timeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "days": [
        "string"
      ]
    }
  ],
  "exceptionTimeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "exceptionTimePointSeries": [
    {
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "points": [
        "14:15:22Z"
      ]
    }
  ],
  "name": "string",
  "description": "string",
  "timePointSeries": [
    {
      "days": [
        "string"
      ],
      "points": [
        "14:15:22Z"
      ]
    }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/OfficeModeTimeProfileCreated

#System Events

Accepts the following message:

OfficeModeTimeProfileCreated

Required permission: CreateTimeProfile

Commands confirmed by this event:

• CreateOfficeModeTimeProfileMapi

object

Examples

{
  "timeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "days": [
        "string"
      ]
    }
  ],
  "exceptionTimeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "exceptionTimePointSeries": [
    {
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "points": [
        "14:15:22Z"
      ]
    }
  ],
  "name": "string",
  "description": "string",
  "timePointSeries": [
    {
      "days": [
        "string"
      ],
      "points": [
        "14:15:22Z"
      ]
    }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/OfficeModeTimeProfileDeleted

#System Events

Accepts the following message:

OfficeModeTimeProfileDeleted

Required permission: RemoveTimeProfile

Commands confirmed by this event:

• DeleteOfficeModeTimeProfileMapi

object

Examples

SUB xs3/1/ces/PartitionChanged

#System Events

Accepts the following message:

PartitionChanged

Required permission: any of:

• ConfigureDailySchedulerExecutionTime

• ConfigureDefaultLoggingPersonalDataForInstallationPoint

• ConfigureDefaultLoggingPersonalDataForPerson

• ConfigureValidityThreshold

• SetDefaultAccessDurationForReplacedMedium

• SetDefaultMediumValidityDurationForPartition

Commands confirmed by this event:

• SetReplacementMediumDurationMapi

• SetInstallationPointPersonalReferenceDurationMapi

• SetValidityThresholdMapi

• SetPersonPersonalReferenceDurationMapi

• SetDailySchedulerExecutionTimeMapi

• SetDefaultSmartphoneValidityDurationMapi

• SetDefaultValidityDurationMapi

object

Examples

{
  "TOKEN_VALIDITY_DURATION_CHANGED": "string",
  "installationPointDefaultPersonalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "replacementMediumDuration": 0,
  "storeDataOnTablet": true,
  "smartphoneValidityDuration": 0,
  "mqttServerAddress": {},
  "tokenValidityDurationMinutes": 0,
  "validityDuration": 0,
  "validityThreshold": 0,
  "personDefaultPersonalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dailySchedulerExecutionTime": "14:15:22Z"
}

This example has been generated automatically.

SUB xs3/1/ces/PersonChanged

#System Events

Accepts the following message:

PersonChanged

Required permission: any of:

• ChangePersonData

• ConfigureLoggingPersonalDataForPerson

• SetDefaultAuthorizationProfileForPerson

• SetDefaultDisengagePeriodForPerson

Commands confirmed by this event:

• ChangePersonInformationMapi

• SetDefaultAuthorizationProfileForPersonMapi

• SetDefaultDisengagePeriodForPersonMapi

• SetPersonalReferenceDurationInPersonMapi

object

Examples

{
  "firstName": "string",
  "lastName": "string",
  "identifier": "string",
  "defaultAuthorizationProfileId": "77cccd07-4dc5-4175-a09a-cd4ad954feee",
  "oldDefaultAuthorizationProfileId": "aed3e028-9245-4b51-9438-5f8e1cb65602",
  "oldPersonalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "disengagePeriod": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/PersonCreated

#System Events

Accepts the following message:

PersonCreated

Required permission: CreatePerson

Commands confirmed by this event:

• CreatePersonMapi

object

Examples

{
  "firstName": "string",
  "lastName": "string",
  "identifier": "string",
  "defaultAuthorizationProfileId": "77cccd07-4dc5-4175-a09a-cd4ad954feee",
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "disengagePeriod": "string",
  "externalId": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/PersonDeleted

#System Events

Accepts the following message:

PersonDeleted

Required permission: RemovePerson

Commands confirmed by this event:

• DeletePersonMapi

object

Examples

{
  "defaultAuthorizationProfileId": "77cccd07-4dc5-4175-a09a-cd4ad954feee",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "mediums": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

This example has been generated automatically.

SUB xs3/1/ces/PhoneNumberChanged

#System Events

Accepts the following message:

PhoneNumberChanged

Required permission: SetMediumLabel

Commands confirmed by this event:

• SetPhoneNumberOnSmartphoneMapi

object

Examples

SUB xs3/1/ces/PrepareEvvaComponentRemovalReverted

#System Events

Accepts the following message:

PrepareEvvaComponentRemovalReverted

Required permission: RevertRemoveComponent

Commands confirmed by this event:

• RevertPrepareRemovalOfEvvaComponentMapi

object

Examples

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "stateChangedAt": "2019-08-24T14:15:22Z",
  "linkedInstallationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

This example has been generated automatically.

SUB xs3/1/ces/RemoteDisengagePerformed

#System Events

Accepts the following message:

RemoteDisengagePerformed

Required permission: TriggerRemoteDisengage

Commands confirmed by this event:

• RemoteDisengageMapi

object

Examples

SUB xs3/1/ces/RemoteDisengagePermanentPerformed

#System Events

Accepts the following message:

RemoteDisengagePermanentPerformed

Required permission: TriggerRemoteDisengage

Commands confirmed by this event:

• RemoteDisengagePermanentMapi

object

Examples

SUB xs3/1/ces/SmartphoneAddedToInstallation

#System Events

Accepts the following message:

SmartphoneAddedToInstallation

Required permission: AddIdentificationMedium

Commands confirmed by this event:

• AddSmartphoneToInstallationMapi

object

Examples

{
  "accessBeginAt": "2019-08-24T14:15:22Z",
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "disengagePeriod": "string",
  "mediumIdentifier": 0,
  "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
  "individualAuthorizations": [
    {
      "authorizationName": "string",
      "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
      "timeProfileName": "string",
      "authorizationId": "fd01ce3c-0799-43be-b4cd-b95dd107d4d8",
      "installationPoint": true,
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "sagaId": "d171ccc5-4e45-4ee5-8129-c6924a02cf9a",
  "messageLanguage": "string",
  "label": "string",
  "validityBeginAt": "2019-08-24T14:15:22Z",
  "accessEndAt": "2019-08-24T14:15:22Z",
  "validityEndAt": "2019-08-24T14:15:22Z",
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "phoneNumber": "string",
  "validityDuration": 0,
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
  "issuedAt": "2019-08-24T14:15:22Z"
}

This example has been generated automatically.

SUB xs3/1/ces/SmartphoneAuthorizationsResent

#System Events

Accepts the following message:

SmartphoneAuthorizationsResent

Required permission: ChangeIssuedMedium

Commands confirmed by this event:

• ResendSmartphoneAuthorizationsMapi

object

Examples

SUB xs3/1/ces/SmartphoneUnregistered

#System Events

Accepts the following message:

SmartphoneUnregistered

Required permission: ChangeIssuedMedium

Commands confirmed by this event:

• UnregisterSmartphoneMapi

object

Examples

SUB xs3/1/ces/UnauthorizedLoginAttempt

#Session

Accepts the following message:

UnauthorizedLoginAttempt

object

Examples

SUB xs3/1/ces/UserGroupChanged

#System Events

Accepts the following message:

UserGroupChanged

Required permission: CreateAuthorizationProfile

Commands confirmed by this event:

• ConfigureAssignableAuthorizationProfilesMapi

object

Examples

{
  "assignableAuthorizationProfiles": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "permissions": [
    "string"
  ],
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/ZoneChanged

#System Events

Accepts the following message:

ZoneChanged

Required permission: ChangeZoneData

Commands confirmed by this event:

• ChangeZoneDataMapi

object

Examples

SUB xs3/1/ces/ZoneCreated

#System Events

Accepts the following message:

ZoneCreated

Required permission: CreateZone

Commands confirmed by this event:

• CreateZoneMapi

object

Examples

{
  "accessId": 0,
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

SUB xs3/1/ces/ZoneDeleted

#System Events

Accepts the following message:

ZoneDeleted

Required permission: RemoveZone

Commands confirmed by this event:

• DeleteZoneMapi

object

Examples

{
  "installationPointIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "deletedAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "authorizationProfileIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

This example has been generated automatically.

PUB xs3/1/cmd/AddEvvaComponentMapi

#Command

Accepts the following message:

AddEvvaComponentMapi

Add an Evva component to an existing installation point.

Required permission: ChangeInstallationPointData

Events confirming this command:

• InstallationPointChanged

• EvvaComponentAdded

object

Examples

PUB xs3/1/cmd/AddInstallationPointAuthorizationToMediumMapi

#Command

Accepts the following message:

AddInstallationPointAuthorizationToMediumMapi

Add individual authorisation for an installation point.

Required permission: AssignInstallationPointIndividualAuthorization

Events confirming this command:

• IndividualAuthorizationsAddedToMedium

object

Examples

{
  "authorization": {
    "authorizationName": "string",
    "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
    "timeProfileName": "string",
    "authorizationId": "fd01ce3c-0799-43be-b4cd-b95dd107d4d8",
    "installationPoint": true,
    "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/AddInstallationPointToZoneMapi

#Command

Accepts the following message:

AddInstallationPointToZoneMapi

Required permission: AssignInstallationPointToZone

Events confirming this command:

• InstallationPointsInZoneChanged

object

Examples

{
  "installationPointId": "39b25462-2580-44dc-b0a8-22fd6c03a023",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/AddSmartphoneToInstallationMapi

#Command

Accepts the following message:

AddSmartphoneToInstallationMapi

The AddSmartphoneToInstallationMapi command is designed specifically for adding smartphone identification mediums, while the AddMediumToInstallationMapi command is dedicated to adding passive identification mediums. All other commands related to identification mediums can be used for modifying both smartphone identification mediums and other types of identification mediums.

Required permission: AddIdentificationMedium

Events confirming this command:

• SmartphoneAddedToInstallation

object

Examples

{
  "accessBeginAt": "2019-08-24T14:15:22Z",
  "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2",
  "disengagePeriod": "string",
  "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
  "individualAuthorizations": [
    {
      "authorizationName": "string",
      "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
      "timeProfileName": "string",
      "authorizationId": "fd01ce3c-0799-43be-b4cd-b95dd107d4d8",
      "installationPoint": true,
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "messageLanguage": "string",
  "label": "string",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string",
  "accessEndAt": "2019-08-24T14:15:22Z",
  "phoneNumber": "string",
  "validityDuration": 0,
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

This example has been generated automatically.

PUB xs3/1/cmd/AddZoneAuthorizationToMediumMapi

#Command

Accepts the following message:

AddZoneAuthorizationToMediumMapi

Required permission: AssignZoneIndividualAuthorization

Events confirming this command:

• IndividualAuthorizationsAddedToMedium

object

Examples

{
  "authorization": {
    "authorizationName": "string",
    "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
    "timeProfileName": "string",
    "authorizationId": "fd01ce3c-0799-43be-b4cd-b95dd107d4d8",
    "installationPoint": true,
    "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/AssignAuthorizationProfileToMediumMapi

#Command

Accepts the following message:

AssignAuthorizationProfileToMediumMapi

Required permission: AssignAuthorizationProfileToIdentificationMedium

Events confirming this command:

• MediumChanged

• MediumAuthorizationProfileChanged

object

Examples

{
  "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/AssignPersonToMediumMapi

#Command

Accepts the following message:

AssignPersonToMediumMapi

Required permission: AssignMediumToPerson

Events confirming this command:

• MediumChanged

• MediumPersonChanged

object

Examples

{
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ChangeAuthorizationProfileMapi

#Command

Accepts the following message:

ChangeAuthorizationProfileMapi

Required permission: ChangeAuthorizationProfileData

Events confirming this command:

• AuthorizationProfileChanged

• AuthorizationProfileInfoChanged

• AuthorizationProfileAccessChanged

object

Examples

{
  "installationPoints": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "manualOfficeMode": true,
  "name": "string",
  "description": "string",
  "standardTimeProfile": "4b454e4e-8c15-4284-9813-390c18525cfc",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "zones": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
    }
  ],
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ChangeAuthorizationTimeProfileMapi

#Command

Accepts the following message:

ChangeAuthorizationTimeProfileMapi

Required permission: ChangeTimeProfile

Events confirming this command:

• AuthorizationTimeProfileChanged

object

Examples

{
  "timeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "days": [
        "string"
      ]
    }
  ],
  "exceptionTimeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ChangeCalendarMapi

#Command

Accepts the following message:

ChangeCalendarMapi

Required permission: ChangeCalendar

Events confirming this command:

• CalendarChanged

object

Examples

{
  "name": "string",
  "specialDays": [
    "2019-08-24"
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ChangeCodingStationMapi

#Command

Accepts the following message:

ChangeCodingStationMapi

Required permission: ChangeCodingStationData

Events confirming this command:

• CodingStationChanged

object

Examples

{
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ChangeInstallationPointMapi

#Command

Accepts the following message:

ChangeInstallationPointMapi

Required permission: ChangeInstallationPointData

Events confirming this command:

• InstallationPointChanged

object

Examples

{
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "installationType": "string",
  "name": "string",
  "description": "string",
  "installationId": "string",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ChangeOfficeModeTimeProfileMapi

#Command

Accepts the following message:

ChangeOfficeModeTimeProfileMapi

Required permission: ChangeTimeProfile

Events confirming this command:

• OfficeModeTimeProfileChanged

object

array<object>

Array. Time intervals for allowing/disallowing entry.

array<object>

Array. Time intervals for allowing/disallowing entry at exceptional dates (holidays etc.).

array<object>

Array. Time of a day in a specific weekday, used to end the allowed entry at exceptional dates (holidays etc.).

name

string

All unicode characters allowed. Size between 1 and 50. Required.

description

string

All unicode characters allowed. Size between 0 and 255.

array<object>

Array. Time of a day in a specific weekday, used to end the allowed entry.

string

format: uuid

Format: UUID, Required.

commandId

string

format: uuid

Format: UUID, Required.

token

string

Required.

Additional properties are allowed.

Examples

{
  "timeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "days": [
        "string"
      ]
    }
  ],
  "exceptionTimeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "exceptionTimePointSeries": [
    {
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "points": [
        "14:15:22Z"
      ]
    }
  ],
  "name": "string",
  "description": "string",
  "timePointSeries": [
    {
      "days": [
        "string"
      ],
      "points": [
        "14:15:22Z"
      ]
    }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ChangePersonInformationMapi

#Command

Accepts the following message:

ChangePersonInformationMapi

Required permission: ChangePersonData

Events confirming this command:

• PersonChanged

object

Examples

{
  "firstName": "string",
  "lastName": "string",
  "identifier": "string",
  "externalId": "string",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ChangeZoneDataMapi

#Command

Accepts the following message:

ChangeZoneDataMapi

Required permission: ChangeZoneData

Events confirming this command:

• ZoneChanged

object

Examples

{
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ConfigureAssignableAuthorizationProfilesMapi

#Command

Accepts the following message:

ConfigureAssignableAuthorizationProfilesMapi

Can be used to specify which authorization profiles can be assigned to a user group. The authorization profiles are specified via an array of their IDs.

Required permission: CreateAuthorizationProfile

Events confirming this command:

• UserGroupChanged

object

Examples

{
  "assignableAuthorizationProfiles": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ConfigureBluetoothStateMapi

#Command

Accepts the following message:

ConfigureBluetoothStateMapi

Required permission: ChangeInstallationPointData

Events confirming this command:

• InstallationPointChanged

object

Examples

{
  "bluetoothState": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ConfigureManualOfficeModeAndShopModeMapi

#Command

Accepts the following message:

ConfigureManualOfficeModeAndShopModeMapi

Required permission: ConfigureManualOfficeModeAndShopMode

Events confirming this command:

• InstallationPointChanged

object

Examples

{
  "shopMode": true,
  "manualOfficeMode": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ConfigureMediaUpgradeMapi

#Command

Accepts the following message:

ConfigureMediaUpgradeMapi

Activate/Deactivate the XVN functionality for an installation-point.

Required permission: ConfigureMediaUpgrade

Events confirming this command:

• InstallationPointChanged

object

Examples

PUB xs3/1/cmd/ConfigureOfficeModeTimeProfileMapi

#Command

Accepts the following message:

ConfigureOfficeModeTimeProfileMapi

Required permission: AssignOfficeModeTimeProfileToInstallationPoint

Events confirming this command:

• InstallationPointChanged

object

Examples

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ConfigureReleaseDurationMapi

#Command

Accepts the following message:

ConfigureReleaseDurationMapi

Required permission: ConfigureReleaseDuration

Events confirming this command:

• InstallationPointChanged

object

Examples

{
  "releaseDurationShort": 0,
  "releaseDurationLong": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/CreateAuthorizationProfileMapi

#Command

Accepts the following message:

CreateAuthorizationProfileMapi

Creates a new Authorization Profile.

Required permission: CreateAuthorizationProfile

Events confirming this command:

• AuthorizationProfileCreated

object

Examples

{
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/CreateAuthorizationTimeProfileMapi

#Command

Accepts the following message:

CreateAuthorizationTimeProfileMapi

Required permission: CreateTimeProfile

Events confirming this command:

• AuthorizationTimeProfileCreated

object

Examples

{
  "timeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "days": [
        "string"
      ]
    }
  ],
  "exceptionTimeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/CreateCalendarMapi

#Command

Accepts the following message:

CreateCalendarMapi

Required permission: CreateCalendar

Events confirming this command:

• CalendarCreated

object

Examples

{
  "name": "string",
  "specialDays": [
    "2019-08-24"
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/CreateCodingStationMapi

#Command

Accepts the following message:

CreateCodingStationMapi

Required permission: AddCodingStation

Events confirming this command:

• CodingStationCreated

object

Examples

{
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/CreateInstallationPointMapi

#Command

Accepts the following message:

CreateInstallationPointMapi

Required permission: AddInstallationPoint

Events confirming this command:

• InstallationPointCreated

• EvvaComponentAdded

object

Examples

{
  "componentType": "string",
  "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  "linkedInstallationPoints": {},
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "properties": {
    "installationType": "string",
    "name": "string",
    "description": "string",
    "installationId": "string"
  },
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/CreateOfficeModeTimeProfileMapi

#Command

Accepts the following message:

CreateOfficeModeTimeProfileMapi

Required permission: CreateTimeProfile

Events confirming this command:

• OfficeModeTimeProfileCreated

object

array<object>

Array. Time intervals for allowing/disallowing entry.

array<object>

Array. Time intervals for allowing/disallowing entry at exceptional dates (holidays etc.).

array<object>

Array. Time of a day in a specific weekday, used to end the allowed entry at exceptional dates (holidays etc.).

name

string

All unicode characters allowed. Size between 1 and 50. Required.

description

string

All unicode characters allowed. Size between 0 and 255.

array<object>

Array. Time of a day in a specific weekday, used to end the allowed entry.

string

format: uuid

Format: UUID, Required.

commandId

string

format: uuid

Format: UUID, Required.

token

string

Required.

Additional properties are allowed.

Examples

{
  "timeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "days": [
        "string"
      ]
    }
  ],
  "exceptionTimeSeries": [
    {
      "times": [
        {
          "start": "14:15:22Z",
          "end": "14:15:22Z"
        }
      ],
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ],
  "exceptionTimePointSeries": [
    {
      "calendars": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "points": [
        "14:15:22Z"
      ]
    }
  ],
  "name": "string",
  "description": "string",
  "timePointSeries": [
    {
      "days": [
        "string"
      ],
      "points": [
        "14:15:22Z"
      ]
    }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/CreatePersonMapi

#Command

Accepts the following message:

CreatePersonMapi

Creates a new Person.

Required permission: CreatePerson

Events confirming this command:

• PersonCreated

object

Examples

{
  "firstName": "string",
  "lastName": "string",
  "identifier": "string",
  "externalId": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/CreateZoneMapi

#Command

Accepts the following message:

CreateZoneMapi

Creates a new Zone.

Required permission: CreateZone

Events confirming this command:

• ZoneCreated

object

Examples

{
  "installationPoints": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "name": "string",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/DeleteAuthorizationProfileMapi

#Command

Accepts the following message:

DeleteAuthorizationProfileMapi

Required permission: RemoveAuthorizationProfile

Events confirming this command:

• AuthorizationProfileDeleted

object

Examples

PUB xs3/1/cmd/DeleteAuthorizationTimeProfileMapi

#Command

Accepts the following message:

DeleteAuthorizationTimeProfileMapi

Required permission: RemoveTimeProfile

Events confirming this command:

• AuthorizationTimeProfileDeleted

object

Examples

PUB xs3/1/cmd/DeleteCalendarMapi

#Command

Accepts the following message:

DeleteCalendarMapi

Required permission: RemoveCalendar

Events confirming this command:

• CalendarDeleted

object

Examples

PUB xs3/1/cmd/DeleteCodingStationMapi

#Command

Accepts the following message:

DeleteCodingStationMapi

Required permission: RemoveCodingStation

Events confirming this command:

• CodingStationDeleted

object

Examples

PUB xs3/1/cmd/DeleteInstallationPointMapi

#Command

Accepts the following message:

DeleteInstallationPointMapi

Required permission: RemoveInstallationPoint

Events confirming this command:

• InstallationPointDeleted

object

Examples

PUB xs3/1/cmd/DeleteOfficeModeTimeProfileMapi

#Command

Accepts the following message:

DeleteOfficeModeTimeProfileMapi

Required permission: RemoveTimeProfile

Events confirming this command:

• OfficeModeTimeProfileDeleted

object

Examples

PUB xs3/1/cmd/DeletePersonMapi

#Command

Accepts the following message:

DeletePersonMapi

Required permission: RemovePerson

Events confirming this command:

• PersonDeleted

object

Examples

PUB xs3/1/cmd/DeleteZoneMapi

#Command

Accepts the following message:

DeleteZoneMapi

Required permission: RemoveZone

Events confirming this command:

• ZoneDeleted

object

Examples

PUB xs3/1/cmd/FindComponent

#Command

Accepts the following message:

FindComponent

Enable/disable the beeping signal to find the component.

Required permission: SearchOnlineEvvaComponent

Events confirming this command:

• FindComponentPerformed

object

Examples

{
  "enable": true,
  "installationPointId": "39b25462-2580-44dc-b0a8-22fd6c03a023",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/ForceRemoveEvvaComponentMapi

#Command

Accepts the following message:

ForceRemoveEvvaComponentMapi

Required permission: RemoveFaultyEvvaComponent

Events confirming this command:

• EvvaComponentRemoved

object

Examples

PUB xs3/1/cmd/LockMediumMapi

#Command

Accepts the following message:

LockMediumMapi

Required permission: LockMedium

Events confirming this command:

• MediumLocked

object

Examples

PUB xs3/1/cmd/Login

#Session

Accepts the following message:

Events confirming this command:

• LoginPerformed

object

Examples

PUB xs3/1/cmd/Logout

#Session

Accepts the following message:

Logout

Events confirming this command:

• LoggedOut

object

Examples

PUB xs3/1/cmd/PrepareRemovalOfEvvaComponentMapi

#Command

Accepts the following message:

PrepareRemovalOfEvvaComponentMapi

Required permission: RemoveEvvaComponent

Events confirming this command:

• EvvaComponentRemovalPrepared

object

Examples

PUB xs3/1/cmd/RemoteDisengage

#Command

Accepts the following message:

RemoteDisengage

Required permission: TriggerRemoteDisengage

Events confirming this command:

• RemoteDisengagePerformed

object

Examples

{
  "installationPointId": "39b25462-2580-44dc-b0a8-22fd6c03a023",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "extended": true,
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/RemoteDisengagePermanent

#Command

Accepts the following message:

RemoteDisengagePermanent

Required permission: TriggerRemoteDisengage

Events confirming this command:

• RemoteDisengagePermanentPerformed

object

Examples

{
  "enable": true,
  "installationPointId": "39b25462-2580-44dc-b0a8-22fd6c03a023",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/RemoveInstallationPointAuthorizationFromMediumMapi

#Command

Accepts the following message:

RemoveInstallationPointAuthorizationFromMediumMapi

Required permission: RemoveInstallationPointIndividualAuthorization

Events confirming this command:

• IndividualAuthorizationsDeleted

object

Examples

{
  "authorization": "494fc759-21c3-4d93-b3ae-d129c5b36271",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/RemoveInstallationPointFromZoneMapi

#Command

Accepts the following message:

RemoveInstallationPointFromZoneMapi

Required permission: RemoveInstallationPointFromZone

Events confirming this command:

• InstallationPointsInZoneChanged

object

Examples

{
  "installationPointId": "39b25462-2580-44dc-b0a8-22fd6c03a023",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/RemoveZoneAuthorizationFromMediumMapi

#Command

Accepts the following message:

RemoveZoneAuthorizationFromMediumMapi

Remove individual authorisation for a zone.

Required permission: RemoveZoneIndividualAuthorization

Events confirming this command:

• IndividualAuthorizationsDeleted

object

Examples

{
  "authorization": "494fc759-21c3-4d93-b3ae-d129c5b36271",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/RequestAddMediumToInstallationMapi

#Command

Accepts the following message:

RequestAddMediumToInstallationMapi

The AddMediumToInstallationMapi command is used specifically for adding passive identification mediums, and the AddSmartphoneToInstallationMapi command is dedicated to adding smartphone identification mediums, all other commands related to identification mediums can be used for modifying both smartphone identification mediums and other types of identification mediums. For further details on the specific Smarpthone MAPI command, please $refer to the corresponding section in the documentation: {@link AddSmartphoneToInstallationMapi}.

Required permission: AddIdentificationMedium

Events confirming this command:

• AddMediumToInstallationRequested

• MediumAddedToInstallation

object

Examples

{
  "hardwareId": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "terminalId": "57e69e1b-2c00-4a26-b5e3-44617c6cc659",
  "label": "string",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/RequestNewRegistrationCodeMapi

#Command

Accepts the following message:

RequestNewRegistrationCodeMapi

Required permission: ChangeIssuedMedium

Events confirming this command:

• NewRegistrationCodeRequested

object

Examples

PUB xs3/1/cmd/ResendSmartphoneAuthorizationsMapi

#Command

Accepts the following message:

ResendSmartphoneAuthorizationsMapi

Required permission: ChangeIssuedMedium

Events confirming this command:

• SmartphoneAuthorizationsResent

object

Examples

PUB xs3/1/cmd/RevertPrepareRemovalOfEvvaComponentMapi

#Command

Accepts the following message:

RevertPrepareRemovalOfEvvaComponentMapi

Required permission: RevertRemoveComponent

Events confirming this command:

• PrepareEvvaComponentRemovalReverted

object

Examples

PUB xs3/1/cmd/SetAccessBeginAtMapi

#Command

Accepts the following message:

SetAccessBeginAtMapi

Sets the access begin of an identification medium.

Required permission: SetAuthorizationBeginAtOnMedium

Events confirming this command:

• MediumChanged

object

Examples

{
  "accessBeginAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetAccessEndAtMapi

#Command

Accepts the following message:

SetAccessEndAtMapi

Sets the access end of an identification medium.

Required permission: SetAuthorizationEndAtOnMedium

Events confirming this command:

• MediumChanged

object

Examples

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string",
  "accessEndAt": "2019-08-24T14:15:22Z"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetDailySchedulerExecutionTimeMapi

#Command

Accepts the following message:

SetDailySchedulerExecutionTimeMapi

Required permission: ConfigureDailySchedulerExecutionTime

Events confirming this command:

• PartitionChanged

object

Examples

PUB xs3/1/cmd/SetDefaultAuthorizationProfileForPersonMapi

#Command

Accepts the following message:

SetDefaultAuthorizationProfileForPersonMapi

Required permission: SetDefaultAuthorizationProfileForPerson

Events confirming this command:

• PersonChanged

object

Examples

PUB xs3/1/cmd/SetDefaultDisengagePeriodForPersonMapi

#Command

Accepts the following message:

SetDefaultDisengagePeriodForPersonMapi

Set whether short or long disengage period for a person.

Required permission: SetDefaultDisengagePeriodForPerson

Events confirming this command:

• PersonChanged

object

Examples

PUB xs3/1/cmd/SetDefaultSmartphoneValidityDurationMapi

#Command

Accepts the following message:

SetDefaultSmartphoneValidityDurationMapi

Required permission: SetDefaultMediumValidityDurationForPartition

Events confirming this command:

• PartitionChanged

object

Examples

PUB xs3/1/cmd/SetDefaultValidityDurationMapi

#Command

Accepts the following message:

SetDefaultValidityDurationMapi

Required permission: SetDefaultMediumValidityDurationForPartition

Events confirming this command:

• PartitionChanged

object

Examples

PUB xs3/1/cmd/SetDisengagePeriodOnMediumMapi

#Command

Accepts the following message:

SetDisengagePeriodOnMediumMapi

Required permission: ChangeDisengagePeriodOnMedium

Events confirming this command:

• MediumChanged

object

Examples

{
  "disengagePeriod": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetInstallationPointPersonalReferenceDurationMapi

#Command

Accepts the following message:

SetInstallationPointPersonalReferenceDurationMapi

Required permission: ConfigureDefaultLoggingPersonalDataForInstallationPoint

Events confirming this command:

• PartitionChanged

object

Examples

{
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetLabelOnMediumMapi

#Command

Accepts the following message:

SetLabelOnMediumMapi

Required permission: SetMediumLabel

Events confirming this command:

• MediumChanged

object

Examples

PUB xs3/1/cmd/SetMessageLanguageOnSmartphoneMapi

#Command

Accepts the following message:

SetMessageLanguageOnSmartphoneMapi

Required permission: SetMediumLabel

Events confirming this command:

• MediumChanged

object

Examples

{
  "messageLanguage": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetPersonPersonalReferenceDurationMapi

#Command

Accepts the following message:

SetPersonPersonalReferenceDurationMapi

Set the default value for personal $reference duration in the installation settings.

Required permission: ConfigureDefaultLoggingPersonalDataForPerson

Events confirming this command:

• PartitionChanged

object

Examples

{
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetPersonalReferenceDurationForInstallationPointMapi

#Command

Accepts the following message:

SetPersonalReferenceDurationForInstallationPointMapi

Required permission: ConfigureLoggingPersonalDataForInstallationPoint

Events confirming this command:

• InstallationPointChanged

object

Examples

{
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetPersonalReferenceDurationInPersonMapi

#Command

Accepts the following message:

SetPersonalReferenceDurationInPersonMapi

Required permission: ConfigureLoggingPersonalDataForPerson

Events confirming this command:

• PersonChanged

object

Examples

{
  "newValue": {
    "days": 0,
    "logMode": "string"
  },
  "externalId": "string",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetPhoneNumberOnSmartphoneMapi

#Command

Accepts the following message:

SetPhoneNumberOnSmartphoneMapi

Required permission: SetMediumLabel

Events confirming this command:

• MediumChanged

• PhoneNumberChanged

object

Examples

{
  "phoneNumber": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/cmd/SetReplacementMediumDurationMapi

#Command

Accepts the following message:

SetReplacementMediumDurationMapi

Required permission: SetDefaultAccessDurationForReplacedMedium

Events confirming this command:

• PartitionChanged

object

Examples

PUB xs3/1/cmd/SetValidityDurationMapi

#Command

Accepts the following message:

SetValidityDurationMapi

Required permission: ChangeValidityDurationOnMedium

Events confirming this command:

• MediumChanged

object

Examples

PUB xs3/1/cmd/SetValidityThresholdMapi

#Command

Accepts the following message:

SetValidityThresholdMapi

Required permission: ConfigureValidityThreshold

Events confirming this command:

• PartitionChanged

object

Examples

PUB xs3/1/cmd/UnregisterSmartphoneMapi

#Command

Accepts the following message:

UnregisterSmartphoneMapi

Required permission: ChangeIssuedMedium

Events confirming this command:

• SmartphoneUnregistered

object

Examples

PUB xs3/1/cmd/WithdrawAuthorizationProfileFromMediumMapi

#Command

Accepts the following message:

WithdrawAuthorizationProfileFromMediumMapi

@see @{@link com.evva.aess.writeside.identificationmedium.event.AuthorizationProfileWithdrawnFromMedium} or at AuthorizationProfileWithdrawnFromMedium.

Required permission: WithdrawAllAuthorizations

Events confirming this command:

• AuthorizationProfileWithdrawnFromMedium

object

Examples

{
  "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
  "token": "string"
}

This example has been generated automatically.

PUB xs3/1/q

#Query

Accepts the following message:

ApiQueryRequest

Request payload for queries.
To get the wanted resource, you need to have the needed permissions for access as described below..

Resource	Item permission	List permission
access-protocol	-	ViewAccessProtocol
authorization-profiles	ViewAuthorizationProfile	ViewAllAuthorizationProfiles
calendars	ViewCalendar	ViewAllCalendars
coding-stations	ViewCodingStation	ViewAllCodingStations
evva-components	ViewInstallationPoint	ViewAllInstallationPoints
identification-media	ViewMedium	ViewAllIdentificationMedia
installation-points	ViewInstallationPoint	ViewAllInstallationPoints
office-modes	-	ViewAllOfficeModes
persons	ViewPerson	ViewAllPersons
time-profiles	ViewTimeProfile	ViewAllTimeProfiles
users	-	ViewAllPersons
zones	ViewZone	ViewAllZones

object

Examples

{
  "resource": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "params": {
    "DEFAULT_LANGUAGE": "string",
    "pageLimit": 0,
    "DEFAULT_SORT": "string",
    "DEFAULT_PAGE_OFFSET": 0,
    "pageOffset": 0,
    "language": "string",
    "sort": "string",
    "filters": [
      {
        "field": "string",
        "type": "string",
        "value": "string"
      }
    ],
    "DEFAULT_PAGE_LIMIT": 0
  },
  "token": "string"
}

This example has been generated automatically.

SUB xs3/1/{userId}/LoggedIn

#Session

Accepts the following message:

LoginPerformed

Topic to get the token for the given user after login, to publish all other commands.

object

Examples

SUB xs3/1/{userId}/err

#Errors

Accepts the following message:

ApiError

Topic to get error messages for the given user.

object

Examples

SUB xs3/1/{userId}/q

#Query

Accepts one of the following messages:

#0QueryResponse-authorization-profiles

object

Examples

{
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "response": {
    "installationPoints": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
      }
    ],
    "manualOfficeMode": true,
    "name": "string",
    "description": "string",
    "standardTimeProfile": "4b454e4e-8c15-4284-9813-390c18525cfc",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "zones": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40"
      }
    ],
    "anyAuthorizations": true
  }
}

This example has been generated automatically.

#1QueryResponse-access-protocol
object
requestId
string
format: uuid
Format: UUID.

object
response

eventNumber
integer
format: int32
The identifier of the event type, e.g. 0x0001 for {@link EventType#NORMAL_OPENING}.

mediumIdentifier
integer
format: int64
Format: Long.

timestampComponentLocal
string
format: date-time
Format: LocalDateTime.

timestampUtc
string
format: date-time
Format: LocalDateTime.

eventType
string
Allowed values: NORMAL_OPENING, EMERGENCY_OPENING, MANUAL_OPENING_STARTED, MANUAL_OPENING_FINISHED, MEDIA_RESTRICTED, MEDIUM_CHANGED, PROLONGED_NORMAL_OPENING, PROLONGED_MASTER_KEY_OPENING, OPENING_MASTER_KEY_IGNORED_BLACKLIST, OPENING_MASTER_KEY_PROLONGED_IGNORED_BLACKLIST, OPENING_NORMAL_BLACKLISTED, OPENING_EMERGENCY_BLACKLISTED, MANUAL_OPENING_STARTED_BLACKLISTED, OPENING_NORMAL_PROLONGED_BLACKLISTED, OPENING_EMERGENCY_PROLONGED_BLACKLISTED, OPENING_EMERGENCY_INVALID_BLACKLIST_OR_TIME_BLACKLISTED, OPENING_EMERGENCY_PROLONGED_INVALID_BLACKLIST_OR_TIME_BLACKLISTED, OPENING_NORMAL_SWITCH, OPENING_NORMAL_REMOTE, MANUAL_OPENING_STARTED_REMOTE, MANUAL_OPENING_FINISHED_REMOTE, OPENING_NORMAL_PROLONGED_REMOTE, TIMED_OPENING_STARTED, TIMED_OPENING_FINISHED, TIMED_OPENING_SKIPPED, TIME_CHANGE_EXECUTED, INIT_DATA, UPDATE_KEY, PERMIT_INIT_TIME, INIT_TIME, SET_DOOR_ID, INIT_DOORAREAS, INIT_SPECIALDAY_RESET, INIT_SPECIALDAY, INIT_TIMED_OPENING, INIT_DST, INIT_PERMANENT_OPENING_ALLOWED, INIT_BLACKLIST, INIT_OPENING_TIME, KILL_MEDIUM, BLACKLIST_VERSION_ERROR, FW_UPDATE_PERFORMED, FW_UPDATED, FW_UPDATED_PARTIAL_FAIL, FW_UPDATED_TOTAL_FAIL, MIDNIGHT_DEBUG, PANIC_EXIT, RTC_ERROR, RTC_OFFSET, ED_DATA_ERROR, START_AND_ELOG, NONCE_OFFSET, BATTERY_EMPTY, EEPROM_REINITIALIZED, STARTING_UP, ELOG_INITIALIZED, DEBUG_MESSAGE, ABC_INITIALIZED, ABC_ADD_DELTABLACKLIST, UNEXPECTED_ABC_LOG_RESP, IO_INPUT_CHANGED, UNKNOWN.

identificationMediumId
string
format: uuid
Format: UUID.

receivedAt
string
format: date-time
Format: LocalDateTime. The UTC time when the log entry was received by the backend.

ttl
string
format: date-time
Format: LocalDateTime.

accessId
integer
format: int64
Format: Long.

installationPointName
string
object
shopModeActivated
boolean
timestampFrom
string
format: date-time
Format: LocalDateTime.

fwVersionChanges
string
mediumIdentifier
integer
format: int64
Format: Long.

errorCodes
string
doorOpening
boolean
errorReaction
integer
format: int32
initializationReason
integer
format: int32
mediaRestrictedReason
integer
format: int32
accessId
integer
format: int64
Format: Long.

timestampTo
string
format: date-time
Format: LocalDateTime.

errorModule
integer
format: int32
inputState
integer
format: int32
keyType
integer
format: int32
mediaChangedReason
integer
format: int32
componentType
string
The type of component installed in the installation point. Allowed values: Handle, Escutcheon, Cylinder, WallReader, WallReader2x, OnlineWallReader.

raw
string
inputNr
integer
format: int32
nonceInHardware
integer
format: int64
Format: Long.

officeModeAllowed
boolean
fwUpdatePerformed
boolean
deltablacklistUid
integer
format: int32
fwUpdateStatus
string
nonceInSoftware
integer
format: int64
Format: Long.

mediaUpgrade
boolean
errorLocation
integer
format: int32
startingUp
string
errorNumber
string
Additional properties are allowed.
object
Additional properties are allowed.
entryIdentificator
integer
format: int32
rawValue
string
Bytes as hex string.

groupOfEvent
string
Allowed values: NoGroup, MediumEvents, EvvaComponent, MaintenanceComponent, AdministrationComponent.

person
string
installationPointId
string
format: uuid
Format: UUID.

personId
string
format: uuid
Format: UUID.

id
string
format: uuid
Format: UUID.

identificationMediumLabel
string
object
Format: Map. This is the parameter map taken from @{@link com.evva.xesar.communication.hardware.eventlog.EventLogEntryImpl} We keep this map because, @{@link EventLogEntryValue} does not contain all entries from the parameter map.

Additional properties are allowed.
installationPointIdentifier
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "eventNumber": 0, "mediumIdentifier": 0, "timestampComponentLocal": "2019-08-24T14:15:22Z", "timestampUtc": "2019-08-24T14:15:22Z", "eventType": "string", "identificationMediumId": "37afba11-94ad-41ed-a812-a05fb8239708", "receivedAt": "2019-08-24T14:15:22Z", "ttl": "2019-08-24T14:15:22Z", "accessId": 0, "installationPointName": "string", "eventValue": { "shopModeActivated": true, "timestampFrom": "2019-08-24T14:15:22Z", "fwVersionChanges": "string", "mediumIdentifier": 0, "errorCodes": "string", "doorOpening": true, "errorReaction": 0, "initializationReason": 0, "mediaRestrictedReason": 0, "accessId": 0, "timestampTo": "2019-08-24T14:15:22Z", "errorModule": 0, "inputState": 0, "keyType": 0, "mediaChangedReason": 0, "componentType": "string", "raw": "string", "inputNr": 0, "nonceInHardware": 0, "officeModeAllowed": true, "fwUpdatePerformed": true, "deltablacklistUid": 0, "fwUpdateStatus": "string", "nonceInSoftware": 0, "mediaUpgrade": true, "errorLocation": 0, "startingUp": "string", "errorNumber": "string" }, "zoneIds": {}, "entryIdentificator": 0, "rawValue": "string", "groupOfEvent": "string", "person": "string", "installationPointId": "39b25462-2580-44dc-b0a8-22fd6c03a023", "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identificationMediumLabel": "string", "parameterMap": {}, "installationPointIdentifier": "string" } }

This example has been generated automatically.
#2QueryResponse-installation-points
object
requestId
string
format: uuid
Format: UUID.

object
response

componentType
string
releaseDurationShort
integer
format: int32
bluetoothState
string
Settings for BLE Allowed values: ENABLED, DISABLED, NOT_SUPPORTED.

timeProfileName
string
onlineStatus
string
description
string
object
Additional properties are allowed.
secure
boolean
timeProfileId
string
format: uuid
Format: UUID.

accessId
integer
format: int64
Format: Long.

shopMode
boolean
releaseDurationLong
integer
format: int32
installationType
string
bleStatus
string
The status of the BLE component of an EVVA component Allowed values: ON, OFF, NO_BLE.

manualOfficeMode
boolean
batteryCondition
string
name
string
days
integer
format: int32
id
string
format: uuid
Format: UUID.

installationId
string
logMode
string
openDoor
boolean
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "componentType": "string", "releaseDurationShort": 0, "bluetoothState": "string", "timeProfileName": "string", "onlineStatus": "string", "description": "string", "linkedInstallationPoints": {}, "secure": true, "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40", "accessId": 0, "shopMode": true, "releaseDurationLong": 0, "installationType": "string", "bleStatus": "string", "manualOfficeMode": true, "batteryCondition": "string", "name": "string", "days": 0, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "installationId": "string", "logMode": "string", "openDoor": true } }

This example has been generated automatically.
#3QueryResponse-office-modes
object
requestId
string
format: uuid
Format: UUID.

object
response

timeProfileDetails
string
timeProfileName
string
array<object>
Array

array<string>
Array. List of calendar IDs.

Items:
string
format: uuid
List of calendar IDs.

array<string>
Array. List of time points. Example: ["10:00", "12:00"].

Items:
string
format: time
List of time points. Example: ["10:00", "12:00"].

timeProfileId
string
format: uuid
Format: UUID.

installationPointDescription
string
installationPointName
string
shopMode
boolean
array<object>
Array

array<object>
Array. A list of time intervals.

start
string
format: time
Format: LocalTime, Example: "10:00".

Required.

end
string
format: time
Format: LocalTime, Example: "23:59".

Required.

array<string>
Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

Items:
string
Allowed values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

installationType
string
manualOfficeMode
boolean
array<object>
Array

array<object>
Array. A list of time intervals.

start
string
format: time
Format: LocalTime, Example: "10:00".

Required.

end
string
format: time
Format: LocalTime, Example: "23:59".

Required.

array<string>
Array. List of calendar IDs.

Items:
string
format: uuid
List of calendar IDs.

installationPointId
string
format: uuid
Format: UUID.

array<object>
Array

array<string>
Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

Items:
string
Allowed values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. List of weekdays. Example: ["MONDAY", "SATURDAY"].

array<string>
Array. List of time points. Example: ["11:00", "18:45"].

Items:
string
format: time
List of time points. Example: ["11:00", "18:45"].

id
string
format: uuid
Format: UUID.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "timeProfileDetails": "string", "timeProfileName": "string", "exceptionTimePointSeries": [ { "calendars": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "points": [ "14:15:22Z" ] } ], "timeProfileId": "6c791d61-3d3c-4f4f-a16f-2a2d2823ab40", "installationPointDescription": "string", "installationPointName": "string", "shopMode": true, "timeSeries": [ { "times": [ { "start": "14:15:22Z", "end": "14:15:22Z" } ], "days": [ "string" ] } ], "installationType": "string", "manualOfficeMode": true, "exceptionTimeSeries": [ { "times": [ { "start": "14:15:22Z", "end": "14:15:22Z" } ], "calendars": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] } ], "installationPointId": "39b25462-2580-44dc-b0a8-22fd6c03a023", "timePointSeries": [ { "days": [ "string" ], "points": [ "14:15:22Z" ] } ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }

This example has been generated automatically.
#4QueryResponse-users
object
requestId
string
format: uuid
Format: UUID.

object
response

lastLogin
string
format: date-time
Format: LocalDateTime.

lastActive
string
format: date-time
Format: LocalDateTime.

loginType
string
loginIp
string
name
string
description
string
active
boolean
id
string
format: uuid
Format: UUID.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "lastLogin": "2019-08-24T14:15:22Z", "lastActive": "2019-08-24T14:15:22Z", "loginType": "string", "loginIp": "string", "name": "string", "description": "string", "active": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }

This example has been generated automatically.
#5QueryResponse-zones
object
requestId
string
format: uuid
Format: UUID.

object
response

object
Additional properties are allowed.
partitionId
string
format: uuid
Format: UUID.

installationPointCount
integer
format: int32
name
string
description
string
id
string
format: uuid
Format: UUID.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "installationPoints": {}, "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2", "installationPointCount": 0, "name": "string", "description": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }

This example has been generated automatically.
#6QueryResponse-time-profiles
object
requestId
string
format: uuid
Format: UUID.

object
response

array<object>
Array

array<object>
Array. A list of time intervals.

start
string
format: time
Format: LocalTime, Example: "10:00".

Required.

end
string
format: time
Format: LocalTime, Example: "23:59".

Required.

array<string>
Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

Items:
string
Allowed values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

array<object>
Array

array<object>
Array. A list of time intervals.

start
string
format: time
Format: LocalTime, Example: "10:00".

Required.

end
string
format: time
Format: LocalTime, Example: "23:59".

Required.

array<string>
Array. List of calendar IDs.

Items:
string
format: uuid
List of calendar IDs.

array<object>
Array

array<string>
Array. List of calendar IDs.

Items:
string
format: uuid
List of calendar IDs.

array<string>
Array. List of time points. Example: ["10:00", "12:00"].

Items:
string
format: time
List of time points. Example: ["10:00", "12:00"].

name
string
description
string
array<object>
Array

array<string>
Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

Items:
string
Allowed values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. List of weekdays. Example: ["MONDAY", "SATURDAY"].

array<string>
Array. List of time points. Example: ["11:00", "18:45"].

Items:
string
format: time
List of time points. Example: ["11:00", "18:45"].

id
string
format: uuid
Format: UUID.

type
string
Allowed values: OFFICE_MODE, AUTHORIZATION_PROFILE.

validStandardTimeProfile
boolean
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "timeSeries": [ { "times": [ { "start": "14:15:22Z", "end": "14:15:22Z" } ], "days": [ "string" ] } ], "exceptionTimeSeries": [ { "times": [ { "start": "14:15:22Z", "end": "14:15:22Z" } ], "calendars": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] } ], "exceptionTimePointSeries": [ { "calendars": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "points": [ "14:15:22Z" ] } ], "name": "string", "description": "string", "timePointSeries": [ { "days": [ "string" ], "points": [ "14:15:22Z" ] } ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "validStandardTimeProfile": true } }

This example has been generated automatically.
#7QueryResponse-identification-media
object
requestId
string
format: uuid
Format: UUID.

object
response

accessBeginAt
string
format: date-time
Format: LocalDateTime.

validityBeginAtInHardware
string
format: date-time
Format: LocalDateTime.

softwareStatus
string
This enum serves only for categories of textual descriptions in frontend (they are easier to understand for the users). Check MediumDisplayState for inner, logical categorizations of the medium state. Cases: See <a h$ref="https://wiki.evva.com/pages/viewpage.action?pageId=40912106">... Allowed values: UNAUTHORIZED, LOCKED_INSECURE, LOCKED_SECURE, DEACTIVATED, ACTIVE, INACTIVE, EMPTY, REVOKED, UNLINKED.

authorizationProfileName
string
object
Additional properties are allowed.
disengagePeriod
string
How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

authorizationProfileId
string
format: uuid
Format: UUID.

mediumIdentifier
integer
format: int64
Format: Long.

messageLanguage
string
secure
boolean
registrationCodeValidUntil
string
format: date-time
Format: LocalDateTime.

outdated
boolean
registrationCode
string
id
string
format: uuid
Format: UUID.

issuedAt
string
format: date-time
Format: LocalDateTime.

syncedAt
string
format: date-time
Format: LocalDateTime.

hardwareStatus
string
This enum serves only for categories of textual descriptions in frontend (they are easier to understand for the users). Check MediumDisplayState for inner, logical categorizations of the medium state. Cases: See <a h$ref="https://wiki.evva.com/pages/viewpage.action?pageId=40912106">... Allowed values: ACTIVE, INACTIVE, EMPTY, NEW, DEACTIVATED.

label
string
validityEndAtInHardware
string
format: date-time
Format: LocalDateTime.

userName
string
mediumState
string
Allowed values: INCOMPATIBLE, NEW, UNAUTHORIZED, ACTIVE, INACTIVE, LOCKED, DEACTIVATED, SYSTEM_ALIEN, INSTALLATION_ALIEN, FAULTY, REVOKED, UNLINKED.

validityBeginAt
string
format: date-time
Format: LocalDateTime.

userId
string
format: uuid
Format: UUID.

requiredAction
string
The action that is required for a medium from a users perspective Allowed values: UPDATE, EXECUTE_TASK, NONE.

accessEndAt
string
format: date-time
Format: LocalDateTime.

validityEndAt
string
format: date-time
Format: LocalDateTime.

external
boolean
fitsOnHardware
boolean
phoneNumber
string
hardwareId
string
person
string
validityDuration
integer
format: int32
Format: Short.

mediumType
string
Allowed values: SMARTPHONE, PASSIVE.

personId
string
format: uuid
Format: UUID.

nativeId
string
registrationState
string
Allowed values: STARTED, REGISTRATION_REQUESTED, COMPLETED, UNREGISTRATION_STARTED, REMOVED.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "accessBeginAt": "2019-08-24T14:15:22Z", "validityBeginAtInHardware": "2019-08-24T14:15:22Z", "softwareStatus": "string", "authorizationProfileName": "string", "individualAuthorizationProfileIds": {}, "disengagePeriod": "string", "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee", "mediumIdentifier": 0, "messageLanguage": "string", "secure": true, "registrationCodeValidUntil": "2019-08-24T14:15:22Z", "outdated": true, "registrationCode": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "issuedAt": "2019-08-24T14:15:22Z", "syncedAt": "2019-08-24T14:15:22Z", "hardwareStatus": "string", "label": "string", "validityEndAtInHardware": "2019-08-24T14:15:22Z", "userName": "string", "mediumState": "string", "validityBeginAt": "2019-08-24T14:15:22Z", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "requiredAction": "string", "accessEndAt": "2019-08-24T14:15:22Z", "validityEndAt": "2019-08-24T14:15:22Z", "external": true, "fitsOnHardware": true, "phoneNumber": "string", "hardwareId": "string", "person": "string", "validityDuration": 0, "mediumType": "string", "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a", "nativeId": "string", "registrationState": "string" } }

This example has been generated automatically.
#8QueryResponse-evva-components
object
requestId
string
format: uuid
Format: UUID.

object
response

componentType
string
serialNumber
string
upgradeMedia
boolean
batteryCondition
string
btbFirmwareVersion
string
id
string
format: uuid
Format: UUID.

batteryStatusUpdatedAt
string
format: date-time
Format: LocalDateTime.

stateChangedAt
string
format: date-time
Format: LocalDateTime.

firmwareVersion
string
status
string
bleMac
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "componentType": "string", "serialNumber": "string", "upgradeMedia": true, "batteryCondition": "string", "btbFirmwareVersion": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "batteryStatusUpdatedAt": "2019-08-24T14:15:22Z", "stateChangedAt": "2019-08-24T14:15:22Z", "firmwareVersion": "string", "status": "string", "bleMac": "string" } }

This example has been generated automatically.
#9QueryResponse-coding-stations
object
requestId
string
format: uuid
Format: UUID.

object
response

online
boolean
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "online": true } }

This example has been generated automatically.
#10QueryResponse-persons
object
requestId
string
format: uuid
Format: UUID.

object
response

lastName
string
identifier
string
isExternal
boolean
partitionId
string
format: uuid
Format: UUID.

object
days
integer
format: int32
Min: 0. Max: 9999.

logMode
string
Should the personal data (for example, person names in access logs) be saved? Allowed values: dontSave, saveUnlimited, saveForDays.

Additional properties are allowed.
disengagePeriod
string
How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

identificationMediaCount
integer
format: int32
defaultAuthorizationProfile
string
externalId
string
object
Additional properties are allowed.
firstName
string
defaultAuthorizationProfileId
string
format: uuid
Format: UUID.

outdatedMedia
boolean
object
Additional properties are allowed.
id
string
format: uuid
Format: UUID.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "lastName": "string", "identifier": "string", "isExternal": true, "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2", "personalReferenceDuration": { "days": 0, "logMode": "string" }, "disengagePeriod": "string", "identificationMediaCount": 0, "defaultAuthorizationProfile": "string", "externalId": "string", "zones": {}, "firstName": "string", "defaultAuthorizationProfileId": "77cccd07-4dc5-4175-a09a-cd4ad954feee", "outdatedMedia": true, "installationPoints": {}, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }

This example has been generated automatically.
#11QueryResponse-calendars
object
requestId
string
format: uuid
Format: UUID.

object
response

serialVersionUID
integer
format: int64
Format: long.

partitionId
string
format: uuid
Format: UUID.

name
string
array<string>
Array

Items:
string
format: date
id
string
format: uuid
Format: UUID.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6", "response": { "serialVersionUID": 0, "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2", "name": "string", "specialDays": [ "2019-08-24" ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }

This example has been generated automatically.

Schemas

Boolean

boolean

uid: Boolean

object

uid: InetAddress

Integer

integer

format: int32uid: Integer

LocalDate

string

format: dateuid: LocalDate

Local date. Example: 2018-02-25

LocalDateTime

string

format: date-timeuid: LocalDateTime

Local date & time. Example: 2018-02-25T23:59

LocalTime

string

format: timeuid: LocalTime

Local time. Example: 23:59

Long

integer

format: int64uid: Long

object

uid: Map

Short

integer

format: int32uid: Short

String

string

uid: String

UUID

string

format: uuiduid: UUID

Universally Unique Identifier

object

uid: UUID[]

object

uid: ZoneOffsetTransition

boolean

uid: boolean

object

uid: byte[]

object

uid: char

int

integer

format: int32uid: int

long

integer

format: int64uid: long