NAV Navigation
Payload

Xesar 3 Third Party Interface

Scroll down for code samples, example headers and payloads. Select a language for code samples from the tabs above or the mobile navigation menu.

This document gives an introduction to the PubSub interface provided by Xesar 3. It also lists all topics and messages of the API.

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:

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.

PubSub Overview

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 Subsciber 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:

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

Event subscription overview

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 certficate can be obtained through the user interface.

Xesar 3 XS3 Download Client Package

Xesar 3 Service Pack 1 XS3 SP1 Download Client Package

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

Addtional session key=value pairs

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

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

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 XS 3 Server Client per design, authorization requires a session for the user.

Topic What Description XS3 Server is Session
xs3/1/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.

Establish a session

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

End a session

Publish (Session)

xs3/1/Login

Example payload


{
  "password": "string",
  "commandId": "string",
  "username": "string"
}

Events confirming this command:

LoggedIn

Payload

Properties
Name Type Required Description
» password String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» username String false No description

xs3/1/cmd/Logout

Example payload


{
  "token": "string"
}

Events confirming this command:

LoggedOut

Payload

Properties
Name Type Required Description
» token String false No description

Subscribe (Session)

xs3/1/{userId}/LoggedIn

Example payload


{
  "token": "string"
}

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

Confirmed by this event:

Login

Payload

Properties
Name Type Required Description
» token String false No description

xs3/1/ces/LoggedOut

Example payload


{
  "token": "string"
}

Required permission: LoginAdministrationComponent

Commands confirmed by this event:

Logout

Payload

Properties
Name Type Required Description
» token String false No description

xs3/1/ces/UnauthorizedLoginAttempt

Example payload

{
    "event": {
        "username": "interface",
        "channel": "API"
    }
}

Operations that cause this event:

Login

Payload

Properties
Name Type Required Description
» username String true No description
» channel String true No description

Errors

If an error occurs for a received request (e.g. query, command), feedback is given through an error topic that is specific to the user.

Subscribe (Errors)

xs3/1/{userId}/err

Example payload


{
  "reason": "string",
  "correlationId": "string",
  "error": 0
}

Topic to get error messages for the given user.

Payload

Properties
Name Type Required Description
» reason String false No description
» correlationId UUID(uuid) false Universally Unique Identifier
» error int(int32) false No description

System Events

System events wildcard subscription:

xs3/1/ces/+

All system events are issued to a topic with the prefix xs3/1/cse. They can be subscribed separately or using a wildcard (given they are all on the same level, single level wildcard + will suffice).

Subscribe (System Events)

xs3/1/ces/AddMediumToInstallationRequested

Example payload


{
  "aggregateId": "string",
  "hardwareId": {},
  "partitionId": "string",
  "mediumIdentifier": 0,
  "label": "string",
  "terminalId": "string"
}

Commands confirmed by this event:

RequestAddMediumToInstallationMapi

Payload

Properties
Name Type Required Description
» aggregateId UUID(uuid) false Universally Unique Identifier
» hardwareId byte[] false No description
» partitionId UUID(uuid) false Universally Unique Identifier
» mediumIdentifier long(int64) false No description
» label String false No description
» terminalId UUID(uuid) false Universally Unique Identifier

xs3/1/ces/AuthorizationProfileAccessChanged

Example payload


{
  "addedZones": [
    {
      "(array item)": {
        "id": "string",
        "timeProfileId": "string"
      }
    }
  ],
  "addedInstallationPoints": [
    {
      "(array item)": {
        "id": "string",
        "timeProfileId": "string"
      }
    }
  ],
  "addedTimeProfiles": [
    "string"
  ],
  "individual": true,
  "standardTimeProfile": "string",
  "media": [
    "string"
  ],
  "zones": [
    {
      "(array item)": {
        "id": "string",
        "timeProfileId": "string"
      }
    }
  ],
  "removedInstallationPoints": [
    {
      "(array item)": {
        "id": "string",
        "timeProfileId": "string"
      }
    }
  ],
  "removedZones": [
    {
      "(array item)": {
        "id": "string",
        "timeProfileId": "string"
      }
    }
  ],
  "installationPoints": [
    {
      "(array item)": {
        "id": "string",
        "timeProfileId": "string"
      }
    }
  ],
  "manualOfficeMode": true,
  "removedTimeProfiles": [
    "string"
  ],
  "id": "string",
  "oldStandardTimeProfile": "string"
}

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 AuthorizationTimeProfileChanged for this.

Commands confirmed by this event:

ChangeAuthorizationProfileMapi

Payload

Properties
Name Type Required Description
» addedZones [object] false Array
»» (array item) object false No description
»»» id UUID(uuid) false Universally Unique Identifier
»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»» addedInstallationPoints [object] false Array
»»» (array item) object false No description
»»»» id UUID(uuid) false Universally Unique Identifier
»»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»»» addedTimeProfiles [UUID] false Array
»»»» UUID UUID(uuid) false Universally Unique Identifier
»»» individual boolean false No description
»»» standardTimeProfile UUID(uuid) false Universally Unique Identifier
»»» media [UUID] false Array
»»»» UUID UUID(uuid) false Universally Unique Identifier
»»» zones [object] false Array
»»»» (array item) object false No description
»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»»»» removedInstallationPoints [object] false Array
»»»»» (array item) object false No description
»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»»»»» removedZones [object] false Array
»»»»»» (array item) object false No description
»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»»»»»» installationPoints [object] false Array
»»»»»»» (array item) object false No description
»»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»»»»»»» manualOfficeMode Boolean false No description
»»»»»»» removedTimeProfiles [UUID] false Array
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»» oldStandardTimeProfile UUID(uuid) false Universally Unique Identifier

xs3/1/ces/AuthorizationProfileChanged

Example payload


{
  "id": "string"
}

Commands confirmed by this event:

ChangeAuthorizationProfileMapi

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/AuthorizationProfileCreated

Example payload


{
  "individual": true,
  "partitionId": "string",
  "name": "string",
  "description": "string",
  "id": "string",
  "assignable": true
}

Commands confirmed by this event:

CreateAuthorizationProfileMapi

Payload

Properties
Name Type Required Description
» individual boolean false No description
» partitionId UUID(uuid) false Universally Unique Identifier
» name String false No description
» description String false No description
» id UUID(uuid) false Universally Unique Identifier
» assignable Boolean false No description

xs3/1/ces/AuthorizationProfileDeleted

Example payload


{
  "individual": true,
  "installationPoints": [
    "string"
  ],
  "timeProfiles": [
    "string"
  ],
  "id": "string",
  "zones": [
    "string"
  ]
}

Commands confirmed by this event:

DeleteAuthorizationProfileMapi

Payload

Properties
Name Type Required Description
» individual boolean false No description
» installationPoints [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» timeProfiles [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» zones [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier

xs3/1/ces/AuthorizationProfileInfoChanged

Example payload


{
  "name": "string",
  "description": "string",
  "id": "string"
}

Commands confirmed by this event:

ChangeAuthorizationProfileMapi

Payload

Properties
Name Type Required Description
» name String false No description
» description String false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/AuthorizationProfileWithdrawnFromMedium

Example payload


{
  "accessBeginAt": "2019-04-19T08:11:33Z",
  "individualAuthorizationProfileIds": [
    "string"
  ],
  "withdrawnAt": "2019-04-19T08:11:33Z",
  "authorizationProfileId": "string",
  "validUntil": "2019-04-19T08:11:33Z",
  "validFrom": "2019-04-19T08:11:33Z",
  "id": "string",
  "accessEndAt": "2019-04-19T08:11:33Z"
}

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.

Commands confirmed by this event:

WithdrawAuthorizationProfileFromMediumMapi

Payload

Properties
Name Type Required Description
» accessBeginAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» individualAuthorizationProfileIds [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» withdrawnAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» authorizationProfileId UUID(uuid) false Universally Unique Identifier
» validUntil LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» validFrom LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» id UUID(uuid) false Universally Unique Identifier
» accessEndAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59

xs3/1/ces/AuthorizationTimeProfileChanged

Example payload


{
  "timeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "days": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "calendars": [
          "string"
        ]
      }
    }
  ],
  "name": "string",
  "description": "string",
  "id": "string",
  "validStandardTimeProfile": true
}

Commands confirmed by this event:

ChangeAuthorizationTimeProfileMapi

Payload

Properties
Name Type Required Description
» timeSeries [object] false Array
»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»» times [object] false Array. A list of time intervals.
»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»» String String false No description
»»»» exceptionTimeSeries [object] false Array
»»»»» (array item) object false Specifies a set of time intervals that are valid at exceptional days (defined using a calendar).
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» name String false No description
»»»»»»» description String false No description
»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»» validStandardTimeProfile boolean false No description

xs3/1/ces/AuthorizationTimeProfileCreated

Example payload


{
  "timeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "days": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "calendars": [
          "string"
        ]
      }
    }
  ],
  "name": "string",
  "description": "string",
  "id": "string",
  "type": "string",
  "validStandardTimeProfile": true
}

Commands confirmed by this event:

CreateAuthorizationTimeProfileMapi

Payload

Properties
Name Type Required Description
» timeSeries [object] false Array
»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»» times [object] false Array. A list of time intervals.
»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»» String String false No description
»»»» exceptionTimeSeries [object] false Array
»»»»» (array item) object false Specifies a set of time intervals that are valid at exceptional days (defined using a calendar).
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» name String false No description
»»»»»»» description String false No description
»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»» type String false No description
»»»»»»» validStandardTimeProfile boolean false No description

xs3/1/ces/AuthorizationTimeProfileDeleted

Example payload


{
  "id": "string"
}

Commands confirmed by this event:

DeleteAuthorizationTimeProfileMapi

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/CalendarChanged

Example payload


{
  "specialDays": [
    "2019-04-19"
  ],
  "calendarIdentifier": 0,
  "name": "string",
  "id": "string"
}

Commands confirmed by this event:

ChangeCalendarMapi

Payload

Properties
Name Type Required Description
» specialDays [LocalDate] false Array
»» LocalDate LocalDate(date) false Local date. Example: 2018-02-25
» calendarIdentifier Integer(int32) false No description
» name String false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/CalendarCreated

Example payload


{
  "partitionId": "string",
  "specialDays": [
    "2019-04-19"
  ],
  "name": "string",
  "calendarIdentifier": 0,
  "id": "string"
}

Commands confirmed by this event:

CreateCalendarMapi

Payload

Properties
Name Type Required Description
» partitionId UUID(uuid) false Universally Unique Identifier
» specialDays [LocalDate] false Array
»» LocalDate LocalDate(date) false Local date. Example: 2018-02-25
» name String false No description
» calendarIdentifier Integer(int32) false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/CalendarDeleted

Example payload


{
  "calendarIdentifier": 0,
  "id": "string"
}

Commands confirmed by this event:

DeleteCalendarMapi

Payload

Properties
Name Type Required Description
» calendarIdentifier Integer(int32) false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/EvvaComponentAdded

Example payload


{
  "componentParts": [
    {
      "(array item)": {
        "serialNumber": "string",
        "hardwareVersion": {
          "hardwareComponentType": "string",
          "versionHardware": {},
          "productComponentType": "string",
          "subComponent": {}
        },
        "busAddress": 0
      }
    }
  ],
  "serialNumber": "string",
  "batteryWarning": true,
  "batteryCondition": "string",
  "useOddKey": true,
  "onlineStatus": "string",
  "evvaComponentId": "string",
  "id": "string",
  "firmwareVersion": {
    "firmwareVariant": "string",
    "mechanicalVersion": "string",
    "majorBootloader": 0,
    "minor": 0,
    "major": 0,
    "internalRevision": "string",
    "electricalVersion": "string",
    "minorBootloader": 0,
    "firmwareUpdateFileFormatVersion": 0
  },
  "stateChangedAt": "2019-04-19T08:11:33Z",
  "type": "string",
  "nonce": 0,
  "status": "string"
}

Commands confirmed by this event:

CreateInstallationPointMapi

AddEvvaComponentMapi

Payload

Properties
Name Type Required Description
» componentParts [object] false Array
»» (array item) object false No description
»»» serialNumber String false No description
»»» hardwareVersion object false No description
»»»» hardwareComponentType String false No description
»»»» versionHardware char false No description
»»»» productComponentType String false No description
»»»» subComponent char false No description
»»» busAddress int(int32) false No description
»» serialNumber String false No description
»» batteryWarning Boolean false No description
»» batteryCondition String false No description
»» useOddKey boolean false No description
»» onlineStatus String false No description
»» evvaComponentId UUID(uuid) false Universally Unique Identifier
»» id UUID(uuid) false Universally Unique Identifier
»» firmwareVersion object false No description
»»» firmwareVariant String false No description
»»» mechanicalVersion String false No description
»»» majorBootloader Integer(int32) false No description
»»» minor int(int32) false No description
»»» major int(int32) false No description
»»» internalRevision String false No description
»»» electricalVersion String false No description
»»» minorBootloader Integer(int32) false No description
»»» firmwareUpdateFileFormatVersion Integer(int32) false No description
»» stateChangedAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
»» type String false No description
»» nonce long(int64) false No description
»» status String false No description

xs3/1/ces/EvvaComponentRemovalPrepared

Example payload


{
  "aggregateId": "string",
  "linkedInstallationPoints": [
    "string"
  ],
  "stateChangedAt": "2019-04-19T08:11:33Z"
}

Commands confirmed by this event:

PrepareRemovalOfEvvaComponentMapi

Payload

Properties
Name Type Required Description
» aggregateId UUID(uuid) false Universally Unique Identifier
» linkedInstallationPoints [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» stateChangedAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59

xs3/1/ces/EvvaComponentRemoved

Example payload


{
  "accessId": 0,
  "lockedMediaWithAccess": [
    0
  ],
  "aggregateId": "string",
  "linkedInstallationPointIds": [
    "string"
  ],
  "forced": true,
  "useOddKey": true,
  "maintenanceComponentId": "string",
  "stateChangedAt": "2019-04-19T08:11:33Z",
  "nonce": 0
}

Commands confirmed by this event:

ForceRemoveEvvaComponentMapi

Payload

Properties
Name Type Required Description
» accessId long(int64) false No description
» lockedMediaWithAccess [Long] false Array
»» Long Long(int64) false No description
» aggregateId UUID(uuid) false Universally Unique Identifier
» linkedInstallationPointIds [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» forced boolean false No description
» useOddKey boolean false No description
» maintenanceComponentId UUID(uuid) false Universally Unique Identifier
» stateChangedAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» nonce long(int64) false No description

xs3/1/ces/FindComponentPerformed

Example payload


{
  "ok": "string"
}

Commands confirmed by this event:

FindComponentMapi

Payload

Properties
Name Type Required Description
» ok String false No description

xs3/1/ces/IndividualAuthorizationsAddedToMedium

Example payload


{
  "id": "string",
  "authorizationProfiles": [
    {
      "(array item)": {
        "authorizationName": "string",
        "timeProfileName": "string",
        "authorizationProfileId": "string",
        "installationPoint": true,
        "authorizationId": "string",
        "timeProfileId": "string"
      }
    }
  ]
}

Required permission: any of:

AssignInstallationPointIndividualAuthorization

AssignZoneIndividualAuthorization

Commands confirmed by this event:

AddInstallationPointAuthorizationToMediumMapi

AddZoneAuthorizationToMediumMapi

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» authorizationProfiles [object] false Array
»» (array item) object false No description
»»» authorizationName String false No description
»»» timeProfileName String false No description
»»» authorizationProfileId UUID(uuid) false Universally Unique Identifier
»»» installationPoint boolean false No description
»»» authorizationId UUID(uuid) false Universally Unique Identifier
»»» timeProfileId UUID(uuid) false Universally Unique Identifier

xs3/1/ces/IndividualAuthorizationsDeleted

Example payload


{
  "individualAuthorizations": [
    "string"
  ],
  "mediumId": "string"
}

Required permission: any of:

RemoveInstallationPointIndividualAuthorization

RemoveZoneIndividualAuthorization

Commands confirmed by this event:

RemoveZoneAuthorizationFromMediumMapi

RemoveInstallationPointAuthorizationFromMediumMapi

Payload

Properties
Name Type Required Description
» individualAuthorizations [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» mediumId UUID(uuid) false Universally Unique Identifier

xs3/1/ces/InstallationPointChanged

Example payload


{
  "releaseDurationShort": 0,
  "personalReferenceDurationOld": {
    "days": 0,
    "logMode": "string"
  },
  "upgradeMedia": true,
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "timeProfileName": "string",
  "description": "string",
  "linkedInstallationPoints": [
    "string"
  ],
  "timeProfileId": "string",
  "shopMode": true,
  "releaseDurationLong": 0,
  "aggregateId": "string",
  "installationType": "string",
  "manualOfficeMode": true,
  "name": "string",
  "timeProfileData": {
    "timeSeries": [
      {
        "(array item)": {
          "times": [
            {
              "(array item)": {
                "start": "string",
                "end": "string"
              }
            }
          ],
          "days": [
            "string"
          ]
        }
      }
    ],
    "exceptionTimeSeries": [
      {
        "(array item)": {
          "times": [
            {
              "(array item)": {
                "start": "string",
                "end": "string"
              }
            }
          ],
          "calendars": [
            0
          ]
        }
      }
    ],
    "exceptionTimePointSeries": [
      {
        "(array item)": {
          "calendars": [
            0
          ],
          "points": [
            "string"
          ]
        }
      }
    ],
    "timePointSeries": [
      {
        "(array item)": {
          "days": [
            "string"
          ],
          "points": [
            "string"
          ]
        }
      }
    ]
  },
  "installationId": "string",
  "openDoor": true
}

Required permission: any of:

ConfigureMediaUpgrade

AssignOfficeModeTimeProfileToInstallationPoint

ChangeInstallationPointData

ConfigureManualOfficeModeAndShopMode

ConfigureLoggingPersonalDataForInstallationPoint

ConfigureReleaseDuration

Commands confirmed by this event:

ConfigureManualOfficeModeAndShopModeMapi

ChangeInstallationPointMapi

ConfigureMediaUpgradeMapi

ConfigureReleaseDurationMapi

ConfigureOfficeModeTimeProfileMapi

SetPersonalReferenceDurationForInstallationPointMapi

AddEvvaComponentMapi

Payload

Properties
Name Type Required Description
» releaseDurationShort Integer(int32) false No description
» personalReferenceDurationOld object false No description
»» days Integer(int32) false No description
»» logMode String false No description
» upgradeMedia Boolean false No description
» personalReferenceDuration object false No description
»» days Integer(int32) false No description
»» logMode String false No description
» timeProfileName String false No description
» description String false No description
» linkedInstallationPoints [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» timeProfileId UUID(uuid) false Universally Unique Identifier
» shopMode Boolean false No description
» releaseDurationLong Integer(int32) false No description
» aggregateId UUID(uuid) false Universally Unique Identifier
» installationType String false No description
» manualOfficeMode Boolean false No description
» name String false No description
» timeProfileData object false No description
»» timeSeries [object] false Array. Medium-Format 2.2: Access on regular days (Sun-Sat).
»»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»»» times [object] false Array. A list of time intervals.
»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»»» String String false No description
»»»»» exceptionTimeSeries [object] false Array. Medium-Format 2.2: Access on special days (i.e. those defined by calender).
»»»»»» (array item) object false No description
»»»»»»» times [object] false Array
»»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»»» calendars [Integer] false Array
»»»»»»»»» Integer Integer(int32) false No description
»»»»»»»» exceptionTimePointSeries [object] false Array. Medium-Format 2.2: Automatically close manual-permanent-openings at these times. (Aka Halbautomatik) special days (i.e. those defined by calender).
»»»»»»»»» (array item) object false No description
»»»»»»»»»» calendars [Integer] false Array
»»»»»»»»»»» Integer Integer(int32) false No description
»»»»»»»»»» points [LocalTime] false Array
»»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»» timePointSeries [object] false Array. Medium-Format 2.2: Automatically close manual-permanent-openings at these times. (Aka Halbautomatik) Regular days (Sun-Sat).
»»»»»»»»»»» (array item) object false A list of specific local times that are valid at specific weekdays.
»»»»»»»»»»»» days [String] false Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»»»»»»»»»» String String false No description
»»»»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["11:00", "18:45"].
»»»»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»»»» installationId String false No description
»»»»»»»»»»»» openDoor Boolean false No description

xs3/1/ces/InstallationPointCreated

Example payload


{
  "componentType": "string",
  "releaseDurationShort": 0,
  "upgradeMedia": true,
  "instance": 0,
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "partitionId": "string",
  "timeProfileName": "string",
  "description": "string",
  "nextDstTransition": {},
  "linkedInstallationPoints": [
    {
      "(array item)": {
        "accessId": 0,
        "componentType": "string",
        "aggregateId": "string",
        "evvaComponentId": "string",
        "installationPointProperties": {
          "shopMode": true,
          "releaseDurationLong": 0,
          "releaseDurationShort": 0,
          "upgradeMedia": true,
          "installationType": "string",
          "manualOfficeMode": true,
          "personalReferenceDuration": {
            "days": 0,
            "logMode": "string"
          },
          "partitionId": "string",
          "name": "string",
          "description": "string",
          "installationId": "string",
          "openDoor": true,
          "timeProfileId": "string"
        }
      }
    }
  ],
  "timeProfileId": "string",
  "accessId": 0,
  "shopMode": true,
  "releaseDurationLong": 0,
  "installationType": "string",
  "manualOfficeMode": true,
  "name": "string",
  "afterNextDstTransition": {},
  "evvaComponentId": "string",
  "calendarData": {
    "calendars": {}
  },
  "timeProfileData": {
    "timeSeries": [
      {
        "(array item)": {
          "times": [
            {
              "(array item)": {
                "start": "string",
                "end": "string"
              }
            }
          ],
          "days": [
            "string"
          ]
        }
      }
    ],
    "exceptionTimeSeries": [
      {
        "(array item)": {
          "times": [
            {
              "(array item)": {
                "start": "string",
                "end": "string"
              }
            }
          ],
          "calendars": [
            0
          ]
        }
      }
    ],
    "exceptionTimePointSeries": [
      {
        "(array item)": {
          "calendars": [
            0
          ],
          "points": [
            "string"
          ]
        }
      }
    ],
    "timePointSeries": [
      {
        "(array item)": {
          "days": [
            "string"
          ],
          "points": [
            "string"
          ]
        }
      }
    ]
  },
  "installationId": "string",
  "id": "string",
  "openDoor": true
}

Commands confirmed by this event:

CreateInstallationPointMapi

Payload

Properties
Name Type Required Description
» componentType String false No description
» releaseDurationShort int(int32) false No description
» upgradeMedia boolean false No description
» instance int(int32) false No description
» personalReferenceDuration object false No description
»» days Integer(int32) false No description
»» logMode String false No description
» partitionId UUID(uuid) false Universally Unique Identifier
» timeProfileName String false No description
» description String false No description
» nextDstTransition ZoneOffsetTransition false No description
» linkedInstallationPoints [object] false Array
»» (array item) object false No description
»»» accessId long(int64) false No description
»»» componentType String false No description
»»» aggregateId UUID(uuid) false Universally Unique Identifier
»»» evvaComponentId UUID(uuid) false Universally Unique Identifier
»»» installationPointProperties object false No description
»»»» shopMode boolean false No description
»»»» releaseDurationLong int(int32) false No description
»»»» releaseDurationShort int(int32) false No description
»»»» upgradeMedia boolean false No description
»»»» installationType String false No description
»»»» manualOfficeMode boolean false No description
»»»» personalReferenceDuration object false Required.
»»»»» days Integer(int32) false No description
»»»»» logMode String false No description
»»»» partitionId UUID(uuid) false Universally Unique Identifier
»»»» name String false No description
»»»» description String false No description
»»»» installationId String false No description
»»»» openDoor Boolean false No description
»»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»»» accessId long(int64) false No description
»»» shopMode boolean false No description
»»» releaseDurationLong int(int32) false No description
»»» installationType String false No description
»»» manualOfficeMode boolean false No description
»»» name String false No description
»»» afterNextDstTransition ZoneOffsetTransition false No description
»»» evvaComponentId UUID(uuid) false Universally Unique Identifier
»»» calendarData object false No description
»»»» calendars Map false No description
»»» timeProfileData object false No description
»»»» timeSeries [object] false Array. Medium-Format 2.2: Access on regular days (Sun-Sat).
»»»»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»»»»» String String false No description
»»»»»»» exceptionTimeSeries [object] false Array. Medium-Format 2.2: Access on special days (i.e. those defined by calender).
»»»»»»»» (array item) object false No description
»»»»»»»»» times [object] false Array
»»»»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»» calendars [Integer] false Array
»»»»»»»»»»» Integer Integer(int32) false No description
»»»»»»»»»» exceptionTimePointSeries [object] false Array. Medium-Format 2.2: Automatically close manual-permanent-openings at these times. (Aka Halbautomatik) special days (i.e. those defined by calender).
»»»»»»»»»»» (array item) object false No description
»»»»»»»»»»»» calendars [Integer] false Array
»»»»»»»»»»»»» Integer Integer(int32) false No description
»»»»»»»»»»»» points [LocalTime] false Array
»»»»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»»»» timePointSeries [object] false Array. Medium-Format 2.2: Automatically close manual-permanent-openings at these times. (Aka Halbautomatik) Regular days (Sun-Sat).
»»»»»»»»»»»»» (array item) object false A list of specific local times that are valid at specific weekdays.
»»»»»»»»»»»»»» days [String] false Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»»»»»»»»»»»» String String false No description
»»»»»»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["11:00", "18:45"].
»»»»»»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»»»»»» installationId String false No description
»»»»»»»»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»»»»»»»»» openDoor Boolean false No description

xs3/1/ces/InstallationPointDeleted

Example payload


{
  "id": "string",
  "linkedInstallationPoints": [
    "string"
  ],
  "authorizationProfiles": [
    "string"
  ],
  "zones": [
    0
  ],
  "timeProfile": "string"
}

Commands confirmed by this event:

DeleteInstallationPointMapi

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» linkedInstallationPoints [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» authorizationProfiles [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» zones [Integer] false Array
»» Integer Integer(int32) false No description
» timeProfile UUID(uuid) false Universally Unique Identifier

xs3/1/ces/InstallationPointsInZoneChanged

Example payload


{
  "accessId": 0,
  "addedInstallationPoints": [
    "string"
  ],
  "aggregateId": "string",
  "removedInstallationPoints": [
    "string"
  ]
}

Commands confirmed by this event:

RemoveInstallationPointFromZoneMapi

AddInstallationPointToZoneMapi

Payload

Properties
Name Type Required Description
» accessId Integer(int32) false No description
» addedInstallationPoints [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» aggregateId UUID(uuid) false Universally Unique Identifier
» removedInstallationPoints [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier

xs3/1/ces/MediumAddedToInstallation

Example payload


{
  "aggregateId": "string",
  "hardwareId": {},
  "mediumIdentifier": 0,
  "label": "string",
  "nativeId": {}
}

Commands confirmed by this event:

RequestAddMediumToInstallationMapi

Payload

Properties
Name Type Required Description
» aggregateId UUID(uuid) false Universally Unique Identifier
» hardwareId byte[] false No description
» mediumIdentifier long(int64) false No description
» label String false No description
» nativeId byte[] false No description

xs3/1/ces/MediumAuthorizationProfileChanged

Example payload


{
  "newAuthorizationProfileId": "string",
  "id": "string",
  "oldAuthorizationProfileId": "string"
}

Commands confirmed by this event:

AssignAuthorizationProfileToMediumMapi

Payload

Properties
Name Type Required Description
» newAuthorizationProfileId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» oldAuthorizationProfileId UUID(uuid) false Universally Unique Identifier

xs3/1/ces/MediumChanged

Example payload


{
  "accessBeginAt": "2019-04-19T08:11:33Z",
  "disengagePeriod": "string",
  "authorizationProfileId": "string",
  "validityDuration": 0,
  "validUntil": "2019-04-19T08:11:33Z",
  "changedAt": "2019-04-19T08:11:33Z",
  "validFrom": "2019-04-19T08:11:33Z",
  "label": "string",
  "id": "string",
  "accessEndAt": "2019-04-19T08:11:33Z"
}

Required permission: any of:

ChangeDisengagePeriodOnMedium

SetMediumLabel

ChangeValidityDurationOnMedium

SetAuthorizationBeginAtOnMedium

SetAuthorizationEndAtOnMedium

Commands confirmed by this event:

SetAccessEndAtMapi

SetDisengagePeriodOnMediumMapi

AssignAuthorizationProfileToMediumMapi

SetAccessBeginAtMapi

SetValidityDurationMapi

SetLabelOnMediumMapi

Payload

Properties
Name Type Required Description
» accessBeginAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» disengagePeriod String false No description
» authorizationProfileId UUID(uuid) false Universally Unique Identifier
» validityDuration Short(int32) false No description
» validUntil LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» changedAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» validFrom LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» label String false No description
» id UUID(uuid) false Universally Unique Identifier
» accessEndAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59

xs3/1/ces/MediumLocked

Example payload


{
  "aggregateId": "string",
  "installationPoints": [
    "string"
  ],
  "validityEnd": "2019-04-19T08:11:33Z",
  "individualAuthorizations": [
    "string"
  ],
  "authorizationProfileId": "string",
  "mediumIdentifier": 0,
  "hasMasterKeyAccess": true,
  "zones": [
    "string"
  ]
}

Commands confirmed by this event:

LockMediumMapi

Payload

Properties
Name Type Required Description
» aggregateId UUID(uuid) false Universally Unique Identifier
» installationPoints [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» validityEnd LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» individualAuthorizations [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» authorizationProfileId UUID(uuid) false Universally Unique Identifier
» mediumIdentifier Long(int64) false No description
» hasMasterKeyAccess boolean false No description
» zones [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier

xs3/1/ces/MediumPersonChanged

Example payload


{
  "newPersonId": "string",
  "oldPersonId": "string",
  "id": "string"
}

Commands confirmed by this event:

AssignPersonToMediumMapi

Payload

Properties
Name Type Required Description
» newPersonId UUID(uuid) false Universally Unique Identifier
» oldPersonId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/OfficeModeTimeProfileChanged

Example payload


{
  "timeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "days": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "calendars": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimePointSeries": [
    {
      "(array item)": {
        "calendars": [
          "string"
        ],
        "points": [
          "string"
        ]
      }
    }
  ],
  "name": "string",
  "description": "string",
  "timePointSeries": [
    {
      "(array item)": {
        "days": [
          "string"
        ],
        "points": [
          "string"
        ]
      }
    }
  ],
  "id": "string"
}

Commands confirmed by this event:

ChangeOfficeModeTimeProfileMapi

Payload

Properties
Name Type Required Description
» timeSeries [object] false Array
»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»» times [object] false Array. A list of time intervals.
»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»» String String false No description
»»»» exceptionTimeSeries [object] false Array
»»»»» (array item) object false Specifies a set of time intervals that are valid at exceptional days (defined using a calendar).
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» exceptionTimePointSeries [object] false Array
»»»»»»»» (array item) object false No description
»»»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["10:00", "12:00"].
»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»» name String false No description
»»»»»»»»» description String false No description
»»»»»»»»» timePointSeries [object] false Array
»»»»»»»»»» (array item) object false A list of specific local times that are valid at specific weekdays.
»»»»»»»»»»» days [String] false Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»»»»»»»»» String String false No description
»»»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["11:00", "18:45"].
»»»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»»» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/OfficeModeTimeProfileCreated

Example payload


{
  "timeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "days": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "calendars": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimePointSeries": [
    {
      "(array item)": {
        "calendars": [
          "string"
        ],
        "points": [
          "string"
        ]
      }
    }
  ],
  "name": "string",
  "description": "string",
  "timePointSeries": [
    {
      "(array item)": {
        "days": [
          "string"
        ],
        "points": [
          "string"
        ]
      }
    }
  ],
  "id": "string"
}

Commands confirmed by this event:

CreateOfficeModeTimeProfileMapi

Payload

Properties
Name Type Required Description
» timeSeries [object] false Array
»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»» times [object] false Array. A list of time intervals.
»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»» String String false No description
»»»» exceptionTimeSeries [object] false Array
»»»»» (array item) object false Specifies a set of time intervals that are valid at exceptional days (defined using a calendar).
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» exceptionTimePointSeries [object] false Array
»»»»»»»» (array item) object false No description
»»»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["10:00", "12:00"].
»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»» name String false No description
»»»»»»»»» description String false No description
»»»»»»»»» timePointSeries [object] false Array
»»»»»»»»»» (array item) object false A list of specific local times that are valid at specific weekdays.
»»»»»»»»»»» days [String] false Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»»»»»»»»» String String false No description
»»»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["11:00", "18:45"].
»»»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»»» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/OfficeModeTimeProfileDeleted

Example payload


{
  "id": "string"
}

Commands confirmed by this event:

DeleteOfficeModeTimeProfileMapi

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/PartitionChanged

Example payload


{
  "installationPointDefaultPersonalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "replacementMediumDuration": 0,
  "tokenValidityDurationMinutes": 0,
  "mqttServerAddress": {},
  "validityDuration": 0,
  "validityThreshold": 0,
  "personDefaultPersonalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "dailySchedulerExecutionTime": "string",
  "id": "string"
}

Required permission: any of:

SetDefaultMediumValidityDurationForPartition

ConfigureDailySchedulerExecutionTime

ConfigureDefaultLoggingPersonalDataForPerson

ConfigureDefaultLoggingPersonalDataForInstallationPoint

ConfigureValidityThreshold

SetDefaultAccessDurationForReplacedMedium

Commands confirmed by this event:

SetReplacementMediumDurationMapi

SetInstallationPointPersonalReferenceDurationMapi

SetValidityThresholdMapi

SetPersonPersonalReferenceDurationMapi

SetDailySchedulerExecutionTimeMapi

SetDefaultValidityDurationMapi

Payload

Properties
Name Type Required Description
» installationPointDefaultPersonalReferenceDuration object false No description
»» days Integer(int32) false No description
»» logMode String false No description
» replacementMediumDuration Short(int32) false No description
» tokenValidityDurationMinutes int(int32) false No description
» mqttServerAddress InetAddress false No description
» validityDuration Short(int32) false No description
» validityThreshold Short(int32) false No description
» personDefaultPersonalReferenceDuration object false No description
»» days Integer(int32) false No description
»» logMode String false No description
» dailySchedulerExecutionTime LocalTime(time) false Local time. Example: 23:59
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/PersonChanged

Example payload


{
  "oldDefaultAuthorizationProfileId": "string",
  "defaultAuthorizationProfileId": "string",
  "identifier": "string",
  "lastName": "string",
  "firstName": "string",
  "oldPersonalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "disengagePeriod": "string",
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "id": "string"
}

Required permission: any of:

ChangePersonData

SetDefaultDisengagePeriodForPerson

ConfigureLoggingPersonalDataForPerson

SetDefaultAuthorizationProfileForPerson

Commands confirmed by this event:

ChangePersonInformationMapi

SetDefaultAuthorizationProfileForPersonMapi

SetDefaultDisengagePeriodForPersonMapi

SetPersonalReferenceDurationInPersonMapi

Payload

Properties
Name Type Required Description
» oldDefaultAuthorizationProfileId UUID(uuid) false Universally Unique Identifier
» defaultAuthorizationProfileId UUID(uuid) false Universally Unique Identifier
» identifier String false No description
» lastName String false No description
» firstName String false No description
» oldPersonalReferenceDuration object false No description
»» days Integer(int32) false No description
»» logMode String false No description
» disengagePeriod String false No description
» personalReferenceDuration object false No description
»» days Integer(int32) false No description
»» logMode String false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/PersonCreated

Example payload


{
  "defaultAuthorizationProfileId": "string",
  "identifier": "string",
  "lastName": "string",
  "firstName": "string",
  "disengagePeriod": "string",
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "partitionId": "string",
  "externalId": "string",
  "id": "string"
}

Commands confirmed by this event:

CreatePersonMapi

Payload

Properties
Name Type Required Description
» defaultAuthorizationProfileId UUID(uuid) false Universally Unique Identifier
» identifier String false No description
» lastName String false No description
» firstName String false No description
» disengagePeriod String false No description
» personalReferenceDuration object false No description
»» days Integer(int32) false No description
»» logMode String false No description
» partitionId UUID(uuid) false Universally Unique Identifier
» externalId String false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/PersonDeleted

Example payload


{
  "defaultAuthorizationProfileId": "string",
  "id": "string",
  "mediums": [
    "string"
  ]
}

Commands confirmed by this event:

DeletePersonMapi

Payload

Properties
Name Type Required Description
» defaultAuthorizationProfileId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» mediums [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier

xs3/1/ces/PrepareEvvaComponentRemovalReverted

Example payload


{
  "id": "string",
  "linkedInstallationPoints": [
    "string"
  ],
  "stateChangedAt": "2019-04-19T08:11:33Z"
}

Commands confirmed by this event:

RevertPrepareRemovalOfEvvaComponentMapi

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» linkedInstallationPoints [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» stateChangedAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59

xs3/1/ces/RemoteDisengagePerformed

Example payload


{
  "ok": "string"
}

Commands confirmed by this event:

RemoteDisengageMapi

Payload

Properties
Name Type Required Description
» ok String false No description

xs3/1/ces/RemoteDisengagePermanentPerformed

Example payload


{
  "ok": "string"
}

Commands confirmed by this event:

RemoteDisengagePermanentMapi

Payload

Properties
Name Type Required Description
» ok String false No description

xs3/1/ces/UserGroupChanged

Example payload


{
  "assignableAuthorizationProfiles": [
    "string"
  ],
  "permissions": [
    "string"
  ],
  "name": "string",
  "description": "string",
  "id": "string"
}

Commands confirmed by this event:

ConfigureAssignableAuthorizationProfilesMapi

Payload

Properties
Name Type Required Description
» assignableAuthorizationProfiles [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» permissions [String] false Array
»» String String false No description
» name String false No description
» description String false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/ZoneChanged

Example payload


{
  "name": "string",
  "description": "string",
  "id": "string"
}

Commands confirmed by this event:

ChangeZoneDataMapi

Payload

Properties
Name Type Required Description
» name String false No description
» description String false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/ZoneCreated

Example payload


{
  "accessId": 0,
  "partitionId": "string",
  "name": "string",
  "description": "string",
  "id": "string"
}

Commands confirmed by this event:

CreateZoneMapi

Payload

Properties
Name Type Required Description
» accessId Integer(int32) false No description
» partitionId UUID(uuid) false Universally Unique Identifier
» name String false No description
» description String false No description
» id UUID(uuid) false Universally Unique Identifier

xs3/1/ces/ZoneDeleted

Example payload


{
  "installationPointIds": [
    "string"
  ],
  "deletedAt": "2019-04-19T08:11:33Z",
  "authorizationProfileIds": [
    "string"
  ],
  "id": "string"
}

Commands confirmed by this event:

DeleteZoneMapi

Payload

Properties
Name Type Required Description
» installationPointIds [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» deletedAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» authorizationProfileIds [UUID] false Array
»» UUID UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier

Access Protocol Events

Access protocol wildcard subscription:

xs3/1/ase/#

All access control events are issued to a topic with the prefix 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
OPENING_NORMAL 0x0001 1 MediumEvents
OPENING_EMERGENCY 0x0002 2 MediumEvents
MANUAL_OPENING_STARTED 0x0003 3 MediumEvents
MANUAL_OPENING_FINISHED 0x0004 4 MediumEvents
MEDIUM_RESTRICTED 0x0005 5 MediumEvents
OPENING_NORMAL_PROLONGED 0x0007 7 MediumEvents
OPENING_EMERGENCY_PROLONGED 0x0008 8 MediumEvents
OPENING_EMERGENCY_INVALID_BLACKLIST_OR_TIME 0x0009 9 MediumEvents
OPENING_EMERGENCY_PROLONGED_INVALID_BLACKLIST_OR_TIME 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

Subscribe (Access Protocol)

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

Example payload


{
  "eventNumber": 0,
  "mediumIdentifier": 0,
  "timestampComponentLocal": "2019-04-19T08:11:33Z",
  "identificationMediumId": "string",
  "eventType": "string",
  "timestampUtc": "2019-04-19T08:11:33Z",
  "ttl": "2019-04-19T08:11:33Z",
  "accessId": 0,
  "installationPointName": "string",
  "zoneIds": {},
  "eventValue": {
    "fwVersionChanges": "string",
    "timestampFrom": "2019-04-19T08:11:33Z",
    "shopModeActivated": true,
    "mediumIdentifier": 0,
    "doorOpening": true,
    "errorCodes": "string",
    "initializationReason": 0,
    "errorReaction": 0,
    "mediaRestrictedReason": 0,
    "accessId": 0,
    "timestampTo": "2019-04-19T08:11:33Z",
    "errorModule": 0,
    "inputState": 0,
    "keyType": 0,
    "mediaChangedReason": 0,
    "componentType": "string",
    "raw": "string",
    "inputNr": 0,
    "officeModeAllowed": true,
    "deltablacklistUid": 0,
    "fwUpdatePerformed": true,
    "fwUpdateStatus": "string",
    "mediaUpgrade": true,
    "errorLocation": 0,
    "startingUp": "string",
    "errorNumber": "string"
  },
  "entryIdentificator": 0,
  "groupOfEvent": "string",
  "rawValue": "string",
  "person": "string",
  "installationPointId": "string",
  "personId": "string",
  "identificationMediumLabel": "string",
  "id": "string",
  "parameterMap": {},
  "installationPointIdentifier": "string"
}

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

Payload

Properties
Name Type Required Description
» eventNumber Integer(int32) false No description
» mediumIdentifier Long(int64) false No description
» timestampComponentLocal LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» identificationMediumId UUID(uuid) false Universally Unique Identifier
» eventType String false No description
» timestampUtc LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» ttl LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» accessId Long(int64) false No description
» installationPointName String false No description
» zoneIds UUID[] false No description
» eventValue object false No description
»» fwVersionChanges String false No description
»» timestampFrom LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
»» shopModeActivated Boolean false No description
»» mediumIdentifier Long(int64) false No description
»» doorOpening Boolean false No description
»» errorCodes String false No description
»» initializationReason Integer(int32) false No description
»» errorReaction Integer(int32) false No description
»» mediaRestrictedReason Integer(int32) false No description
»» accessId Long(int64) false No description
»» timestampTo LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
»» errorModule Integer(int32) false No description
»» inputState Integer(int32) false No description
»» keyType Integer(int32) false No description
»» mediaChangedReason Integer(int32) false No description
»» componentType String false No description
»» raw String false No description
»» inputNr Integer(int32) false No description
»» officeModeAllowed Boolean false No description
»» deltablacklistUid Integer(int32) false No description
»» fwUpdatePerformed Boolean false No description
»» fwUpdateStatus String false No description
»» mediaUpgrade Boolean false No description
»» errorLocation Integer(int32) false No description
»» startingUp String false No description
»» errorNumber String false No description
» entryIdentificator Integer(int32) false No description
» groupOfEvent String false No description
» rawValue String false No description
» person String false No description
» installationPointId UUID(uuid) false Universally Unique Identifier
» personId UUID(uuid) false Universally Unique Identifier
» identificationMediumLabel String false No description
» id UUID(uuid) false Universally Unique Identifier
» parameterMap Map false No description
» installationPointIdentifier String false No description

Queries

The interface allows to query information from the server.

It provides following ressources 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

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

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

These two mechanisms can and should be combined as necessary.

Paging

Paging PUB: xs3/1/q

{
    "requestId":"2bca3a1a-0e76-44af-a1c4-d327afe035f2",
    "token":"JDJhJDEwJHh4YWs5UlN0SkJHZEdwTml4SHNOT2UwQTdDR0tLdnRDbFU0SmtTMEF3NTV4UGJMTWJ4cENp",
    "resource":"evva-components",
    "params": {
        "pageOffset":0,
        "pageLimit":1
    }
}

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

{
    "requestId":"2bca3a1a-0e76-44af-a1c4-d327afe035f2",
    "response": 
        {
            "data":[
                {
                    "id":"9500e589-3f37-4c7a-b8d4-05383bdfb41b","status":"Synced","batteryCondition":"Full","stateChangedAt":"2019-04-23T07:51:51.262","componentType":"Escutcheon"
                }
            ],
            "totalCount":52,
            "filterCount":52
        }
}

Query overview

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) 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

Publish (Queries)

xs3/1/q

Example payload


{
  "resource": "string",
  "requestId": "string",
  "id": "string",
  "params": {
    "pageLimit": 0,
    "pageOffset": 0,
    "language": "string",
    "filters": [
      {
        "(array item)": {
          "field": "string",
          "type": "string",
          "value": "string"
        }
      }
    ],
    "sort": "string"
  },
  "token": "string"
}

Published messages require a token with authorization for the permissions given in the table at the beginning of this chapter.

Payload

Properties
Name Type Required Description
» resource String false No description
» requestId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» params object false Set to filter a list of items; Has no effect when id is set.
»» pageLimit Integer(int32) false No description
»» pageOffset Integer(int32) false No description
»» language String false No description
»» filters [object] false Array. List of query filters to specify combined filter.
»»» (array item) object false No description
»»»» field String false No description
»»»» type String false No description
»»»» value String false No description
»»» sort String false No description
»» token String false No description

Subscribe (Queries)

xs3/1/{userId}/q

Example payload


{
  "response": {},
  "requestId": "string"
}

Response payload for queries.

Payload

Properties
Name Type Required Description
» response Object false No description
» requestId UUID(uuid) false Universally Unique Identifier

Commands

Publish (Commands)

xs3/1/cmd/AddEvvaComponentMapi

Example payload


{
  "id": "string",
  "type": "string",
  "commandId": "string",
  "token": "string"
}

Add an Evva component to an existing installation point.

Events confirming this command:

InstallationPointChanged

EvvaComponentAdded

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» type String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/AddInstallationPointAuthorizationToMediumMapi

Example payload


{
  "authorization": {
    "authorizationName": "string",
    "timeProfileName": "string",
    "authorizationProfileId": "string",
    "installationPoint": true,
    "authorizationId": "string",
    "timeProfileId": "string"
  },
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Add individual authorisation for an installation point.

Events confirming this command:

IndividualAuthorizationsAddedToMedium

Payload

Properties
Name Type Required Description
» authorization object false No description
»» authorizationName String false No description
»» timeProfileName String false No description
»» authorizationProfileId UUID(uuid) false Universally Unique Identifier
»» installationPoint boolean false No description
»» authorizationId UUID(uuid) false Universally Unique Identifier
»» timeProfileId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/AddInstallationPointToZoneMapi

Example payload


{
  "installationPointId": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

InstallationPointsInZoneChanged

Payload

Properties
Name Type Required Description
» installationPointId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/AddZoneAuthorizationToMediumMapi

Example payload


{
  "authorization": {
    "authorizationName": "string",
    "timeProfileName": "string",
    "authorizationProfileId": "string",
    "installationPoint": true,
    "authorizationId": "string",
    "timeProfileId": "string"
  },
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

IndividualAuthorizationsAddedToMedium

Payload

Properties
Name Type Required Description
» authorization object false No description
»» authorizationName String false No description
»» timeProfileName String false No description
»» authorizationProfileId UUID(uuid) false Universally Unique Identifier
»» installationPoint boolean false No description
»» authorizationId UUID(uuid) false Universally Unique Identifier
»» timeProfileId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/AssignAuthorizationProfileToMediumMapi

Example payload


{
  "authorizationProfileId": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

MediumChanged

MediumAuthorizationProfileChanged

Payload

Properties
Name Type Required Description
» authorizationProfileId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/AssignPersonToMediumMapi

Example payload


{
  "personId": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

MediumPersonChanged

Payload

Properties
Name Type Required Description
» personId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ChangeAuthorizationProfileMapi

Example payload


{
  "installationPoints": [
    {
      "(array item)": {
        "id": "string",
        "timeProfileId": "string"
      }
    }
  ],
  "manualOfficeMode": true,
  "name": "string",
  "standardTimeProfile": "string",
  "description": "string",
  "id": "string",
  "zones": [
    {
      "(array item)": {
        "id": "string",
        "timeProfileId": "string"
      }
    }
  ],
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

AuthorizationProfileChanged

AuthorizationProfileInfoChanged

AuthorizationProfileAccessChanged

Payload

Properties
Name Type Required Description
» installationPoints [object] false Array. Array of installation point authorization ids.
»» (array item) object false No description
»»» id UUID(uuid) false Universally Unique Identifier
»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»» manualOfficeMode Boolean false No description
»» name String false No description
»» standardTimeProfile UUID(uuid) false Universally Unique Identifier
»» description String false No description
»» id UUID(uuid) false Universally Unique Identifier
»» zones [object] false Array. Array of zone authorization ids.
»»» (array item) object false No description
»»»» id UUID(uuid) false Universally Unique Identifier
»»»» timeProfileId UUID(uuid) false Universally Unique Identifier
»»» commandId UUID(uuid) false Universally Unique Identifier
»»» token String false No description

xs3/1/cmd/ChangeAuthorizationTimeProfileMapi

Example payload


{
  "timeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "days": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "calendars": [
          "string"
        ]
      }
    }
  ],
  "name": "string",
  "description": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

AuthorizationTimeProfileChanged

Payload

Properties
Name Type Required Description
» timeSeries [object] false Array
»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»» times [object] false Array. A list of time intervals.
»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»» String String false No description
»»»» exceptionTimeSeries [object] false Array
»»»»» (array item) object false Specifies a set of time intervals that are valid at exceptional days (defined using a calendar).
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» name String false No description
»»»»»»» description String false No description
»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»» commandId UUID(uuid) false Universally Unique Identifier
»»»»»»» token String false No description

xs3/1/cmd/ChangeCalendarMapi

Example payload


{
  "specialDays": [
    "2019-04-19"
  ],
  "name": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

CalendarChanged

Payload

Properties
Name Type Required Description
» specialDays [LocalDate] false Array. A list of LocalDates. Example: "2018-02-25, 2018-02-28".
»» LocalDate LocalDate(date) false Local date. Example: 2018-02-25
» name String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ChangeInstallationPointMapi

Example payload


{
  "aggregateId": "string",
  "installationType": "string",
  "name": "string",
  "description": "string",
  "installationId": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

InstallationPointChanged

Payload

Properties
Name Type Required Description
» aggregateId UUID(uuid) false Universally Unique Identifier
» installationType String false No description
» name String false No description
» description String false No description
» installationId String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ChangeOfficeModeTimeProfileMapi

Example payload


{
  "timeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "days": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "calendars": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimePointSeries": [
    {
      "(array item)": {
        "calendars": [
          "string"
        ],
        "points": [
          "string"
        ]
      }
    }
  ],
  "name": "string",
  "description": "string",
  "timePointSeries": [
    {
      "(array item)": {
        "days": [
          "string"
        ],
        "points": [
          "string"
        ]
      }
    }
  ],
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

OfficeModeTimeProfileChanged

Payload

Properties
Name Type Required Description
» timeSeries [object] false Array. Time intervals for allowing/disallowing entry.
»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»» times [object] false Array. A list of time intervals.
»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»» String String false No description
»»»» exceptionTimeSeries [object] false Array. Time intervals for allowing/disallowing entry at exceptional dates (holidays etc.).
»»»»» (array item) object false Specifies a set of time intervals that are valid at exceptional days (defined using a calendar).
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» exceptionTimePointSeries [object] false Array. Time of a day in a specific weekday, used to end the allowed entry at exceptional dates (holidays etc.).
»»»»»»»» (array item) object false No description
»»»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["10:00", "12:00"].
»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»» name String false No description
»»»»»»»»» description String false No description
»»»»»»»»» timePointSeries [object] false Array. Time of a day in a specific weekday, used to end the allowed entry.
»»»»»»»»»» (array item) object false A list of specific local times that are valid at specific weekdays.
»»»»»»»»»»» days [String] false Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»»»»»»»»» String String false No description
»»»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["11:00", "18:45"].
»»»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»»»»»» commandId UUID(uuid) false Universally Unique Identifier
»»»»»»»»»»» token String false No description

xs3/1/cmd/ChangePersonInformationMapi

Example payload


{
  "identifier": "string",
  "lastName": "string",
  "firstName": "string",
  "externalId": "string",
  "commandId": "string",
  "token": "string"
}

Required permission: ChangePersonData

Events confirming this command:

PersonChanged

Payload

Properties
Name Type Required Description
» identifier String false No description
» lastName String false No description
» firstName String false No description
» externalId String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ChangeZoneDataMapi

Example payload


{
  "name": "string",
  "description": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

ZoneChanged

Payload

Properties
Name Type Required Description
» name String false No description
» description String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ConfigureAssignableAuthorizationProfilesMapi

Example payload


{
  "assignableAuthorizationProfiles": [
    "string"
  ],
  "id": "string",
  "commandId": "string",
  "token": "string"
}

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.

Events confirming this command:

UserGroupChanged

Payload

Properties
Name Type Required Description
» assignableAuthorizationProfiles [UUID] false Array. Array of authorization profile Ids.
»» UUID UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ConfigureManualOfficeModeAndShopModeMapi

Example payload


{
  "shopMode": true,
  "manualOfficeMode": true,
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

InstallationPointChanged

Payload

Properties
Name Type Required Description
» shopMode Boolean false No description
» manualOfficeMode Boolean false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ConfigureMediaUpgradeMapi

Example payload


{
  "upgradeMedia": true,
  "id": "string",
  "commandId": "string",
  "token": "string"
}

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

Events confirming this command:

InstallationPointChanged

Payload

Properties
Name Type Required Description
» upgradeMedia boolean false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ConfigureOfficeModeTimeProfileMapi

Example payload


{
  "id": "string",
  "timeProfileId": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

InstallationPointChanged

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» timeProfileId UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ConfigureReleaseDurationMapi

Example payload


{
  "releaseDurationLong": 0,
  "releaseDurationShort": 0,
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

InstallationPointChanged

Payload

Properties
Name Type Required Description
» releaseDurationLong int(int32) false No description
» releaseDurationShort int(int32) false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/CreateAuthorizationProfileMapi

Example payload


{
  "name": "string",
  "description": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Creates a new Authorization Profile.

Events confirming this command:

AuthorizationProfileCreated

Payload

Properties
Name Type Required Description
» name String false No description
» description String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/CreateAuthorizationTimeProfileMapi

Example payload


{
  "timeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "days": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "calendars": [
          "string"
        ]
      }
    }
  ],
  "name": "string",
  "description": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

AuthorizationTimeProfileCreated

Payload

Properties
Name Type Required Description
» timeSeries [object] false Array
»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»» times [object] false Array. A list of time intervals.
»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»» String String false No description
»»»» exceptionTimeSeries [object] false Array
»»»»» (array item) object false Specifies a set of time intervals that are valid at exceptional days (defined using a calendar).
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» name String false No description
»»»»»»» description String false No description
»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»» commandId UUID(uuid) false Universally Unique Identifier
»»»»»»» token String false No description

xs3/1/cmd/CreateCalendarMapi

Example payload


{
  "specialDays": [
    "2019-04-19"
  ],
  "name": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

CalendarCreated

Payload

Properties
Name Type Required Description
» specialDays [LocalDate] false Array. A list of LocalDates. Example: ["2018-02-25", "2018-02-28"].
»» LocalDate LocalDate(date) false Local date. Example: 2018-02-25
» name String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/CreateInstallationPointMapi

Example payload


{
  "componentType": "string",
  "aggregateId": "string",
  "linkedInstallationPoints": {},
  "commandId": "string",
  "properties": {
    "installationType": "string",
    "name": "string",
    "description": "string",
    "installationId": "string"
  },
  "token": "string"
}

Events confirming this command:

InstallationPointCreated

EvvaComponentAdded

Payload

Properties
Name Type Required Description
» componentType String false No description
» aggregateId UUID(uuid) false Universally Unique Identifier
» linkedInstallationPoints Map false No description
» commandId UUID(uuid) false Universally Unique Identifier
» properties object false Required.
»» installationType String false No description
»» name String false No description
»» description String false No description
»» installationId String false No description
» token String false No description

xs3/1/cmd/CreateOfficeModeTimeProfileMapi

Example payload


{
  "timeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "days": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimeSeries": [
    {
      "(array item)": {
        "times": [
          {
            "(array item)": {
              "start": "string",
              "end": "string"
            }
          }
        ],
        "calendars": [
          "string"
        ]
      }
    }
  ],
  "exceptionTimePointSeries": [
    {
      "(array item)": {
        "calendars": [
          "string"
        ],
        "points": [
          "string"
        ]
      }
    }
  ],
  "name": "string",
  "description": "string",
  "timePointSeries": [
    {
      "(array item)": {
        "days": [
          "string"
        ],
        "points": [
          "string"
        ]
      }
    }
  ],
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

OfficeModeTimeProfileCreated

Payload

Properties
Name Type Required Description
» timeSeries [object] false Array. Time intervals for allowing/disallowing entry.
»» (array item) object false Specifies a set of time intervals that are valid at specific weekdays.
»»» times [object] false Array. A list of time intervals.
»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»» days [String] false Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»» String String false No description
»»»» exceptionTimeSeries [object] false Array. Time intervals for allowing/disallowing entry at exceptional dates (holidays etc.).
»»»»» (array item) object false Specifies a set of time intervals that are valid at exceptional days (defined using a calendar).
»»»»»» times [object] false Array. A list of time intervals.
»»»»»»» (array item) object false A single, uninterrupted time interval specified by a start and en end.
»»»»»»»» start LocalTime(time) false Local time. Example: 23:59
»»»»»»»» end LocalTime(time) false Local time. Example: 23:59
»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»» exceptionTimePointSeries [object] false Array. Time of a day in a specific weekday, used to end the allowed entry at exceptional dates (holidays etc.).
»»»»»»»» (array item) object false No description
»»»»»»»»» calendars [UUID] false Array. List of calendar IDs.
»»»»»»»»»» UUID UUID(uuid) false Universally Unique Identifier
»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["10:00", "12:00"].
»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»» name String false No description
»»»»»»»»» description String false No description
»»»»»»»»» timePointSeries [object] false Array. Time of a day in a specific weekday, used to end the allowed entry.
»»»»»»»»»» (array item) object false A list of specific local times that are valid at specific weekdays.
»»»»»»»»»»» days [String] false Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].
»»»»»»»»»»»» String String false No description
»»»»»»»»»»» points [LocalTime] false Array. List of time points. Example: ["11:00", "18:45"].
»»»»»»»»»»»» LocalTime LocalTime(time) false Local time. Example: 23:59
»»»»»»»»»»» id UUID(uuid) false Universally Unique Identifier
»»»»»»»»»»» commandId UUID(uuid) false Universally Unique Identifier
»»»»»»»»»»» token String false No description

xs3/1/cmd/CreatePersonMapi

Example payload


{
  "identifier": "string",
  "lastName": "string",
  "firstName": "string",
  "externalId": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Creates a new Person.

Events confirming this command:

PersonCreated

Payload

Properties
Name Type Required Description
» identifier String false No description
» lastName String false No description
» firstName String false No description
» externalId String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/CreateZoneMapi

Example payload


{
  "installationPoints": [
    "string"
  ],
  "name": "string",
  "description": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Creates a new Zone.

Events confirming this command:

ZoneCreated

Payload

Properties
Name Type Required Description
» installationPoints [UUID] false Array. An array of installation-point ids.
»» UUID UUID(uuid) false Universally Unique Identifier
» name String false No description
» description String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/DeleteAuthorizationProfileMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

AuthorizationProfileDeleted

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/DeleteAuthorizationTimeProfileMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

AuthorizationTimeProfileDeleted

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/DeleteCalendarMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

CalendarDeleted

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/DeleteInstallationPointMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

InstallationPointDeleted

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/DeleteOfficeModeTimeProfileMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

OfficeModeTimeProfileDeleted

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/DeletePersonMapi

Example payload


{
  "externalId": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

PersonDeleted

Payload

Properties
Name Type Required Description
» externalId String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/DeleteZoneMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

ZoneDeleted

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/FindComponent

Example payload


{
  "enable": true,
  "installationPointId": "string",
  "commandId": "string",
  "token": "string"
}

Enable/disable the beeping signal to find the component.

Events confirming this command:

FindComponentPerformed

Payload

Properties
Name Type Required Description
» enable boolean false No description
» installationPointId UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/ForceRemoveEvvaComponentMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

EvvaComponentRemoved

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/LockMediumMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

MediumLocked

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/PrepareRemovalOfEvvaComponentMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

EvvaComponentRemovalPrepared

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/RemoteDisengage

Example payload


{
  "installationPointId": "string",
  "commandId": "string",
  "extended": true,
  "token": "string"
}

Events confirming this command:

RemoteDisengagePerformed

Payload

Properties
Name Type Required Description
» installationPointId UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» extended boolean false No description
» token String false No description

xs3/1/cmd/RemoteDisengagePermanent

Example payload


{
  "enable": true,
  "installationPointId": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

RemoteDisengagePermanentPerformed

Payload

Properties
Name Type Required Description
» enable boolean false No description
» installationPointId UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/RemoveInstallationPointAuthorizationFromMediumMapi

Example payload


{
  "authorization": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

IndividualAuthorizationsDeleted

Payload

Properties
Name Type Required Description
» authorization UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/RemoveInstallationPointFromZoneMapi

Example payload


{
  "installationPointId": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

InstallationPointsInZoneChanged

Payload

Properties
Name Type Required Description
» installationPointId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/RemoveZoneAuthorizationFromMediumMapi

Example payload


{
  "authorization": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Remove individual authorisation for a zone.

Events confirming this command:

IndividualAuthorizationsDeleted

Payload

Properties
Name Type Required Description
» authorization UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/RequestAddMediumToInstallationMapi

Example payload


{
  "hardwareId": "string",
  "label": "string",
  "terminalId": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

AddMediumToInstallationRequested

MediumAddedToInstallation

Payload

Properties
Name Type Required Description
» hardwareId String false No description
» label String false No description
» terminalId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/RevertPrepareRemovalOfEvvaComponentMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

PrepareEvvaComponentRemovalReverted

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetAccessBeginAtMapi

Example payload


{
  "accessBeginAt": "2019-04-19T08:11:33Z",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Sets the access begin of an identification medium.

Events confirming this command:

MediumChanged

Payload

Properties
Name Type Required Description
» accessBeginAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetAccessEndAtMapi

Example payload


{
  "id": "string",
  "commandId": "string",
  "accessEndAt": "2019-04-19T08:11:33Z",
  "token": "string"
}

Sets the access end of an identification medium.

Events confirming this command:

MediumChanged

Payload

Properties
Name Type Required Description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» accessEndAt LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59
» token String false No description

xs3/1/cmd/SetDailySchedulerExecutionTimeMapi

Example payload


{
  "dailySchedulerExecutionTime": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

PartitionChanged

Payload

Properties
Name Type Required Description
» dailySchedulerExecutionTime LocalTime(time) false Local time. Example: 23:59
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetDefaultAuthorizationProfileForPersonMapi

Example payload


{
  "externalId": "string",
  "commandId": "string",
  "defaultAuthorizationProfileName": "string",
  "token": "string"
}

Events confirming this command:

PersonChanged

Payload

Properties
Name Type Required Description
» externalId String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» defaultAuthorizationProfileName String false No description
» token String false No description

xs3/1/cmd/SetDefaultDisengagePeriodForPersonMapi

Example payload


{
  "disengagePeriod": "string",
  "externalId": "string",
  "commandId": "string",
  "token": "string"
}

Set whether short or long disengage period for a person.

Events confirming this command:

PersonChanged

Payload

Properties
Name Type Required Description
» disengagePeriod String false No description
» externalId String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetDefaultValidityDurationMapi

Example payload


{
  "validityDuration": 0,
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

PartitionChanged

Payload

Properties
Name Type Required Description
» validityDuration Short(int32) false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetDisengagePeriodOnMediumMapi

Example payload


{
  "disengagePeriod": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

MediumChanged

Payload

Properties
Name Type Required Description
» disengagePeriod String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetInstallationPointPersonalReferenceDurationMapi

Example payload


{
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

PartitionChanged

Payload

Properties
Name Type Required Description
» personalReferenceDuration object false Required.
»» days Integer(int32) false No description
»» logMode String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetLabelOnMediumMapi

Example payload


{
  "label": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

MediumChanged

Payload

Properties
Name Type Required Description
» label String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetPersonPersonalReferenceDurationMapi

Example payload


{
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "commandId": "string",
  "token": "string"
}

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

Events confirming this command:

PartitionChanged

Payload

Properties
Name Type Required Description
» personalReferenceDuration object false Required.
»» days Integer(int32) false No description
»» logMode String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetPersonalReferenceDurationForInstallationPointMapi

Example payload


{
  "personalReferenceDuration": {
    "days": 0,
    "logMode": "string"
  },
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

InstallationPointChanged

Payload

Properties
Name Type Required Description
» personalReferenceDuration object false Required.
»» days Integer(int32) false No description
»» logMode String false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetPersonalReferenceDurationInPersonMapi

Example payload


{
  "newValue": {
    "days": 0,
    "logMode": "string"
  },
  "externalId": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

PersonChanged

Payload

Properties
Name Type Required Description
» newValue object false Accept PersonalLog containing 'logMode' and 'days'. 'logMode' can be: dontSave, saveUnlimited, saveForDays 'days': should be set if logMode is set to 'saveForDays'. Required.
»» days Integer(int32) false No description
»» logMode String false No description
» externalId String false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetReplacementMediumDurationMapi

Example payload


{
  "replacementMediumDuration": 0,
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

PartitionChanged

Payload

Properties
Name Type Required Description
» replacementMediumDuration Short(int32) false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetValidityDurationMapi

Example payload


{
  "validityDuration": 0,
  "id": "string",
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

MediumChanged

Payload

Properties
Name Type Required Description
» validityDuration Short(int32) false No description
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/SetValidityThresholdMapi

Example payload


{
  "validityThreshold": 0,
  "commandId": "string",
  "token": "string"
}

Events confirming this command:

PartitionChanged

Payload

Properties
Name Type Required Description
» validityThreshold Short(int32) false No description
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

xs3/1/cmd/WithdrawAuthorizationProfileFromMediumMapi

Example payload


{
  "authorizationProfileId": "string",
  "id": "string",
  "commandId": "string",
  "token": "string"
}

See AuthorizationProfileWithdrawnFromMedium.

Events confirming this command:

AuthorizationProfileWithdrawnFromMedium

Payload

Properties
Name Type Required Description
» authorizationProfileId UUID(uuid) false Universally Unique Identifier
» id UUID(uuid) false Universally Unique Identifier
» commandId UUID(uuid) false Universally Unique Identifier
» token String false No description

Schemas

LocalDateTime

"2019-04-19T08:11:33Z"

Properties

LocalDateTime

Name Type Required Description
LocalDateTime LocalDateTime(date-time) false Local date & time. Example: 2018-02-25T23:59

LocalTime

"string"

Properties

LocalTime

Name Type Required Description
LocalTime LocalTime(time) false Local time. Example: 23:59

UUID[]

{}

Properties

UUID[]

Name Type Required Description

String

"string"

Properties

String

Name Type Required Description
String String false No description

LocalDate

"2019-04-19"

Properties

LocalDate

Name Type Required Description
LocalDate LocalDate(date) false Local date. Example: 2018-02-25

int

0

Properties

int

Name Type Required Description
int int(int32) false No description

long

0

Properties

long

Name Type Required Description
long long(int64) false No description

Integer

0

Properties

Integer

Name Type Required Description
Integer Integer(int32) false No description

byte[]

{}

Properties

byte[]

Name Type Required Description

boolean

true

Properties

boolean

Name Type Required Description
boolean boolean false No description

char

{}

Properties

char

Name Type Required Description

Long

0

Properties

Long

Name Type Required Description
Long Long(int64) false No description

Object

{}

Properties

Object

Name Type Required Description

UUID

"string"

Properties

UUID

Name Type Required Description
UUID UUID(uuid) false Universally Unique Identifier

Boolean

true

Properties

Boolean

Name Type Required Description
Boolean Boolean false No description

ZoneOffsetTransition

{}

Properties

ZoneOffsetTransition

Name Type Required Description

Map

{}

Properties

Map

Name Type Required Description

InetAddress

{}

Properties

InetAddress

Name Type Required Description

Short

0

Properties

Short

Name Type Required Description
Short Short(int32) false No description