Operations

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

  Parameters

  Expand all

  groupOfEvent

  required

  string

  uid: groupOfEvent

  groupOfEvent

  eventNumber

  required

  string

  uid: eventNumber

  eventNumber

  • #Access Protocol Events

  Accepts the following message:

  EventLogEntryDto

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

  Payload

  Expand all

  object

  accessId

  integer

  format: int64

  Format: Long.

  entryIdentificator

  integer

  format: int32

  eventNumber

  integer

  format: int32

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

  eventType

  string

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

  eventValue

  Expand all

  object

  accessId

  integer

  format: int64

  Format: Long.

  componentType

  string

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

  deltablacklistUid

  integer

  format: int32

  doorOpening

  boolean

  errorCodes

  string

  errorLocation

  integer

  format: int32

  errorModule

  integer

  format: int32

  errorNumber

  string

  errorReaction

  integer

  format: int32

  fwUpdatePerformed

  boolean

  fwUpdateStatus

  string

  fwVersionChanges

  string

  initializationReason

  integer

  format: int32

  inputNr

  integer

  format: int32

  inputState

  integer

  format: int32

  keyType

  integer

  format: int32

  mediaChangedReason

  integer

  format: int32

  mediaRestrictedReason

  integer

  format: int32

  mediaUpgrade

  boolean

  mediumIdentifier

  integer

  format: int64

  Format: Long.

  nonceInHardware

  integer

  format: int64

  Format: Long.

  nonceInSoftware

  integer

  format: int64

  Format: Long.

  officeModeAllowed

  boolean

  raw

  string

  shopModeActivated

  boolean

  startingUp

  string

  timestampFrom

  string

  format: date-time

  Format: LocalDateTime.

  timestampTo

  string

  format: date-time

  Format: LocalDateTime.

  Additional properties are allowed.

  groupOfEvent

  string

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

  id

  string

  format: uuid

  Format: UUID.

  identificationMediumId

  string

  format: uuid

  Format: UUID.

  identificationMediumLabel

  string

  installationPointId

  string

  format: uuid

  Format: UUID.

  installationPointIdentifier

  string

  installationPointName

  string

  mediumIdentifier

  integer

  format: int64

  Format: Long.

  parameterMap

  Expand all

  object

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

  Additional properties are allowed.

  person

  string

  personId

  string

  format: uuid

  Format: UUID.

  rawValue

  string

  Bytes as hex string.

  receivedAt

  string

  format: date-time

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

  timestampComponentLocal

  string

  format: date-time

  Format: LocalDateTime.

  timestampUtc

  string

  format: date-time

  Format: LocalDateTime.

  ttl

  string

  format: date-time

  Format: LocalDateTime.

  zoneIds

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AddMediumToInstallationRequested

  • #System Events

  Accepts the following message:

  AddMediumToInstallationRequested

  Required permission: AddIdentificationMedium

  Commands confirmed by this event:

   • RequestAddMediumToInstallationMapi

  Payload

  Expand all

  object

  aggregateId

  string

  format: uuid

  Format: UUID.

  hardwareId

  string

  An array of bytes represented as a Base64 encoded string.

  label

  string

  mediumIdentifier

  integer

  format: int64

  Format: long.

  partitionId

  string

  format: uuid

  Format: UUID.

  terminalId

  string

  format: uuid

  Format: UUID. Generated internal UUID of the coding station.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationProfileAccessChanged

  • #System Events

  Accepts the following message:

  AuthorizationProfileAccessChanged

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

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

  Required permission: ChangeAuthorizationProfileData

  Commands confirmed by this event:

   • ChangeAuthorizationProfileMapi

  Payload

  Expand all

  object

  addedInstallationPoints

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  addedTimeProfiles

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  addedZones

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  id

  string

  format: uuid

  Format: UUID.

  individual

  boolean

  installationPoints

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  manualOfficeMode

  boolean

  media

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  oldStandardTimeProfile

  string

  format: uuid

  Format: UUID. The previous standard time profile id or null for an all-day time profile.

  removedInstallationPoints

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  removedTimeProfiles

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  removedZones

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  standardTimeProfile

  string

  format: uuid

  Format: UUID. The used standard time profile id or null for an all-day time profile.

  zones

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationProfileChanged

  • #System Events

  Accepts the following message:

  AuthorizationProfileChanged

  Required permission: ChangeAuthorizationProfileData

  Commands confirmed by this event:

   • ChangeAuthorizationProfileMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationProfileCreated

  • #System Events

  Accepts the following message:

  AuthorizationProfileCreated

  Required permission: CreateAuthorizationProfile

  Commands confirmed by this event:

   • CreateAuthorizationProfileMapi

  Payload

  Expand all

  object

  assignable

  boolean

  description

  string

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  individual

  boolean

  name

  string

  partitionId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationProfileDeleted

  • #System Events

  Accepts the following message:

  AuthorizationProfileDeleted

  Required permission: RemoveAuthorizationProfile

  Commands confirmed by this event:

   • DeleteAuthorizationProfileMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  individual

  boolean

  installationPoints

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  standardTimeProfile

  string

  format: uuid

  Format: UUID.

  timeProfiles

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  zones

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationProfileInfoChanged

  • #System Events

  Accepts the following message:

  AuthorizationProfileInfoChanged

  Required permission: ChangeAuthorizationProfileData

  Commands confirmed by this event:

   • ChangeAuthorizationProfileMapi

   • ChangeAuthorizationProfileMetadataValueMapi

  Payload

  Expand all

  object

  description

  string

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationProfileMetadataDefinitionsUpdated

  • #System Events

  Accepts the following message:

  AuthorizationProfileMetadataDefinitionsUpdated

  Required permission: ConfigureEntityMetadataDefinitions

  Commands confirmed by this event:

   • AddEntityMetadataDefinitionMapi

   • DeleteEntityMetadataDefinitionMapi

   • RenameEntityMetadataDefinitionMapi

  Payload

  Expand all

  object

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "entityMetadata": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "value": "string"
      }
    ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationProfileWithdrawnFromMedium

  • #System Events

  Accepts the following message:

  AuthorizationProfileWithdrawnFromMedium

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

  Required permission: WithdrawAllAuthorizations

  Commands confirmed by this event:

   • WithdrawAuthorizationProfileFromMediumMapi

  Payload

  Expand all

  object

  accessBeginAt

  string

  format: date-time

  Format: LocalDateTime.

  accessEndAt

  string

  format: date-time

  Format: LocalDateTime.

  authorizationProfileId

  string

  format: uuid

  Format: UUID.

  id

  string

  format: uuid

  Format: UUID.

  individualAuthorizationProfileIds

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  validFrom

  string

  format: date-time

  Format: LocalDateTime.

  validUntil

  string

  format: date-time

  Format: LocalDateTime.

  withdrawnAt

  string

  format: date-time

  Format: LocalDateTime.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationTimeProfileChanged

  • #System Events

  Accepts the following message:

  AuthorizationTimeProfileChanged

  Required permission: ChangeTimeProfile

  Commands confirmed by this event:

   • ChangeAuthorizationTimeProfileMapi

  Payload

  Expand all

  object

  description

  string

  exceptionTimeSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  timeSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  validStandardTimeProfile

  boolean

  flag to verify if time profile would be a valid standard time profile, if selected.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationTimeProfileCreated

  • #System Events

  Accepts the following message:

  AuthorizationTimeProfileCreated

  Required permission: CreateTimeProfile

  Commands confirmed by this event:

   • CreateAuthorizationTimeProfileMapi

  Payload

  Expand all

  object

  description

  string

  exceptionTimeSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  timeSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  type

  string

  Allowed values: OFFICE_MODE, AUTHORIZATION_PROFILE.

  validStandardTimeProfile

  boolean

  flag to verify if time profile would be a valid standard time profile, if selected.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/AuthorizationTimeProfileDeleted

  • #System Events

  Accepts the following message:

  AuthorizationTimeProfileDeleted

  Required permission: RemoveTimeProfile

  Commands confirmed by this event:

   • DeleteAuthorizationTimeProfileMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/CalendarChanged

  • #System Events

  Accepts the following message:

  CalendarChanged

  Required permission: ChangeCalendar

  Commands confirmed by this event:

   • ChangeCalendarMapi

  Payload

  Expand all

  object

  calendarIdentifier

  integer

  format: int32

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  specialDays

  Expand all

  array<string>

  Array

  Items:

  string

  format: date

  Additional properties are allowed.

  Examples

  Payload

  {
    "calendarIdentifier": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "specialDays": [
      "2019-08-24"
    ]
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/CalendarCreated

  • #System Events

  Accepts the following message:

  CalendarCreated

  Required permission: CreateCalendar

  Commands confirmed by this event:

   • CreateCalendarMapi

  Payload

  Expand all

  object

  calendarIdentifier

  integer

  format: int32

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  partitionId

  string

  format: uuid

  Format: UUID.

  specialDays

  Expand all

  array<string>

  Array

  Items:

  string

  format: date

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/CalendarDeleted

  • #System Events

  Accepts the following message:

  CalendarDeleted

  Required permission: RemoveCalendar

  Commands confirmed by this event:

   • DeleteCalendarMapi

  Payload

  Expand all

  object

  calendarIdentifier

  integer

  format: int32

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "calendarIdentifier": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/CodingStationChanged

  • #System Events

  Accepts the following message:

  CodingStationChanged

  Required permission: ChangeCodingStationData

  Commands confirmed by this event:

   • ChangeCodingStationMapi

  Payload

  Expand all

  object

  description

  string

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/CodingStationCreated

  • #System Events

  Accepts the following message:

  CodingStationCreated

  Required permission: AddCodingStation

  Commands confirmed by this event:

   • CreateCodingStationMapi

  Payload

  Expand all

  object

  description

  string

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  partitionId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/CodingStationDeleted

  • #System Events

  Accepts the following message:

  CodingStationDeleted

  Required permission: RemoveCodingStation

  Commands confirmed by this event:

   • DeleteCodingStationMapi

  Payload

  Expand all

  object

  deletedAt

  string

  format: date-time

  Format: LocalDateTime.

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/EvvaComponentAdded

  • #System Events

  Accepts the following message:

  EvvaComponentAdded

  Required permission: ChangeInstallationPointData

  Commands confirmed by this event:

   • AddEvvaComponentMapi

   • CreateInstallationPointMapi

  Payload

  Expand all

  object

  batteryCondition

  string

  The condition of the battery ('Undefined' if evva component has no battery or value is unknown at the moment). Allowed values: Full, AlmostEmpty, Undefined.

  batteryWarning

  boolean

  Deprecated.

  componentParts

  Expand all

  array<object>

  Array

  busAddress

  integer

  format: int32

  firmwareVersion

  Expand all

  object

  electricalVersion

  string

  firmwareUpdateFileFormatVersion

  integer

  format: int32

  firmwareVariant

  string

  internalRevision

  string

  major

  integer

  format: int32

  majorBootloader

  integer

  format: int32

  mechanicalVersion

  string

  minor

  integer

  format: int32

  minorBootloader

  integer

  format: int32

  Additional properties are allowed.

  hardwareVersion

  Expand all

  object

  hardwareComponentType

  string

  productComponentType

  string

  subComponent

  string

  format: char

  Format: char.

  versionHardware

  string

  format: char

  Format: char.

  Additional properties are allowed.

  serialNumber

  string

  evvaComponentId

  string

  format: uuid

  Format: UUID.

  firmwareVersion

  Expand all

  object

  electricalVersion

  string

  firmwareUpdateFileFormatVersion

  integer

  format: int32

  firmwareVariant

  string

  internalRevision

  string

  major

  integer

  format: int32

  majorBootloader

  integer

  format: int32

  mechanicalVersion

  string

  minor

  integer

  format: int32

  minorBootloader

  integer

  format: int32

  Additional properties are allowed.

  id

  string

  format: uuid

  Format: UUID.

  nonce

  integer

  format: int64

  Format: long.

  onlineStatus

  string

  The online status of an online wallreader, or 'offline' for offline evva components Allowed values: connected, disconnected, offline.

  serialNumber

  string

  stateChangedAt

  string

  format: date-time

  Format: LocalDateTime.

  status

  string

  The status of the evva component (e.g whether the configuration is up-to-date or not). Allowed values: AssembledPrepared, Synced, NotSynced, RemovePrepared.

  type

  string

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

  useOddKey

  boolean

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/EvvaComponentRemovalPrepared

  • #System Events

  Accepts the following message:

  EvvaComponentRemovalPrepared

  Required permission: RemoveEvvaComponent

  Commands confirmed by this event:

   • PrepareRemovalOfEvvaComponentMapi

  Payload

  Expand all

  object

  aggregateId

  string

  format: uuid

  Format: UUID.

  linkedInstallationPoints

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  stateChangedAt

  string

  format: date-time

  Format: LocalDateTime.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/EvvaComponentRemoved

  • #System Events

  Accepts the following message:

  EvvaComponentRemoved

  Required permission: RemoveFaultyEvvaComponent

  Commands confirmed by this event:

   • ForceRemoveEvvaComponentMapi

  Payload

  Expand all

  object

  accessId

  integer

  format: int64

  Format: long.

  aggregateId

  string

  format: uuid

  Format: UUID.

  forced

  boolean

  linkedInstallationPointIds

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  lockedMediaWithAccess

  Expand all

  array<integer>

  Array

  Items:

  integer

  format: int64

  maintenanceComponentId

  string

  format: uuid

  Format: UUID.

  nonce

  integer

  format: int64

  Format: long.

  stateChangedAt

  string

  format: date-time

  Format: LocalDateTime.

  useOddKey

  boolean

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/FindComponentPerformed

  • #System Events

  Accepts the following message:

  FindComponentPerformed

  Required permission: SearchOnlineEvvaComponent

  Commands confirmed by this event:

   • FindComponentMapi

  Payload

  Expand all

  object

  ok

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "ok": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/IndividualAuthorizationsAddedToMedium

  • #System Events

  Accepts the following message:

  IndividualAuthorizationsAddedToMedium

  Required permission: any of:

   • AssignInstallationPointIndividualAuthorization

   • AssignZoneIndividualAuthorization

  Commands confirmed by this event:

   • AddInstallationPointAuthorizationToMediumMapi

   • AddZoneAuthorizationToMediumMapi

  Payload

  Expand all

  object

  authorizationProfiles

  Expand all

  array<object>

  Array

  authorizationId

  string

  format: uuid

  Format: UUID. The id of the target installation point or zone.

  authorizationName

  string

  The name of the installationPoint or zone.

  authorizationProfileId

  string

  format: uuid

  Format: UUID. The id of the (individual) authorization profile. May be NULL for new (individual) authorization profiles.

  installationPoint

  boolean

  Indicates whether the (individual) authorization targets an installation point (TRUE) or a zone (FALSE).

  timeProfileId

  string

  format: uuid

  Format: UUID.

  timeProfileName

  string

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/IndividualAuthorizationsDeleted

  • #System Events

  Accepts the following message:

  IndividualAuthorizationsDeleted

  Required permission: any of:

   • RemoveInstallationPointIndividualAuthorization

   • RemoveZoneIndividualAuthorization

  Commands confirmed by this event:

   • RemoveInstallationPointAuthorizationFromMediumMapi

   • RemoveZoneAuthorizationFromMediumMapi

  Payload

  Expand all

  object

  individualAuthorizations

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  mediumId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "individualAuthorizations": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "mediumId": "1f1240af-f659-4fb4-ae3e-9e0f9fd2ed9d"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/InstallationPointChanged

  • #System Events

  Accepts the following message:

  InstallationPointChanged

  Required permission: any of:

   • AssignOfficeModeTimeProfileToInstallationPoint

   • ChangeInstallationPointData

   • ConfigureLoggingPersonalDataForInstallationPoint

   • ConfigureManualOfficeModeAndShopMode

   • ConfigureMediaUpgrade

   • ConfigureReleaseDuration

  Commands confirmed by this event:

   • AddEvvaComponentMapi

   • ChangeInstallationPointMapi

   • ChangeInstallationPointMetadataValueMapi

   • ConfigureBluetoothStateMapi

   • ConfigureManualOfficeModeAndShopModeMapi

   • ConfigureMediaUpgradeMapi

   • ConfigureOfficeModeTimeProfileMapi

   • ConfigureReleaseDurationMapi

   • SetPersonalReferenceDurationForInstallationPointMapi

  Payload

  Expand all

  object

  aggregateId

  string

  format: uuid

  Format: UUID.

  bluetoothState

  string

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

  description

  string

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  installationId

  string

  installationType

  string

  linkedInstallationPoints

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  manualOfficeMode

  boolean

  name

  string

  openDoor

  boolean

  personalReferenceDuration

  Expand all

  object

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  personalReferenceDurationOld

  Expand all

  object

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  releaseDurationLong

  integer

  format: int32

  releaseDurationShort

  integer

  format: int32

  shopMode

  boolean

  timeProfileData

  Expand all

  object

  exceptionTimePointSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<integer>

  Array

  Items:

  integer

  format: int32

  points

  Expand all

  array<string>

  Array

  Items:

  string

  format: time

  exceptionTimeSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<integer>

  Array

  Items:

  integer

  format: int32

  times

  Expand all

  array<object>

  Array

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  timePointSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  points

  Expand all

  array<string>

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

  Items:

  string

  format: time

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

  timeSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  Additional properties are allowed.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  timeProfileName

  string

  upgradeMedia

  boolean

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/InstallationPointCreated

  • #System Events

  Accepts the following message:

  InstallationPointCreated

  Required permission: AddInstallationPoint

  Commands confirmed by this event:

   • CreateInstallationPointMapi

  Payload

  Expand all

  object

  accessId

  integer

  format: int64

  Format: long.

  afterNextDstTransition

  Expand all

  object

  Format: ZoneOffsetTransition, Deprecated.

  Additional properties are allowed.

  calendarData

  Expand all

  object

  calendars

  Expand all

  object

  Format: Map.

  Additional properties are allowed.

  Additional properties are allowed.

  componentType

  string

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

  description

  string

  dstTransitions

  Expand all

  object

  dstTransitions

  Expand all

  array<object>

  Array

  epochSecond

  integer

  format: int64

  Format: long.

  offsetAfter

  Expand all

  object

  Additional properties are allowed.

  offsetBefore

  Expand all

  object

  Additional properties are allowed.

  transition

  string

  format: date-time

  Format: LocalDateTime.

  Additional properties are allowed.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  evvaComponentId

  string

  format: uuid

  Format: UUID.

  id

  string

  format: uuid

  Format: UUID.

  installationId

  string

  installationType

  string

  instance

  integer

  format: int32

  linkedInstallationPoints

  Expand all

  array<object>

  Array

  accessId

  integer

  format: int64

  Format: long.

  aggregateId

  string

  format: uuid

  Format: UUID.

  componentType

  string

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

  evvaComponentId

  string

  format: uuid

  Format: UUID.

  installationPointProperties

  Expand all

  object

  bluetoothState

  string

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

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  installationId

  string

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

  installationType

  string

  All unicode characters allowed. Size between 0 and 50.

  manualOfficeMode

  boolean

  name

  string

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

  openDoor

  boolean

  partitionId

  string

  format: uuid

  Format: UUID, Required.

  personalReferenceDuration

  Expand all

  object

  Required.

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  releaseDurationLong

  integer

  format: int32

  Min: 2. Max: 255.

  releaseDurationShort

  integer

  format: int32

  Min: 2. Max: 255.

  shopMode

  boolean

  timeProfileId

  string

  format: uuid

  Format: UUID.

  upgradeMedia

  boolean

  Additional properties are allowed.

  manualOfficeMode

  boolean

  name

  string

  nextDstTransition

  Expand all

  object

  Format: ZoneOffsetTransition, Deprecated.

  Additional properties are allowed.

  openDoor

  boolean

  partitionId

  string

  format: uuid

  Format: UUID.

  personalReferenceDuration

  Expand all

  object

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  releaseDurationLong

  integer

  format: int32

  releaseDurationShort

  integer

  format: int32

  shopMode

  boolean

  timeProfileData

  Expand all

  object

  exceptionTimePointSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<integer>

  Array

  Items:

  integer

  format: int32

  points

  Expand all

  array<string>

  Array

  Items:

  string

  format: time

  exceptionTimeSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<integer>

  Array

  Items:

  integer

  format: int32

  times

  Expand all

  array<object>

  Array

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  timePointSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  points

  Expand all

  array<string>

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

  Items:

  string

  format: time

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

  timeSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  Additional properties are allowed.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  timeProfileName

  string

  upgradeMedia

  boolean

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/InstallationPointDeleted

  • #System Events

  Accepts the following message:

  InstallationPointDeleted

  Required permission: RemoveInstallationPoint

  Commands confirmed by this event:

   • DeleteInstallationPointMapi

  Payload

  Expand all

  object

  authorizationProfiles

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  id

  string

  format: uuid

  Format: UUID.

  linkedInstallationPoints

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  timeProfile

  string

  format: uuid

  Format: UUID.

  zones

  Expand all

  array<integer>

  Array

  Items:

  integer

  format: int32

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/InstallationPointMetadataDefinitionsUpdated

  • #System Events

  Accepts the following message:

  InstallationPointMetadataDefinitionsUpdated

  Required permission: ChangeEntityMetadataValue

  Commands confirmed by this event:

   • AddEntityMetadataDefinitionMapi

   • DeleteEntityMetadataDefinitionMapi

   • RenameEntityMetadataDefinitionMapi

  Payload

  Expand all

  object

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "entityMetadata": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "value": "string"
      }
    ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/InstallationPointsInZoneChanged

  • #System Events

  Accepts the following message:

  InstallationPointsInZoneChanged

  Required permission: any of:

   • AssignInstallationPointToZone

   • RemoveInstallationPointFromZone

  Commands confirmed by this event:

   • AddInstallationPointToZoneMapi

   • RemoveInstallationPointFromZoneMapi

  Payload

  Expand all

  object

  accessId

  integer

  format: int32

  addedInstallationPoints

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  aggregateId

  string

  format: uuid

  Format: UUID.

  removedInstallationPoints

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/LoggedOut

  • #Session

  Accepts the following message:

  LoggedOut

  Required permission: LoginAdministrationComponent

  Commands confirmed by this event:

   • Logout

  Payload

  Expand all

  object

  token

  string

  Returns the corresponding token that was used for the Logout command. This token can be used to correlate the event with the command.

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/MediumAddedToInstallation

  • #System Events

  Accepts the following message:

  MediumAddedToInstallation

  Required permission: AddIdentificationMedium

  Commands confirmed by this event:

   • RequestAddMediumToInstallationMapi

  Payload

  Expand all

  object

  aggregateId

  string

  format: uuid

  Format: UUID.

  hardwareId

  string

  An array of bytes represented as a Base64 encoded string.

  label

  string

  mediumIdentifier

  integer

  format: int64

  Format: long.

  nativeId

  string

  An array of bytes represented as a Base64 encoded string.

  Additional properties are allowed.

  Examples

  Payload

  {
    "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
    "hardwareId": "string",
    "label": "string",
    "mediumIdentifier": 0,
    "nativeId": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/MediumAuthorizationProfileChanged

  • #System Events

  Accepts the following message:

  MediumAuthorizationProfileChanged

  Required permission: AssignAuthorizationProfileToIdentificationMedium

  Commands confirmed by this event:

   • AssignAuthorizationProfileToMediumMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  newAuthorizationProfileId

  string

  format: uuid

  Format: UUID.

  oldAuthorizationProfileId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/MediumChanged

  • #System Events

  Accepts the following message:

  MediumChanged

  Required permission: any of:

   • ChangeDisengagePeriodOnMedium

   • ChangeValidityDurationOnMedium

   • SetAuthorizationBeginAtOnMedium

   • SetAuthorizationEndAtOnMedium

   • SetMediumLabel

  Commands confirmed by this event:

   • AssignAuthorizationProfileToMediumMapi

   • AssignPersonToMediumMapi

   • ChangeMediumMetadataValueMapi

   • SetAccessBeginAtMapi

   • SetAccessEndAtMapi

   • SetDisengagePeriodOnMediumMapi

   • SetLabelOnMediumMapi

   • SetMessageLanguageOnSmartphoneMapi

   • SetPhoneNumberOnSmartphoneMapi

   • SetValidityDurationMapi

   • UnassignPersonFromMediumMapi

  Payload

  Expand all

  object

  accessBeginAt

  string

  format: date-time

  Format: LocalDateTime.

  accessEndAt

  string

  format: date-time

  Format: LocalDateTime.

  authorizationProfileId

  string

  format: uuid

  Format: UUID.

  changedAt

  string

  format: date-time

  Format: LocalDateTime.

  disengagePeriod

  string

  How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  label

  string

  messageLanguage

  string

  phoneNumber

  string

  validFrom

  string

  format: date-time

  Format: LocalDateTime.

  validUntil

  string

  format: date-time

  Format: LocalDateTime.

  validityDuration

  integer

  format: int32

  Format: Short.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/MediumLocked

  • #System Events

  Accepts the following message:

  MediumLocked

  Required permission: LockMedium

  Commands confirmed by this event:

   • LockMediumMapi

  Payload

  Expand all

  object

  aggregateId

  string

  format: uuid

  Format: UUID.

  authorizationProfileId

  string

  format: uuid

  Format: UUID.

  hasMasterKeyAccess

  boolean

  individualAuthorizations

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  installationPoints

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  mediumIdentifier

  integer

  format: int64

  Format: Long.

  validityEnd

  string

  format: date-time

  Format: LocalDateTime.

  zones

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/MediumMetadataDefinitionsUpdated

  • #System Events

  Accepts the following message:

  MediumMetadataDefinitionsUpdated

  Required permission: ChangeEntityMetadataValue

  Commands confirmed by this event:

   • AddEntityMetadataDefinitionMapi

   • DeleteEntityMetadataDefinitionMapi

   • RenameEntityMetadataDefinitionMapi

  Payload

  Expand all

  object

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "entityMetadata": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "value": "string"
      }
    ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/MediumPersonChanged

  • #System Events

  Accepts the following message:

  MediumPersonChanged

  Required permission: AssignMediumToPerson

  Commands confirmed by this event:

   • AssignPersonToMediumMapi

   • UnassignPersonFromMediumMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  newPersonId

  string

  format: uuid

  Format: UUID.

  oldPersonId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/MediumRevoked

  • #System Events

  Accepts the following message:

  MediumRevoked

  Required permission: RevokeMedium

  Commands confirmed by this event:

   • RevokeSmartphoneMapi

  Payload

  Expand all

  object

  authorizationProfileId

  string

  format: uuid

  Format: UUID.

  id

  string

  format: uuid

  Format: UUID.

  individualAuthorizations

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  sagaId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "authorizationProfileId": "33a58df6-edec-4144-9bb7-d1b2447001ee",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "individualAuthorizations": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "sagaId": "d171ccc5-4e45-4ee5-8129-c6924a02cf9a"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/MobileRegistrationStateUpdated

  • #System Events

  Accepts the following message:

  MobileRegistrationStateUpdated

  Required permission: ChangeIssuedMedium

  Commands confirmed by this event:

   • AddSmartphoneToInstallationMapi

   • RequestNewRegistrationCodeMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID. The ID of the Smartphone.

  registrationCode

  string

  The registration code that may be used to register the smartphone. Will only be present (non-null) if the registrationState is REGISTRATION_REQUESTED.

  registrationCodeValidUntil

  string

  format: date-time

  Format: LocalDateTime. The UTC timestamp until the registration code is valid.

  registrationState

  string

  Allowed values: STARTED, REGISTRATION_REQUESTED, COMPLETED, UNREGISTRATION_STARTED, REMOVED. The registration state the smartphone is in.

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "registrationCode": "string",
    "registrationCodeValidUntil": "2019-08-24T14:15:22Z",
    "registrationState": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/NewRegistrationCodeRequested

  • #System Events

  Accepts the following message:

  NewRegistrationCodeRequested

  Required permission: ChangeIssuedMedium

  Commands confirmed by this event:

   • RequestNewRegistrationCodeMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/OfficeModeTimeProfileChanged

  • #System Events

  Accepts the following message:

  OfficeModeTimeProfileChanged

  Required permission: ChangeTimeProfile

  Commands confirmed by this event:

   • ChangeOfficeModeTimeProfileMapi

  Payload

  Expand all

  object

  description

  string

  exceptionTimePointSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  points

  Expand all

  array<string>

  Array. List of time points. Example: ["10:00", "12:00"].

  Items:

  string

  format: time

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

  exceptionTimeSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  timePointSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  points

  Expand all

  array<string>

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

  Items:

  string

  format: time

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

  timeSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/OfficeModeTimeProfileCreated

  • #System Events

  Accepts the following message:

  OfficeModeTimeProfileCreated

  Required permission: CreateTimeProfile

  Commands confirmed by this event:

   • CreateOfficeModeTimeProfileMapi

  Payload

  Expand all

  object

  description

  string

  exceptionTimePointSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  points

  Expand all

  array<string>

  Array. List of time points. Example: ["10:00", "12:00"].

  Items:

  string

  format: time

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

  exceptionTimeSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  timePointSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  points

  Expand all

  array<string>

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

  Items:

  string

  format: time

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

  timeSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/OfficeModeTimeProfileDeleted

  • #System Events

  Accepts the following message:

  OfficeModeTimeProfileDeleted

  Required permission: RemoveTimeProfile

  Commands confirmed by this event:

   • DeleteOfficeModeTimeProfileMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/PartitionChanged

  • #System Events

  Accepts the following message:

  PartitionChanged

  Required permission: any of:

   • ConfigureDailySchedulerExecutionTime

   • ConfigureDefaultLoggingPersonalDataForInstallationPoint

   • ConfigureDefaultLoggingPersonalDataForPerson

   • ConfigurePasswordPolicy

   • ConfigureValidityThreshold

   • SetDefaultAccessDurationForReplacedMedium

   • SetDefaultMediumValidityDurationForPartition

  Commands confirmed by this event:

   • AddEntityMetadataDefinitionMapi

   • DeleteEntityMetadataDefinitionMapi

   • RenameEntityMetadataDefinitionMapi

   • SetDailySchedulerExecutionTimeMapi

   • SetDefaultSmartphoneValidityDurationMapi

   • SetDefaultValidityDurationMapi

   • SetInstallationPointPersonalReferenceDurationMapi

   • SetMobileServiceModeMapi

   • SetPersonPersonalReferenceDurationMapi

   • SetReplacementMediumDurationMapi

   • SetValidityThresholdMapi

  Payload

  Expand all

  object

  dailySchedulerExecutionTime

  string

  format: time

  Format: LocalTime.

  entityMetadataDefinitions

  Expand all

  object

  authorizationProfiles

  Expand all

  array<object>

  Array. The custom metadata that can be set for each authorization profile entity.

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata. Only used for determining changes in name between two EntityMetadataDefinition. Avoid setting this manually.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  identificationMedia

  Expand all

  array<object>

  Array. The custom metadata that can be set for each identification medium entity.

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata. Only used for determining changes in name between two EntityMetadataDefinition. Avoid setting this manually.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  installationPoints

  Expand all

  array<object>

  Array. The custom metadata that can be set for each installation point entity.

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata. Only used for determining changes in name between two EntityMetadataDefinition. Avoid setting this manually.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  persons

  Expand all

  array<object>

  Array. The custom metadata that can be set for each person entity.

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata. Only used for determining changes in name between two EntityMetadataDefinition. Avoid setting this manually.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  zones

  Expand all

  array<object>

  Array. The custom metadata that can be set for each zone entity.

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata. Only used for determining changes in name between two EntityMetadataDefinition. Avoid setting this manually.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  Additional properties are allowed.

  id

  string

  format: uuid

  Format: UUID.

  installationPointDefaultPersonalReferenceDuration

  Expand all

  object

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  maximumEntityMetadataDefinitions

  integer

  format: int32

  Format: short.

  mobileServiceMode

  string

  Enum for the Mobile Service mode. Used to describe the application's method of communication with Smartphones. Allowed values: XMS, SELF_SERVICE.

  mqttServerAddress

  Expand all

  object

  Format: InetAddress.

  Additional properties are allowed.

  passwordPolicy

  Expand all

  object

  digits

  Expand all

  object

  minCount

  integer

  format: int32

  Min: 1. Max: 5.

  required

  boolean

  Additional properties are allowed.

  enabled

  boolean

  lowercase

  Expand all

  object

  minCount

  integer

  format: int32

  Min: 1. Max: 5.

  required

  boolean

  Additional properties are allowed.

  minLength

  integer

  format: int32

  Min: 6. Max: 254.

  symbols

  Expand all

  object

  minCount

  integer

  format: int32

  Min: 1. Max: 5.

  required

  boolean

  Additional properties are allowed.

  uppercase

  Expand all

  object

  minCount

  integer

  format: int32

  Min: 1. Max: 5.

  required

  boolean

  Additional properties are allowed.

  Additional properties are allowed.

  personDefaultPersonalReferenceDuration

  Expand all

  object

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  replacementMediumDuration

  integer

  format: int32

  Format: Short.

  smartphoneValidityDuration

  integer

  format: int32

  Format: Short.

  smartphoneValidityThreshold

  integer

  format: int32

  Format: Short.

  storeDataOnTablet

  boolean

  tokenValidityDurationMinutes

  integer

  format: int32

  validityDuration

  integer

  format: int32

  Format: Short.

  validityThreshold

  integer

  format: int32

  Format: Short.

  Additional properties are allowed.

  Examples

  Payload

  {
    "dailySchedulerExecutionTime": "14:15:22Z",
    "entityMetadataDefinitions": {
      "authorizationProfiles": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ],
      "identificationMedia": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ],
      "installationPoints": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ],
      "persons": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ],
      "zones": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      ]
    },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "installationPointDefaultPersonalReferenceDuration": {
      "days": 0,
      "logMode": "string"
    },
    "maximumEntityMetadataDefinitions": 0,
    "mobileServiceMode": "string",
    "mqttServerAddress": {},
    "passwordPolicy": {
      "digits": {
        "minCount": 0,
        "required": true
      },
      "enabled": true,
      "lowercase": {
        "minCount": 0,
        "required": true
      },
      "minLength": 0,
      "symbols": {
        "minCount": 0,
        "required": true
      },
      "uppercase": {
        "minCount": 0,
        "required": true
      }
    },
    "personDefaultPersonalReferenceDuration": {
      "days": 0,
      "logMode": "string"
    },
    "replacementMediumDuration": 0,
    "smartphoneValidityDuration": 0,
    "smartphoneValidityThreshold": 0,
    "storeDataOnTablet": true,
    "tokenValidityDurationMinutes": 0,
    "validityDuration": 0,
    "validityThreshold": 0
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/PersonChanged

  • #System Events

  Accepts the following message:

  PersonChanged

  Required permission: any of:

   • ChangePersonData

   • ConfigureLoggingPersonalDataForPerson

   • SetDefaultAuthorizationProfileForPerson

   • SetDefaultDisengagePeriodForPerson

  Commands confirmed by this event:

   • ChangePersonInformationMapi

   • ChangePersonMetadataValueMapi

   • SetDefaultAuthorizationProfileForPersonMapi

   • SetDefaultDisengagePeriodForPersonMapi

   • SetPersonalReferenceDurationInPersonMapi

  Payload

  Expand all

  object

  defaultAuthorizationProfileId

  string

  format: uuid

  Format: UUID.

  disengagePeriod

  string

  How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  firstName

  string

  id

  string

  format: uuid

  Format: UUID.

  identifier

  string

  lastName

  string

  oldDefaultAuthorizationProfileId

  string

  format: uuid

  Format: UUID.

  oldPersonalReferenceDuration

  Expand all

  object

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  personalReferenceDuration

  Expand all

  object

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/PersonCreated

  • #System Events

  Accepts the following message:

  PersonCreated

  Required permission: CreatePerson

  Commands confirmed by this event:

   • CreatePersonMapi

  Payload

  Expand all

  object

  defaultAuthorizationProfileId

  string

  format: uuid

  Format: UUID.

  disengagePeriod

  string

  How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  externalId

  string

  firstName

  string

  id

  string

  format: uuid

  Format: UUID.

  identifier

  string

  lastName

  string

  partitionId

  string

  format: uuid

  Format: UUID.

  personalReferenceDuration

  Expand all

  object

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/PersonDeleted

  • #System Events

  Accepts the following message:

  PersonDeleted

  Required permission: RemovePerson

  Commands confirmed by this event:

   • DeletePersonMapi

  Payload

  Expand all

  object

  defaultAuthorizationProfileId

  string

  format: uuid

  Format: UUID.

  id

  string

  format: uuid

  Format: UUID.

  mediums

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/PersonMetadataDefinitionsUpdated

  • #System Events

  Accepts the following message:

  PersonMetadataDefinitionsUpdated

  Required permission: ChangeEntityMetadataValue

  Commands confirmed by this event:

   • AddEntityMetadataDefinitionMapi

   • DeleteEntityMetadataDefinitionMapi

   • RenameEntityMetadataDefinitionMapi

  Payload

  Expand all

  object

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "entityMetadata": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "value": "string"
      }
    ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/PhoneNumberChanged

  • #System Events

  Accepts the following message:

  PhoneNumberChanged

  Required permission: SetMediumLabel

  Commands confirmed by this event:

   • SetPhoneNumberOnSmartphoneMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  phoneNumber

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "phoneNumber": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/PrepareEvvaComponentRemovalReverted

  • #System Events

  Accepts the following message:

  PrepareEvvaComponentRemovalReverted

  Required permission: RevertRemoveComponent

  Commands confirmed by this event:

   • RevertPrepareRemovalOfEvvaComponentMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  linkedInstallationPoints

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  stateChangedAt

  string

  format: date-time

  Format: LocalDateTime.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/RemoteDisengagePerformed

  • #System Events

  Accepts the following message:

  RemoteDisengagePerformed

  Required permission: TriggerRemoteDisengage

  Commands confirmed by this event:

   • RemoteDisengageMapi

  Payload

  Expand all

  object

  ok

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "ok": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/RemoteDisengagePermanentPerformed

  • #System Events

  Accepts the following message:

  RemoteDisengagePermanentPerformed

  Required permission: TriggerRemoteDisengage

  Commands confirmed by this event:

   • RemoteDisengagePermanentMapi

  Payload

  Expand all

  object

  ok

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "ok": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/SmartphoneAddedToInstallation

  • #System Events

  Accepts the following message:

  SmartphoneAddedToInstallation

  Required permission: AddSmartphone

  Commands confirmed by this event:

   • AddSmartphoneToInstallationMapi

  Payload

  Expand all

  object

  accessBeginAt

  string

  format: date-time

  Format: LocalDateTime.

  accessEndAt

  string

  format: date-time

  Format: LocalDateTime.

  aggregateId

  string

  format: uuid

  Format: UUID.

  authorizationProfileId

  string

  format: uuid

  Format: UUID.

  disengagePeriod

  string

  How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  individualAuthorizations

  Expand all

  array<object>

  Array

  authorizationId

  string

  format: uuid

  Format: UUID. The id of the target installation point or zone.

  authorizationName

  string

  The name of the installationPoint or zone.

  authorizationProfileId

  string

  format: uuid

  Format: UUID. The id of the (individual) authorization profile. May be NULL for new (individual) authorization profiles.

  installationPoint

  boolean

  Indicates whether the (individual) authorization targets an installation point (TRUE) or a zone (FALSE).

  timeProfileId

  string

  format: uuid

  Format: UUID.

  timeProfileName

  string

  issuedAt

  string

  format: date-time

  Format: LocalDateTime.

  label

  string

  mediumIdentifier

  integer

  format: int64

  Format: long.

  messageLanguage

  string

  partitionId

  string

  format: uuid

  Format: UUID.

  personId

  string

  format: uuid

  Format: UUID.

  phoneNumber

  string

  sagaId

  string

  format: uuid

  Format: UUID.

  validityBeginAt

  string

  format: date-time

  Format: LocalDateTime.

  validityDuration

  integer

  format: int32

  Format: Short.

  validityEndAt

  string

  format: date-time

  Format: LocalDateTime.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/SmartphoneAuthorizationsResent

  • #System Events

  Accepts the following message:

  SmartphoneAuthorizationsResent

  Required permission: ChangeIssuedMedium

  Commands confirmed by this event:

   • ResendSmartphoneAuthorizationsMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/SmartphoneUnregistered

  • #System Events

  Accepts the following message:

  SmartphoneUnregistered

  Required permission: ChangeIssuedMedium

  Commands confirmed by this event:

   • UnregisterSmartphoneMapi

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/UnauthorizedLoginAttempt

  • #Session

  Accepts the following message:

  UnauthorizedLoginAttempt

  Login attempt with wrong credentials. System administrators can monitor this message for attack mitigation.

  Payload

  Expand all

  object

  channel

  string

  Allowed values: API, WEB, MAINTENANCE_COMPONENT, WEB_2FA.

  ipAddress

  string

  username

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "channel": "string",
    "ipAddress": "string",
    "username": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/ces/UserGroupChanged

  • #System Events

  Accepts the following message:

  UserGroupChanged

  Required permission: CreateAuthorizationProfile

  Commands confirmed by this event:

   • ConfigureAssignableAuthorizationProfilesMapi

  Payload

  Expand all

  object

  assignableAuthorizationProfiles

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  description

  string

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  permissions

  Expand all

  array<string>

  Array

  Items:

  string

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/ZoneChanged

  • #System Events

  Accepts the following message:

  ZoneChanged

  Required permission: ChangeZoneData

  Commands confirmed by this event:

   • ChangeZoneDataMapi

   • ChangeZoneMetadataValueMapi

  Payload

  Expand all

  object

  description

  string

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/ZoneCreated

  • #System Events

  Accepts the following message:

  ZoneCreated

  Required permission: CreateZone

  Commands confirmed by this event:

   • CreateZoneMapi

  Payload

  Expand all

  object

  accessId

  integer

  format: int32

  description

  string

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  name

  string

  partitionId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/ZoneDeleted

  • #System Events

  Accepts the following message:

  ZoneDeleted

  Required permission: RemoveZone

  Commands confirmed by this event:

   • DeleteZoneMapi

  Payload

  Expand all

  object

  authorizationProfileIds

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  deletedAt

  string

  format: date-time

  Format: LocalDateTime.

  id

  string

  format: uuid

  Format: UUID.

  installationPointIds

  Expand all

  array<string>

  Array

  Items:

  string

  format: uuid

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/ces/ZoneMetadataDefinitionsUpdated

  • #System Events

  Accepts the following message:

  ZoneMetadataDefinitionsUpdated

  Required permission: ChangeEntityMetadataValue

  Commands confirmed by this event:

   • AddEntityMetadataDefinitionMapi

   • DeleteEntityMetadataDefinitionMapi

   • RenameEntityMetadataDefinitionMapi

  Payload

  Expand all

  object

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

  {
    "entityMetadata": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "value": "string"
      }
    ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/AddEntityMetadataDefinitionMapi

  • #Command

  Accepts the following message:

  AddEntityMetadataDefinitionMapi

  Add one or more metadata definitions to a Xesar entity of the default partition. If any metadata definition with the same name already exists it will be ignored.

  Required permission: ConfigureEntityMetadataDefinitions

  Events confirming this command:

   • AuthorizationProfileMetadataDefinitionsUpdated

   • InstallationPointMetadataDefinitionsUpdated

   • MediumMetadataDefinitionsUpdated

   • PartitionChanged

   • PersonMetadataDefinitionsUpdated

   • ZoneMetadataDefinitionsUpdated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  entityType

  string

  Represents Xesar aggregates that support custom metadata definitions. Allowed values: PERSON, IDENTIFICATION_MEDIUM, ZONE, INSTALLATION_POINT, AUTHORIZATION_PROFILE. The target entity type to add the metadata definitions to.Required.

  names

  Expand all

  array<string>

  Array. The names of the metadata definitions to add. Each name should be unique.

  Items:

  string

  The names of the metadata definitions to add. Each name should be unique.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "entityType": "string",
    "names": [
      "string"
    ],
    "token": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/AddEvvaComponentMapi

  • #Command

  Accepts the following message:

  AddEvvaComponentMapi

  Add an Evva component to an existing installation point.

  Required permission: ChangeInstallationPointData

  Events confirming this command:

   • EvvaComponentAdded

   • InstallationPointChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Id of the installation point.

  Required.

  token

  string

  Required.

  type

  string

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

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/AddInstallationPointAuthorizationToMediumMapi

  • #Command

  Accepts the following message:

  AddInstallationPointAuthorizationToMediumMapi

  Add individual authorisation for an installation point.

  Required permission: AssignInstallationPointIndividualAuthorization

  Events confirming this command:

   • IndividualAuthorizationsAddedToMedium

  Payload

  Expand all

  object

  authorization

  Expand all

  object

  authorizationId

  string

  format: uuid

  Format: UUID. The id of the target installation point or zone.

  authorizationName

  string

  The name of the installationPoint or zone.

  authorizationProfileId

  string

  format: uuid

  Format: UUID. The id of the (individual) authorization profile. May be NULL for new (individual) authorization profiles.

  installationPoint

  boolean

  Indicates whether the (individual) authorization targets an installation point (TRUE) or a zone (FALSE).

  timeProfileId

  string

  format: uuid

  Format: UUID.

  timeProfileName

  string

  Additional properties are allowed.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/AddInstallationPointToZoneMapi

  • #Command

  Accepts the following message:

  AddInstallationPointToZoneMapi

  Required permission: AssignInstallationPointToZone

  Events confirming this command:

   • InstallationPointsInZoneChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  installationPointId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/AddSmartphoneToInstallationMapi

  • #Command

  Accepts the following message:

  AddSmartphoneToInstallationMapi

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

  Required permission: AddSmartphone

  Events confirming this command:

   • MobileRegistrationStateUpdated

   • SmartphoneAddedToInstallation

  Payload

  Expand all

  object

  accessBeginAt

  string

  format: date-time

  Format: LocalDateTime.

  accessEndAt

  string

  format: date-time

  Format: LocalDateTime.

  authorizationProfileId

  string

  format: uuid

  Format: UUID.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  disengagePeriod

  string

  How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID, Required.

  individualAuthorizations

  Expand all

  array<object>

  Array

  authorizationId

  string

  format: uuid

  Format: UUID. The id of the target installation point or zone.

  authorizationName

  string

  The name of the installationPoint or zone.

  authorizationProfileId

  string

  format: uuid

  Format: UUID. The id of the (individual) authorization profile. May be NULL for new (individual) authorization profiles.

  installationPoint

  boolean

  Indicates whether the (individual) authorization targets an installation point (TRUE) or a zone (FALSE).

  timeProfileId

  string

  format: uuid

  Format: UUID.

  timeProfileName

  string

  label

  string

  All unicode characters allowed. Size between 0 and 255.

  messageLanguage

  string

  The language to use when sending registration SMS to the Smartphone. Only used when the phone number is also provided, and defaults to en if not set.

  Should be an ISO 639-1 language code with 2 characters. The following languages are supported: de,en,fr,it,es,pt,nl,pl,cs,sk,sv.

  partitionId

  string

  format: uuid

  Format: UUID.

  personId

  string

  format: uuid

  Format: UUID.

  phoneNumber

  string

  Phone numbers starting with a '+' and max. 50 characters are allowed.

  token

  string

  Required.

  validityDuration

  integer

  format: int32

  Format: Short.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/AddZoneAuthorizationToMediumMapi

  • #Command

  Accepts the following message:

  AddZoneAuthorizationToMediumMapi

  Required permission: AssignZoneIndividualAuthorization

  Events confirming this command:

   • IndividualAuthorizationsAddedToMedium

  Payload

  Expand all

  object

  authorization

  Expand all

  object

  authorizationId

  string

  format: uuid

  Format: UUID. The id of the target installation point or zone.

  authorizationName

  string

  The name of the installationPoint or zone.

  authorizationProfileId

  string

  format: uuid

  Format: UUID. The id of the (individual) authorization profile. May be NULL for new (individual) authorization profiles.

  installationPoint

  boolean

  Indicates whether the (individual) authorization targets an installation point (TRUE) or a zone (FALSE).

  timeProfileId

  string

  format: uuid

  Format: UUID.

  timeProfileName

  string

  Additional properties are allowed.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/AssignAuthorizationProfileToMediumMapi

  • #Command

  Accepts the following message:

  AssignAuthorizationProfileToMediumMapi

  Required permission: AssignAuthorizationProfileToIdentificationMedium

  Events confirming this command:

   • MediumAuthorizationProfileChanged

   • MediumChanged

  Payload

  Expand all

  object

  authorizationProfileId

  string

  format: uuid

  Format: UUID.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/AssignPersonToMediumMapi

  • #Command

  Accepts the following message:

  AssignPersonToMediumMapi

  Required permission: AssignMediumToPerson

  Events confirming this command:

   • MediumChanged

   • MediumPersonChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  personId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeAuthorizationProfileMapi

  • #Command

  Accepts the following message:

  ChangeAuthorizationProfileMapi

  Required permission: ChangeAuthorizationProfileData

  Events confirming this command:

   • AuthorizationProfileAccessChanged

   • AuthorizationProfileChanged

   • AuthorizationProfileInfoChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID, Required.

  installationPoints

  Expand all

  array<object>

  Array. Array of installation point authorization ids.

  id

  string

  format: uuid

  Format: UUID.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  manualOfficeMode

  boolean

  Required.

  name

  string

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

  standardTimeProfile

  string

  format: uuid

  Format: UUID. Id of a time profile.

  token

  string

  Required.

  zones

  Expand all

  array<object>

  Array. Array of zone authorization ids.

  id

  string

  format: uuid

  Format: UUID.

  timeProfileId

  string

  format: uuid

  Format: UUID.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeAuthorizationProfileMetadataValueMapi

  • #Command

  Accepts the following message:

  ChangeAuthorizationProfileMetadataValueMapi

  Change the value of a metadata field for an Authorization Profile. If the metadata field does not exist, this will fail.

  Required permission: ChangeEntityMetadataValue

  Events confirming this command:

   • AuthorizationProfileInfoChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  metadataId

  string

  format: uuid

  Format: UUID, The ID of the metadata to change.Required.

  token

  string

  Required.

  value

  string

  The value to set the metadata to.Required. All unicode characters allowed. Size between 0 and 255.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "metadataId": "a8818da3-b42d-457d-a430-da2b99a63c47",
    "token": "string",
    "value": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeAuthorizationTimeProfileMapi

  • #Command

  Accepts the following message:

  ChangeAuthorizationTimeProfileMapi

  Required permission: ChangeTimeProfile

  Events confirming this command:

   • AuthorizationTimeProfileChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  exceptionTimeSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  timeSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeCalendarMapi

  • #Command

  Accepts the following message:

  ChangeCalendarMapi

  Required permission: ChangeCalendar

  Events confirming this command:

   • CalendarChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  specialDays

  Expand all

  array<string>

  Array. A list of LocalDates. Example: "2018-02-25, 2018-02-28".

  Items:

  string

  format: date

  A list of LocalDates. Example: "2018-02-25, 2018-02-28".

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeCodingStationMapi

  • #Command

  Accepts the following message:

  ChangeCodingStationMapi

  Required permission: ChangeCodingStationData

  Events confirming this command:

   • CodingStationChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeInstallationPointMapi

  • #Command

  Accepts the following message:

  ChangeInstallationPointMapi

  Required permission: ChangeInstallationPointData

  Events confirming this command:

   • InstallationPointChanged

  Payload

  Expand all

  object

  aggregateId

  string

  format: uuid

  Format: UUID, Required.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  installationId

  string

  All unicode characters allowed. Size between 1 and 50.

  installationType

  string

  All unicode characters allowed. Size between 0 and 50.

  name

  string

  All unicode characters allowed. Size between 1 and 50.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeInstallationPointMetadataValueMapi

  • #Command

  Accepts the following message:

  ChangeInstallationPointMetadataValueMapi

  Change the value of a metadata field for an Installation Point. If the metadata field does not exist, this will fail.

  Required permission: ChangeEntityMetadataValue

  Events confirming this command:

   • InstallationPointChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  metadataId

  string

  format: uuid

  Format: UUID, The ID of the metadata to change.Required.

  token

  string

  Required.

  value

  string

  The value to set the metadata to.Required. All unicode characters allowed. Size between 0 and 255.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "metadataId": "a8818da3-b42d-457d-a430-da2b99a63c47",
    "token": "string",
    "value": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeMediumMetadataValueMapi

  • #Command

  Accepts the following message:

  ChangeMediumMetadataValueMapi

  Change the value of a metadata field for an Identification Medium. If the metadata field does not exist, this will fail.

  Required permission: ChangeEntityMetadataValue

  Events confirming this command:

   • MediumChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  metadataId

  string

  format: uuid

  Format: UUID, The ID of the metadata to change.Required.

  token

  string

  Required.

  value

  string

  The value to set the metadata to.Required. All unicode characters allowed. Size between 0 and 255.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "metadataId": "a8818da3-b42d-457d-a430-da2b99a63c47",
    "token": "string",
    "value": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeOfficeModeTimeProfileMapi

  • #Command

  Accepts the following message:

  ChangeOfficeModeTimeProfileMapi

  Required permission: ChangeTimeProfile

  Events confirming this command:

   • OfficeModeTimeProfileChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  exceptionTimePointSeries

  Expand all

  array<object>

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

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  points

  Expand all

  array<string>

  Array. List of time points. Example: ["10:00", "12:00"].

  Items:

  string

  format: time

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

  exceptionTimeSeries

  Expand all

  array<object>

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

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  timePointSeries

  Expand all

  array<object>

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

  days

  Expand all

  array<string>

  Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  points

  Expand all

  array<string>

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

  Items:

  string

  format: time

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

  timeSeries

  Expand all

  array<object>

  Array. Time intervals for allowing/disallowing entry.

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangePersonInformationMapi

  • #Command

  Accepts the following message:

  ChangePersonInformationMapi

  Required permission: ChangePersonData

  Events confirming this command:

   • PersonChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  externalId

  string

  All unicode characters allowed. Size between 0 and 50.

  firstName

  string

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

  id

  string

  format: uuid

  Format: UUID.

  identifier

  string

  All unicode characters allowed. Size between 0 and 255.

  lastName

  string

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

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangePersonMetadataValueMapi

  • #Command

  Accepts the following message:

  ChangePersonMetadataValueMapi

  Change the value of a metadata field for a Person. If the metadata field does not exist, this will fail.

  Required permission: ChangeEntityMetadataValue

  Events confirming this command:

   • PersonChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  externalId

  string

  All unicode characters allowed. Size between 0 and 50.

  id

  string

  format: uuid

  Format: UUID.

  metadataId

  string

  format: uuid

  Format: UUID, The ID of the metadata to change.Required.

  token

  string

  Required.

  value

  string

  The value to set the metadata to.Required. All unicode characters allowed. Size between 0 and 255.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "externalId": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "metadataId": "a8818da3-b42d-457d-a430-da2b99a63c47",
    "token": "string",
    "value": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeZoneDataMapi

  • #Command

  Accepts the following message:

  ChangeZoneDataMapi

  Required permission: ChangeZoneData

  Events confirming this command:

   • ZoneChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255. Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ChangeZoneMetadataValueMapi

  • #Command

  Accepts the following message:

  ChangeZoneMetadataValueMapi

  Change the value of a metadata field for a Zone. If the metadata field does not exist, this will fail.

  Required permission: ChangeEntityMetadataValue

  Events confirming this command:

   • ZoneChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  metadataId

  string

  format: uuid

  Format: UUID, The ID of the metadata to change.Required.

  token

  string

  Required.

  value

  string

  The value to set the metadata to.Required. All unicode characters allowed. Size between 0 and 255.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "metadataId": "a8818da3-b42d-457d-a430-da2b99a63c47",
    "token": "string",
    "value": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/ConfigureAssignableAuthorizationProfilesMapi

  • #Command

  Accepts the following message:

  ConfigureAssignableAuthorizationProfilesMapi

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

  Required permission: CreateAuthorizationProfile

  Events confirming this command:

   • UserGroupChanged

  Payload

  Expand all

  object

  assignableAuthorizationProfiles

  Expand all

  array<string>

  Array. Array of authorization profile Ids.

  Items:

  string

  format: uuid

  Array of authorization profile Ids.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, User group id.

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ConfigureBluetoothStateMapi

  • #Command

  Accepts the following message:

  ConfigureBluetoothStateMapi

  Required permission: ChangeInstallationPointData

  Events confirming this command:

   • InstallationPointChanged

  Payload

  Expand all

  object

  bluetoothState

  string

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

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ConfigureManualOfficeModeAndShopModeMapi

  • #Command

  Accepts the following message:

  ConfigureManualOfficeModeAndShopModeMapi

  Required permission: ConfigureManualOfficeModeAndShopMode

  Events confirming this command:

   • InstallationPointChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID.

  manualOfficeMode

  boolean

  shopMode

  boolean

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ConfigureMediaUpgradeMapi

  • #Command

  Accepts the following message:

  ConfigureMediaUpgradeMapi

  Activate/Deactivate the XVN access medium upgrade functionality for an online installation-point. (Online-Wallreader).

  Required permission: ConfigureMediaUpgrade

  Events confirming this command:

   • InstallationPointChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  upgradeMedia

  boolean

  True to activate / false to deactivate XVN access medium upgrade functionality.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ConfigureOfficeModeTimeProfileMapi

  • #Command

  Accepts the following message:

  ConfigureOfficeModeTimeProfileMapi

  Required permission: AssignOfficeModeTimeProfileToInstallationPoint

  Events confirming this command:

   • InstallationPointChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  timeProfileId

  string

  format: uuid

  Format: UUID. Null value for removing assigned office mode time profile.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ConfigureReleaseDurationMapi

  • #Command

  Accepts the following message:

  ConfigureReleaseDurationMapi

  Required permission: ConfigureReleaseDuration

  Events confirming this command:

   • InstallationPointChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  releaseDurationLong

  integer

  format: int32

  Long release duration value (i.e. how long should the door stay open) measured in seconds.

  Min: 2. Max: 255.

  releaseDurationShort

  integer

  format: int32

  Short release duration value (i.e. how long should the door stay open) measured in seconds.

  Min: 2. Max: 255.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/CreateAuthorizationProfileMapi

  • #Command

  Accepts the following message:

  CreateAuthorizationProfileMapi

  Creates a new Authorization Profile.

  Required permission: CreateAuthorizationProfile

  Events confirming this command:

   • AuthorizationProfileCreated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/CreateAuthorizationTimeProfileMapi

  • #Command

  Accepts the following message:

  CreateAuthorizationTimeProfileMapi

  Required permission: CreateTimeProfile

  Events confirming this command:

   • AuthorizationTimeProfileCreated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  exceptionTimeSeries

  Expand all

  array<object>

  Array

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  timeSeries

  Expand all

  array<object>

  Array

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/CreateCalendarMapi

  • #Command

  Accepts the following message:

  CreateCalendarMapi

  Required permission: CreateCalendar

  Events confirming this command:

   • CalendarCreated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  specialDays

  Expand all

  array<string>

  Array. A list of LocalDates. Example: ["2018-02-25", "2018-02-28"].

  Items:

  string

  format: date

  A list of LocalDates. Example: ["2018-02-25", "2018-02-28"].

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/CreateCodingStationMapi

  • #Command

  Accepts the following message:

  CreateCodingStationMapi

  Required permission: AddCodingStation

  Events confirming this command:

   • CodingStationCreated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/CreateInstallationPointMapi

  • #Command

  Accepts the following message:

  CreateInstallationPointMapi

  Required permission: AddInstallationPoint

  Events confirming this command:

   • EvvaComponentAdded

   • InstallationPointCreated

  Payload

  Expand all

  object

  aggregateId

  string

  format: uuid

  Format: UUID, Required.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  componentType

  string

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

  linkedInstallationPoints

  Expand all

  object

  Format: Map. A map consisting of the installation-point id as the key and the properties as values. Use this if the installation point has more than one evva component. For example the Evva component type 'WallReader2x'.

  Additional properties are allowed.

  properties

  Expand all

  object

  Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  installationId

  string

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

  installationType

  string

  All unicode characters allowed. Size between 0 and 50.

  name

  string

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

  Additional properties are allowed.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "componentType": "string",
    "linkedInstallationPoints": {},
    "properties": {
      "description": "string",
      "entityMetadata": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "value": "string"
        }
      ],
      "installationId": "string",
      "installationType": "string",
      "name": "string"
    },
    "token": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/CreateOfficeModeTimeProfileMapi

  • #Command

  Accepts the following message:

  CreateOfficeModeTimeProfileMapi

  Required permission: CreateTimeProfile

  Events confirming this command:

   • OfficeModeTimeProfileCreated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  exceptionTimePointSeries

  Expand all

  array<object>

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

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  points

  Expand all

  array<string>

  Array. List of time points. Example: ["10:00", "12:00"].

  Items:

  string

  format: time

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

  exceptionTimeSeries

  Expand all

  array<object>

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

  calendars

  Expand all

  array<string>

  Array. List of calendar IDs.

  Items:

  string

  format: uuid

  List of calendar IDs.

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  name

  string

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

  timePointSeries

  Expand all

  array<object>

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

  days

  Expand all

  array<string>

  Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  points

  Expand all

  array<string>

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

  Items:

  string

  format: time

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

  timeSeries

  Expand all

  array<object>

  Array. Time intervals for allowing/disallowing entry.

  days

  Expand all

  array<string>

  Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

  Items:

  string

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

  times

  Expand all

  array<object>

  Array. A list of time intervals.

  end

  string

  format: time

  Format: LocalTime, Example: "23:59".

  Required.

  start

  string

  format: time

  Format: LocalTime, Example: "10:00".

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/CreatePersonMapi

  • #Command

  Accepts the following message:

  CreatePersonMapi

  Creates a new Person.

  Required permission: CreatePerson

  Events confirming this command:

   • PersonCreated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  externalId

  string

  All unicode characters allowed. Size between 0 and 50.

  firstName

  string

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

  id

  string

  format: uuid

  Format: UUID, Required.

  identifier

  string

  All unicode characters allowed. Size between 0 and 255.

  lastName

  string

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

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/CreateZoneMapi

  • #Command

  Accepts the following message:

  CreateZoneMapi

  Creates a new Zone.

  Required permission: CreateZone

  Events confirming this command:

   • ZoneCreated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  description

  string

  All unicode characters allowed. Size between 0 and 255.

  entityMetadata

  Expand all

  array<object>

  Array

  id

  string

  format: uuid

  Format: UUID, The ID of the metadata definition.Required.

  name

  string

  The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

  value

  string

  The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

  id

  string

  format: uuid

  Format: UUID, Required.

  installationPoints

  Expand all

  array<string>

  Array. An array of installation-point ids.

  Items:

  string

  format: uuid

  An array of installation-point ids.

  name

  string

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

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/DeleteAuthorizationProfileMapi

  • #Command

  Accepts the following message:

  DeleteAuthorizationProfileMapi

  Required permission: RemoveAuthorizationProfile

  Events confirming this command:

   • AuthorizationProfileDeleted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/DeleteAuthorizationTimeProfileMapi

  • #Command

  Accepts the following message:

  DeleteAuthorizationTimeProfileMapi

  Required permission: RemoveTimeProfile

  Events confirming this command:

   • AuthorizationTimeProfileDeleted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/DeleteCalendarMapi

  • #Command

  Accepts the following message:

  DeleteCalendarMapi

  Required permission: RemoveCalendar

  Events confirming this command:

   • CalendarDeleted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/DeleteCodingStationMapi

  • #Command

  Accepts the following message:

  DeleteCodingStationMapi

  Required permission: RemoveCodingStation

  Events confirming this command:

   • CodingStationDeleted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/DeleteEntityMetadataDefinitionMapi

  • #Command

  Accepts the following message:

  DeleteEntityMetadataDefinitionMapi

  Remove one or more metadata definitions from a Xesar entity on the default partition. If any provided definition name doesn't exist it will be ignored.

  Required permission: ConfigureEntityMetadataDefinitions

  Events confirming this command:

   • AuthorizationProfileMetadataDefinitionsUpdated

   • InstallationPointMetadataDefinitionsUpdated

   • MediumMetadataDefinitionsUpdated

   • PartitionChanged

   • PersonMetadataDefinitionsUpdated

   • ZoneMetadataDefinitionsUpdated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  entityType

  string

  Represents Xesar aggregates that support custom metadata definitions. Allowed values: PERSON, IDENTIFICATION_MEDIUM, ZONE, INSTALLATION_POINT, AUTHORIZATION_PROFILE. The target entity type to remove the metadata definitions from.Required.

  names

  Expand all

  array<string>

  Array. The names of the metadata definitions to remove. Each name should be unique.

  Items:

  string

  The names of the metadata definitions to remove. Each name should be unique.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "entityType": "string",
    "names": [
      "string"
    ],
    "token": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/DeleteInstallationPointMapi

  • #Command

  Accepts the following message:

  DeleteInstallationPointMapi

  Required permission: RemoveInstallationPoint

  Events confirming this command:

   • InstallationPointDeleted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/DeleteOfficeModeTimeProfileMapi

  • #Command

  Accepts the following message:

  DeleteOfficeModeTimeProfileMapi

  Required permission: RemoveTimeProfile

  Events confirming this command:

   • OfficeModeTimeProfileDeleted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/DeletePersonMapi

  • #Command

  Accepts the following message:

  DeletePersonMapi

  Required permission: RemovePerson

  Events confirming this command:

   • PersonDeleted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  externalId

  string

  All unicode characters allowed. Size between 0 and 50.

  id

  string

  format: uuid

  Format: UUID.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/DeleteZoneMapi

  • #Command

  Accepts the following message:

  DeleteZoneMapi

  Required permission: RemoveZone

  Events confirming this command:

   • ZoneDeleted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/FindComponent

  • #Command

  Accepts the following message:

  FindComponent

  Enable/disable the beeping signal to find the component.

  Required permission: SearchOnlineEvvaComponent

  Events confirming this command:

   • FindComponentPerformed

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  enable

  boolean

  installationPointId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ForceRemoveEvvaComponentMapi

  • #Command

  Accepts the following message:

  ForceRemoveEvvaComponentMapi

  Required permission: RemoveFaultyEvvaComponent

  Events confirming this command:

   • EvvaComponentRemoved

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/LockMediumMapi

  • #Command

  Accepts the following message:

  LockMediumMapi

  Required permission: LockMedium

  Events confirming this command:

   • MediumLocked

   • SmartphoneLocked (Only in Self Service Mode)

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/Login

  • #Session

  Accepts the following message:

  Login

  Events confirming this command:

   • LoginPerformed

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  password

  string

  Required.

  username

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "password": "string",
    "username": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/Logout

  • #Session

  Accepts the following message:

  Logout

  Events confirming this command:

   • LoggedOut

  Payload

  Expand all

  object

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/PrepareRemovalOfEvvaComponentMapi

  • #Command

  Accepts the following message:

  PrepareRemovalOfEvvaComponentMapi

  Required permission: RemoveEvvaComponent

  Events confirming this command:

   • EvvaComponentRemovalPrepared

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RemoteDisengage

  • #Command

  Accepts the following message:

  RemoteDisengage

  Required permission: TriggerRemoteDisengage

  Events confirming this command:

   • RemoteDisengagePerformed

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  extended

  boolean

  false for SHORT / true for LONG disengage.

  installationPointId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RemoteDisengagePermanent

  • #Command

  Accepts the following message:

  RemoteDisengagePermanent

  Required permission: TriggerRemoteDisengage

  Events confirming this command:

   • RemoteDisengagePermanentPerformed

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  enable

  boolean

  installationPointId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RemoveInstallationPointAuthorizationFromMediumMapi

  • #Command

  Accepts the following message:

  RemoveInstallationPointAuthorizationFromMediumMapi

  Required permission: RemoveInstallationPointIndividualAuthorization

  Events confirming this command:

   • IndividualAuthorizationsDeleted

  Payload

  Expand all

  object

  authorization

  string

  format: uuid

  Format: UUID.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RemoveInstallationPointFromZoneMapi

  • #Command

  Accepts the following message:

  RemoveInstallationPointFromZoneMapi

  Required permission: RemoveInstallationPointFromZone

  Events confirming this command:

   • InstallationPointsInZoneChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  installationPointId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RemoveZoneAuthorizationFromMediumMapi

  • #Command

  Accepts the following message:

  RemoveZoneAuthorizationFromMediumMapi

  Remove individual authorisation for a zone.

  Required permission: RemoveZoneIndividualAuthorization

  Events confirming this command:

   • IndividualAuthorizationsDeleted

  Payload

  Expand all

  object

  authorization

  string

  format: uuid

  Format: UUID. Id of the authorization.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Id of identification medium.

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RenameEntityMetadataDefinitionMapi

  • #Command

  Accepts the following message:

  RenameEntityMetadataDefinitionMapi

  Renames a specific metadata definition of a Xesar entity. Will fail if the new name is already in use or if no metadata exists with the old name.

  Required permission: ConfigureEntityMetadataDefinitions

  Events confirming this command:

   • AuthorizationProfileMetadataDefinitionsUpdated

   • InstallationPointMetadataDefinitionsUpdated

   • MediumMetadataDefinitionsUpdated

   • PartitionChanged

   • PersonMetadataDefinitionsUpdated

   • ZoneMetadataDefinitionsUpdated

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  entityType

  string

  Represents Xesar aggregates that support custom metadata definitions. Allowed values: PERSON, IDENTIFICATION_MEDIUM, ZONE, INSTALLATION_POINT, AUTHORIZATION_PROFILE. The target entity type to rename the metadata definition of.Required.

  metadataDefinitionId

  string

  format: uuid

  Format: UUID, The ID of the metadata definition to rename.Required.

  name

  string

  The new name to assign to the definition.

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

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "entityType": "string",
    "metadataDefinitionId": "a5ff29bd-e8ea-436b-9e7e-9f8eb0a85630",
    "name": "string",
    "token": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/RequestAddMediumToInstallationMapi

  • #Command

  Accepts the following message:

  RequestAddMediumToInstallationMapi

  The RequestAddMediumToInstallationMapi command is used specifically for adding passive identification mediums. However, this requires the coding station (terminal) to be available and the expected medium to be placed on it. If these conditions are not met, the API will return an error response.

  To add smartphone identification media, use the dedicated AddSmartphoneToInstallationMapi command. All other commands related to identification mediums can be used for modifying both smartphone identification mediums and other types of identification mediums. For further details on the specific Smarpthone MAPI command, please refer to the corresponding section in the documentation: [AddSmartphoneToInstallationMapi](#operation-publish-xs3/1/cmd/AddSmartphoneToInstallationMapi).

  Required permission: AddIdentificationMedium

  Events confirming this command:

   • AddMediumToInstallationRequested

   • MediumAddedToInstallation

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  hardwareId

  string

  A HEX encoded string. Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  label

  string

  All unicode characters allowed. Size between 0 and 255.

  terminalId

  string

  format: uuid

  Format: UUID, Coding station ID.

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RequestNewRegistrationCodeMapi

  • #Command

  Accepts the following message:

  RequestNewRegistrationCodeMapi

  Required permission: ChangeIssuedMedium

  Events confirming this command:

   • MobileRegistrationStateUpdated

   • NewRegistrationCodeRequested

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/ResendSmartphoneAuthorizationsMapi

  • #Command

  Accepts the following message:

  ResendSmartphoneAuthorizationsMapi

  Required permission: ChangeIssuedMedium

  Events confirming this command:

   • SmartphoneAuthorizationsResent

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RevertPrepareRemovalOfEvvaComponentMapi

  • #Command

  Accepts the following message:

  RevertPrepareRemovalOfEvvaComponentMapi

  Required permission: RevertRemoveComponent

  Events confirming this command:

   • PrepareEvvaComponentRemovalReverted

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/RevokeSmartphoneMapi

  • #Command

  Accepts the following message:

  RevokeSmartphoneMapi

  In Self Service Mode, the update of the smartphone has to be confirmed at least once before it can be revoked.

  Required permission: RevokeMedium

  Events confirming this command:

   • MediumRevoked

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetAccessBeginAtMapi

  • #Command

  Accepts the following message:

  SetAccessBeginAtMapi

  Sets the access begin of an identification medium.

  Required permission: SetAuthorizationBeginAtOnMedium

  Events confirming this command:

   • MediumChanged

  Payload

  Expand all

  object

  accessBeginAt

  string

  format: date-time

  Format: LocalDateTime. Date and time, example: "2018-02-25T23:59".

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Identification medium ID.

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetAccessEndAtMapi

  • #Command

  Accepts the following message:

  SetAccessEndAtMapi

  Sets the access end of an identification medium.

  Required permission: SetAuthorizationEndAtOnMedium

  Events confirming this command:

   • MediumChanged

  Payload

  Expand all

  object

  accessEndAt

  string

  format: date-time

  Format: LocalDateTime. Date and time, example: "2018-02-25T23:59".

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Identification medium ID.

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetDailySchedulerExecutionTimeMapi

  • #Command

  Accepts the following message:

  SetDailySchedulerExecutionTimeMapi

  Required permission: ConfigureDailySchedulerExecutionTime

  Events confirming this command:

   • PartitionChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  dailySchedulerExecutionTime

  string

  format: time

  Format: LocalTime, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "dailySchedulerExecutionTime": "14:15:22Z",
    "token": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/SetDefaultAuthorizationProfileForPersonMapi

  • #Command

  Accepts the following message:

  SetDefaultAuthorizationProfileForPersonMapi

  Required permission: SetDefaultAuthorizationProfileForPerson

  Events confirming this command:

   • PersonChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  defaultAuthorizationProfileName

  string

  Set null to remove authorization-profile from person.

  Empty string is ignored, accept only authorization-profile names with at least 1 char.

  All unicode characters allowed. Size between 1 and 50.

  externalId

  string

  All unicode characters allowed. Size between 0 and 50.

  id

  string

  format: uuid

  Format: UUID.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetDefaultDisengagePeriodForPersonMapi

  • #Command

  Accepts the following message:

  SetDefaultDisengagePeriodForPersonMapi

  Set whether short or long disengage period for a person.

  Required permission: SetDefaultDisengagePeriodForPerson

  Events confirming this command:

   • PersonChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  disengagePeriod

  string

  How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG. Required.

  externalId

  string

  All unicode characters allowed. Size between 0 and 50.

  id

  string

  format: uuid

  Format: UUID.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetDefaultSmartphoneValidityDurationMapi

  • #Command

  Accepts the following message:

  SetDefaultSmartphoneValidityDurationMapi

  Required permission: SetDefaultMediumValidityDurationForPartition

  Events confirming this command:

   • PartitionChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  validityDuration

  integer

  format: int32

  Format: Short, Min: 1. Max: 1095. Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetDefaultValidityDurationMapi

  • #Command

  Accepts the following message:

  SetDefaultValidityDurationMapi

  Required permission: SetDefaultMediumValidityDurationForPartition

  Events confirming this command:

   • PartitionChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  validityDuration

  integer

  format: int32

  Format: Short, Min: 1. Max: 7300. Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetDisengagePeriodOnMediumMapi

  • #Command

  Accepts the following message:

  SetDisengagePeriodOnMediumMapi

  Required permission: ChangeDisengagePeriodOnMedium

  Events confirming this command:

   • MediumChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  disengagePeriod

  string

  How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG. Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetInstallationPointPersonalReferenceDurationMapi

  • #Command

  Accepts the following message:

  SetInstallationPointPersonalReferenceDurationMapi

  Required permission: ConfigureDefaultLoggingPersonalDataForInstallationPoint

  Events confirming this command:

   • PartitionChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  personalReferenceDuration

  Expand all

  object

  Required.

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetLabelOnMediumMapi

  • #Command

  Accepts the following message:

  SetLabelOnMediumMapi

  Required permission: SetMediumLabel

  Events confirming this command:

   • MediumChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  label

  string

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetMessageLanguageOnSmartphoneMapi

  • #Command

  Accepts the following message:

  SetMessageLanguageOnSmartphoneMapi

  Required permission: SetMediumLabel

  Events confirming this command:

   • MediumChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  messageLanguage

  string

  Should be an ISO 639-1 language code with 2 characters. The following languages are supported: de,en,fr,it,es,pt,nl,pl,cs,sk,sv. Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetMobileServiceModeMapi

  • #Command

  Accepts the following message:

  SetMobileServiceModeMapi

  Set the Mobile Service mode for the installation. This change is permanent and cannot be undone, proceed with caution.
  Attempting to change the mode once it has been set will be ignored and not throw any errors. Additionally, 'XMS' is the mode every installation runs in by default and will not have any effect if set.

  Required permission: ChangePartitionSettings

  Events confirming this command:

   • PartitionChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  mobileServiceMode

  string

  Enum for the Mobile Service mode. Used to describe the application's method of communication with Smartphones. Allowed values: XMS, SELF_SERVICE. Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "mobileServiceMode": "string",
    "token": "string"
  }
  

  This example has been generated automatically.

• PUB xs3/1/cmd/SetPersonPersonalReferenceDurationMapi

  • #Command

  Accepts the following message:

  SetPersonPersonalReferenceDurationMapi

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

  Required permission: ConfigureDefaultLoggingPersonalDataForPerson

  Events confirming this command:

   • PartitionChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  personalReferenceDuration

  Expand all

  object

  Required.

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetPersonalReferenceDurationForInstallationPointMapi

  • #Command

  Accepts the following message:

  SetPersonalReferenceDurationForInstallationPointMapi

  Required permission: ConfigureLoggingPersonalDataForInstallationPoint

  Events confirming this command:

   • InstallationPointChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  personalReferenceDuration

  Expand all

  object

  Required.

  days

  integer

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetPersonalReferenceDurationInPersonMapi

  • #Command

  Accepts the following message:

  SetPersonalReferenceDurationInPersonMapi

  Required permission: ConfigureLoggingPersonalDataForPerson

  Events confirming this command:

   • PersonChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  externalId

  string

  All unicode characters allowed. Size between 0 and 50.

  id

  string

  format: uuid

  Format: UUID.

  newValue

  Expand all

  object

  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

  format: int32

  Min: 0. Max: 9999.

  logMode

  string

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

  Additional properties are allowed.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetPhoneNumberOnSmartphoneMapi

  • #Command

  Accepts the following message:

  SetPhoneNumberOnSmartphoneMapi

  Required permission: SetMediumLabel

  Events confirming this command:

   • MediumChanged

   • PhoneNumberChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  phoneNumber

  string

  Required. Phone numbers starting with a '+' and max. 50 characters are allowed.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetReplacementMediumDurationMapi

  • #Command

  Accepts the following message:

  SetReplacementMediumDurationMapi

  Required permission: SetDefaultAccessDurationForReplacedMedium

  Events confirming this command:

   • PartitionChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  replacementMediumDuration

  integer

  format: int32

  Format: Short, Value in hours.

  Min: 1. Max: 26280. Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetValidityDurationMapi

  • #Command

  Accepts the following message:

  SetValidityDurationMapi

  Required permission: ChangeValidityDurationOnMedium

  Events confirming this command:

   • MediumChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  validityDuration

  integer

  format: int32

  Format: Short, Min: 1. Max: 7300.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/SetValidityThresholdMapi

  • #Command

  Accepts the following message:

  SetValidityThresholdMapi

  Required permission: ConfigureValidityThreshold

  Events confirming this command:

   • PartitionChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  validityThreshold

  integer

  format: int32

  Format: Short, Min: 0. Max: 100. Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/UnassignPersonFromMediumMapi

  • #Command

  Accepts the following message:

  UnassignPersonFromMediumMapi

  Required permission: AssignMediumToPerson

  Events confirming this command:

   • MediumChanged

   • MediumPersonChanged

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/UnregisterSmartphoneMapi

  • #Command

  Accepts the following message:

  UnregisterSmartphoneMapi

  Required permission: ChangeIssuedMedium

  Events confirming this command:

   • SmartphoneUnregistered

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• PUB xs3/1/cmd/WithdrawAuthorizationProfileFromMediumMapi

  • #Command

  Accepts the following message:

  WithdrawAuthorizationProfileFromMediumMapi

  or at AuthorizationProfileWithdrawnFromMedium.

  Required permission: WithdrawAllAuthorizations

  Events confirming this command:

   • AuthorizationProfileWithdrawnFromMedium

  Payload

  Expand all

  object

  authorizationProfileId

  string

  format: uuid

  Format: UUID.

  commandId

  string

  format: uuid

  Format: UUID, Required.

  id

  string

  format: uuid

  Format: UUID, Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/mss/ces/SmartphoneLocked

  • #Self Service Mode Events

  Accepts the following message:

  SmartphoneLocked

  Event to indicate that the smartphone has been locked.

  Required permission: ViewMedium

  Commands confirmed by this event:

   • LockMediumMapi

  Payload

  Expand all

  object

  mediumId

  string

  format: uuid

  Format: UUID. The ID of the medium that was locked.

  Additional properties are allowed.

  Examples

  Payload

  {
    "mediumId": "1f1240af-f659-4fb4-ae3e-9e0f9fd2ed9d"
  }
  

  This example has been generated automatically.

• SUB xs3/1/mss/ces/SmartphoneRevokeConfirmed

  • #Self Service Mode Events

  Accepts the following message:

  SmartphoneRevokeConfirmed

  Event to indicate that a Smartphone revoke has been successfully confirmed.

  Required permission: ViewMedium

  Commands confirmed by this event:

   • ConfirmSmartphoneRevokeMapi (Only in Self Service Mode)

  Payload

  Expand all

  object

  mediumId

  string

  format: uuid

  Format: UUID. The id of the medium that has been revoked.

  transactionId

  string

  format: uuid

  Format: UUID. The transaction ID of the operation.

  Additional properties are allowed.

  Examples

  Payload

  {
    "mediumId": "1f1240af-f659-4fb4-ae3e-9e0f9fd2ed9d",
    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
  }
  

  This example has been generated automatically.

• SUB xs3/1/mss/ces/SmartphoneRevokePending

  • #Self Service Mode Events

  Accepts the following message:

  SmartphoneRevokePending

  Event to indicate that a Smartphone revoke is pending.

  Required permission: ViewMedium

  Payload

  Expand all

  object

  mediumId

  string

  format: uuid

  Format: UUID. The id of the medium that is being revoked.

  transactionId

  string

  format: uuid

  Format: UUID. The transaction ID of the operation.

  Additional properties are allowed.

  Examples

  Payload

  {
    "mediumId": "1f1240af-f659-4fb4-ae3e-9e0f9fd2ed9d",
    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
  }
  

  This example has been generated automatically.

• SUB xs3/1/mss/ces/SmartphoneUpdateConfirmed

  • #Self Service Mode Events

  Accepts the following message:

  SmartphoneUpdateConfirmed

  Event to indicate that a Smartphone update has been successfully confirmed.

  Required permission: ViewMedium

  Commands confirmed by this event:

   • ConfirmSmartphoneUpdateMapi (Only in Self Service Mode)

  Payload

  Expand all

  object

  mediumId

  string

  format: uuid

  Format: UUID. The id of the medium that has been updated.

  transactionId

  string

  format: uuid

  Format: UUID. The transaction ID of the operation.

  Additional properties are allowed.

  Examples

  Payload

  {
    "mediumId": "1f1240af-f659-4fb4-ae3e-9e0f9fd2ed9d",
    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
  }
  

  This example has been generated automatically.

• SUB xs3/1/mss/ces/SmartphoneUpdatePending

  • #Self Service Mode Events

  Accepts the following message:

  SmartphoneUpdatePending

  Event indicating that a smartphone update is pending.

  Required permission: ViewMedium

  Payload

  Expand all

  object

  masterKey

  boolean

  Whether the medium is a master key.

  mediumDataFrame

  string

  The hex encoded access data for the medium. If the medium type is Smartphone, this value is also encrypted.

  metadata

  Expand all

  object

  Extra descriptive data.

  accessPoints

  Expand all

  array<object>

  Array. The list of access points this medium is authorized to disengage.

  accessDescription

  string

  Description of the access point. Currently unused and always blank.

  bleMac

  string

  The MAC address of the EVVA component.

  name

  string

  The name of the EVVA component.

  Additional properties are allowed.

  officeMode

  boolean

  If this medium is allowed to toggle office mode.

  t

  string

  The document type.

  transactionId

  string

  format: uuid

  Format: UUID. The identifier for the transaction.

  ts

  Expand all

  object

  The ISO8601 timestamp of when this resource was requested.

  Additional properties are allowed.

  validFrom

  Expand all

  object

  The ISO8601 time from when the medium is valid.

  Additional properties are allowed.

  validUntil

  Expand all

  object

  The ISO8601 time up until the medium is valid.

  Additional properties are allowed.

  version

  integer

  format: int32

  The version of this specification.

  xsId

  string

  A SHA256 hash of the installation ID.

  xsMOBDK

  string

  The Mobile Device Key (MOBDK). Only present for Smartphone media.

  xsMOBGID

  string

  The Mobile Group Identifier (MOBGID). Only present for Smartphone media.

  xsMediumId

  string

  format: uuid

  Format: UUID. The ID of the medium.

  xsMobileId

  string

  format: uuid

  Format: UUID. The ID of the Smartphone, this is not the same as the medium ID. Only present for Smartphone media.

  Additional properties are allowed.

  Examples

  Payload

  {
    "masterKey": true,
    "mediumDataFrame": "string",
    "metadata": {
      "accessPoints": [
        {
          "accessDescription": "string",
          "bleMac": "string",
          "name": "string"
        }
      ]
    },
    "officeMode": true,
    "t": "string",
    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
    "ts": {},
    "validFrom": {},
    "validUntil": {},
    "version": 0,
    "xsId": "string",
    "xsMOBDK": "string",
    "xsMOBGID": "string",
    "xsMediumId": "dee68ff6-df51-47f9-812e-5848bfcd1f3c",
    "xsMobileId": "ac672360-290e-4cac-823c-27637674b93d"
  }
  

  This example has been generated automatically.

• PUB xs3/1/mss/cmd/ConfirmSmartphoneRevokeMapi

  • #Self Service Mode Commands

  Accepts the following message:

  ConfirmSmartphoneRevokeMapi

  Command to confirm a pending smartphone revoke.

  Required permission: ViewMedium

  Events confirming this command:

   • SmartphoneRevokeConfirmed (Only in Self Service Mode)

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, The ID of the command. Will be present in the confirmation event for correlation.Required.

  mediumId

  string

  format: uuid

  Format: UUID, The ID of the medium the update is being confirmed for.Required.

  token

  string

  The authorization token.Required.

  transactionId

  string

  format: uuid

  Format: UUID, The transaction ID of the operation.Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "mediumId": "1f1240af-f659-4fb4-ae3e-9e0f9fd2ed9d",
    "token": "string",
    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
  }
  

  This example has been generated automatically.

• PUB xs3/1/mss/cmd/ConfirmSmartphoneUpdateMapi

  • #Self Service Mode Commands

  Accepts the following message:

  ConfirmSmartphoneUpdateMapi

  Command to confirm a pending smartphone update.

  Required permission: ViewMedium

  Events confirming this command:

   • SmartphoneUpdateConfirmed (Only in Self Service Mode)

  Payload

  Expand all

  object

  commandId

  string

  format: uuid

  Format: UUID, The ID of the command. Will be present in the confirmation event for correlation.Required.

  mediumId

  string

  format: uuid

  Format: UUID, The ID of the medium the update is being confirmed for.Required.

  token

  string

  The authorization token.Required.

  transactionId

  string

  format: uuid

  Format: UUID, The transaction ID of the operation.Required.

  Additional properties are allowed.

  Examples

  Payload

  {
    "commandId": "9e2dd63c-3478-489f-86d3-8c292a65a0aa",
    "mediumId": "1f1240af-f659-4fb4-ae3e-9e0f9fd2ed9d",
    "token": "string",
    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
  }
  

  This example has been generated automatically.

• PUB xs3/1/q

  • #Query

  Accepts the following message:

  ApiQueryRequest

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

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

  Payload

  Expand all

  object

  id

  string

  format: uuid

  Format: UUID. The item id when querying a single item * This field is only used when we want to query a single resource item. Please be aware that the response for querying a single item is different to querying a list of items. Querying single items is only possible for the resources: authorization-profiles, calendars, coding-stations, evva-components, installation-points, identification-media, identification-media-access-data, persons, time-profiles, users, zones.

  params

  Expand all

  object

  Set to filter a list of items; Has no effect when id is set.

  filters

  Expand all

  array<object>

  Array. List of query filters to specify combined filter.

  field

  string

  The field you want to query (Example: 'secure').

  type

  string

  Allowed values: eq, gt, lt, gte, lte, contains, empty, ne, isNull, isNotNull, like, between, custom. query filter type (Example: 'eq' for equals).

  value

  string

  The value for the specified field (Example: 'false').

  language

  string

  Defaults to 'de' for german.

  pageLimit

  integer

  format: int32

  The page limit. Defaults to 50.

  pageOffset

  integer

  format: int32

  The page offset. Defaults to 0.

  sort

  string

  A comma separated list of fields to sort by with optional sort direction, e.g. 'lastName,-identificationMediaCount'.

  Additional properties are allowed.

  requestId

  string

  format: uuid

  Format: UUID, Required.

  resource

  string

  Allowed values: access-protocol, authorization-profiles, calendars, coding-stations, evva-components, installation-points, identification-media, identification-media-access-data, office-modes, persons, time-profiles, users, zones, none. Example: 'persons'.

  Required.

  token

  string

  Required.

  Additional properties are allowed.

  Examples

  Payload

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

  This example has been generated automatically.

• SUB xs3/1/{userId}/LoggedIn

  Parameters

  Expand all

  userId

  required

  string

  uid: userId

  The user id.

  • #Session

  Accepts the following message:

  LoginPerformed

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

  Payload

  Expand all

  object

  token

  string

  Additional properties are allowed.

  Examples

  Payload

  {
    "token": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/{userId}/err

  Parameters

  Expand all

  userId

  required

  string

  uid: userId

  The user id.

  • #Errors

  Accepts the following message:

  ApiError

  Topic to get error messages for the given user.

  Payload

  Expand all

  object

  correlationId

  string

  format: uuid

  Format: UUID. Either command-id or query-id. Depends on request.

  error

  integer

  format: int32

  HTTP error Codes.

  reason

  string

  Additional information about the error. May be null.

  Additional properties are allowed.

  Examples

  Payload

  {
    "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
    "error": 0,
    "reason": "string"
  }
  

  This example has been generated automatically.

• SUB xs3/1/{userId}/q

  Parameters

  Expand all

  userId

  required

  string

  uid: userId

  The user id.

  • #Query

  Accepts one of the following messages:

  • #0QueryResponse-authorization-profiles

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    anyAuthorizations

    boolean

    description

    string

    entityMetadata

    Expand all

    array<object>

    Array

    id

    string

    format: uuid

    Format: UUID, The ID of the metadata definition.Required.

    name

    string

    The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

    value

    string

    The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

    id

    string

    format: uuid

    Format: UUID.

    installationPoints

    Expand all

    array<object>

    Array

    id

    string

    format: uuid

    Format: UUID.

    timeProfileId

    string

    format: uuid

    Format: UUID.

    manualOfficeMode

    boolean

    name

    string

    standardTimeProfile

    string

    format: uuid

    Format: UUID.

    zones

    Expand all

    array<object>

    Array

    id

    string

    format: uuid

    Format: UUID.

    timeProfileId

    string

    format: uuid

    Format: UUID.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #1QueryResponse-access-protocol

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    accessId

    integer

    format: int64

    Format: Long.

    entryIdentificator

    integer

    format: int32

    eventNumber

    integer

    format: int32

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

    eventType

    string

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

    eventValue

    Expand all

    object

    accessId

    integer

    format: int64

    Format: Long.

    componentType

    string

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

    deltablacklistUid

    integer

    format: int32

    doorOpening

    boolean

    errorCodes

    string

    errorLocation

    integer

    format: int32

    errorModule

    integer

    format: int32

    errorNumber

    string

    errorReaction

    integer

    format: int32

    fwUpdatePerformed

    boolean

    fwUpdateStatus

    string

    fwVersionChanges

    string

    initializationReason

    integer

    format: int32

    inputNr

    integer

    format: int32

    inputState

    integer

    format: int32

    keyType

    integer

    format: int32

    mediaChangedReason

    integer

    format: int32

    mediaRestrictedReason

    integer

    format: int32

    mediaUpgrade

    boolean

    mediumIdentifier

    integer

    format: int64

    Format: Long.

    nonceInHardware

    integer

    format: int64

    Format: Long.

    nonceInSoftware

    integer

    format: int64

    Format: Long.

    officeModeAllowed

    boolean

    raw

    string

    shopModeActivated

    boolean

    startingUp

    string

    timestampFrom

    string

    format: date-time

    Format: LocalDateTime.

    timestampTo

    string

    format: date-time

    Format: LocalDateTime.

    Additional properties are allowed.

    groupOfEvent

    string

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

    id

    string

    format: uuid

    Format: UUID.

    identificationMediumId

    string

    format: uuid

    Format: UUID.

    identificationMediumLabel

    string

    installationPointId

    string

    format: uuid

    Format: UUID.

    installationPointIdentifier

    string

    installationPointName

    string

    mediumIdentifier

    integer

    format: int64

    Format: Long.

    parameterMap

    Expand all

    object

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

    Additional properties are allowed.

    person

    string

    personId

    string

    format: uuid

    Format: UUID.

    rawValue

    string

    Bytes as hex string.

    receivedAt

    string

    format: date-time

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

    timestampComponentLocal

    string

    format: date-time

    Format: LocalDateTime.

    timestampUtc

    string

    format: date-time

    Format: LocalDateTime.

    ttl

    string

    format: date-time

    Format: LocalDateTime.

    zoneIds

    Expand all

    array<string>

    Array

    Items:

    string

    format: uuid

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #2QueryResponse-installation-points

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    accessId

    integer

    format: int64

    Format: Long.

    batteryCondition

    string

    The condition of the battery ('Undefined' if evva component has no battery or value is unknown at the moment). Allowed values: Full, AlmostEmpty, Undefined.

    bleStatus

    string

    The status of the BLE component of an EVVA component Allowed values: ON, OFF, NO_BLE.

    bluetoothState

    string

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

    componentType

    string

    days

    integer

    format: int32

    description

    string

    entityMetadata

    Expand all

    array<object>

    Array

    id

    string

    format: uuid

    Format: UUID, The ID of the metadata definition.Required.

    name

    string

    The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

    value

    string

    The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

    extendedZoneIds

    Expand all

    array<string>

    Array

    Items:

    string

    format: uuid

    id

    string

    format: uuid

    Format: UUID.

    installationId

    string

    installationType

    string

    linkedInstallationPoints

    Expand all

    array<string>

    Array

    Items:

    string

    format: uuid

    logMode

    string

    manualOfficeMode

    boolean

    name

    string

    onlineStatus

    string

    openDoor

    boolean

    releaseDurationLong

    integer

    format: int32

    releaseDurationShort

    integer

    format: int32

    secure

    boolean

    shopMode

    boolean

    timeProfileId

    string

    format: uuid

    Format: UUID.

    timeProfileName

    string

    zoneIds

    Expand all

    array<string>

    Array

    Items:

    string

    format: uuid

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #3QueryResponse-office-modes

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    exceptionTimePointSeries

    Expand all

    array<object>

    Array

    calendars

    Expand all

    array<string>

    Array. List of calendar IDs.

    Items:

    string

    format: uuid

    List of calendar IDs.

    points

    Expand all

    array<string>

    Array. List of time points. Example: ["10:00", "12:00"].

    Items:

    string

    format: time

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

    exceptionTimeSeries

    Expand all

    array<object>

    Array

    calendars

    Expand all

    array<string>

    Array. List of calendar IDs.

    Items:

    string

    format: uuid

    List of calendar IDs.

    times

    Expand all

    array<object>

    Array. A list of time intervals.

    end

    string

    format: time

    Format: LocalTime, Example: "23:59".

    Required.

    start

    string

    format: time

    Format: LocalTime, Example: "10:00".

    Required.

    id

    string

    format: uuid

    Format: UUID.

    installationPointDescription

    string

    installationPointId

    string

    format: uuid

    Format: UUID.

    installationPointName

    string

    installationType

    string

    manualOfficeMode

    boolean

    shopMode

    boolean

    timePointSeries

    Expand all

    array<object>

    Array

    days

    Expand all

    array<string>

    Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

    Items:

    string

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

    points

    Expand all

    array<string>

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

    Items:

    string

    format: time

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

    timeProfileDetails

    string

    timeProfileId

    string

    format: uuid

    Format: UUID.

    timeProfileName

    string

    timeSeries

    Expand all

    array<object>

    Array

    days

    Expand all

    array<string>

    Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

    Items:

    string

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

    times

    Expand all

    array<object>

    Array. A list of time intervals.

    end

    string

    format: time

    Format: LocalTime, Example: "23:59".

    Required.

    start

    string

    format: time

    Format: LocalTime, Example: "10:00".

    Required.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #4QueryResponse-identification-media-access-data

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    identificationMedium

    Expand all

    object

    Container for medium metadata and access data.

    masterKey

    boolean

    Whether the medium is a master key.

    mediumDataFrame

    string

    The hex encoded access data for the medium. If the medium type is Smartphone, this value is also encrypted.

    metadata

    Expand all

    object

    Extra descriptive data.

    accessPoints

    Expand all

    array<object>

    Array. The list of access points this medium is authorized to disengage.

    accessDescription

    string

    Description of the access point. Currently unused and always blank.

    bleMac

    string

    The MAC address of the EVVA component.

    name

    string

    The name of the EVVA component.

    Additional properties are allowed.

    officeMode

    boolean

    If this medium is allowed to toggle office mode.

    t

    string

    The document type.

    transactionId

    string

    format: uuid

    Format: UUID. The identifier for the transaction.

    ts

    Expand all

    object

    The ISO8601 timestamp of when this resource was requested.

    Additional properties are allowed.

    validFrom

    Expand all

    object

    The ISO8601 time from when the medium is valid.

    Additional properties are allowed.

    validUntil

    Expand all

    object

    The ISO8601 time up until the medium is valid.

    Additional properties are allowed.

    version

    integer

    format: int32

    The version of this specification.

    xsId

    string

    A SHA256 hash of the installation ID.

    xsMOBDK

    string

    The Mobile Device Key (MOBDK). Only present for Smartphone media.

    xsMOBGID

    string

    The Mobile Group Identifier (MOBGID). Only present for Smartphone media.

    xsMediumId

    string

    format: uuid

    Format: UUID. The ID of the medium.

    xsMobileId

    string

    format: uuid

    Format: UUID. The ID of the Smartphone, this is not the same as the medium ID. Only present for Smartphone media.

    Additional properties are allowed.

    mediumId

    string

    format: uuid

    Format: UUID. The id of the medium.

    mediumType

    string

    Allowed values: SMARTPHONE, PASSIVE. The type of the medium.

    state

    string

    Allowed values: UPDATE_PENDING, UPDATE_COMPLETE, REVOKE_PENDING, REVOKE_COMPLETE, LOCKED. The state of the "Self Service" transaction. Only present if the installation is in "Self Service" mode and the medium is a smartphone.

    transactionId

    string

    format: uuid

    Format: UUID. The id of the transaction.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
      "response": {
        "identificationMedium": {
          "masterKey": true,
          "mediumDataFrame": "string",
          "metadata": {
            "accessPoints": [
              {
                "accessDescription": "string",
                "bleMac": "string",
                "name": "string"
              }
            ]
          },
          "officeMode": true,
          "t": "string",
          "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
          "ts": {},
          "validFrom": {},
          "validUntil": {},
          "version": 0,
          "xsId": "string",
          "xsMOBDK": "string",
          "xsMOBGID": "string",
          "xsMediumId": "dee68ff6-df51-47f9-812e-5848bfcd1f3c",
          "xsMobileId": "ac672360-290e-4cac-823c-27637674b93d"
        },
        "mediumId": "1f1240af-f659-4fb4-ae3e-9e0f9fd2ed9d",
        "mediumType": "string",
        "state": "string",
        "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
      }
    }
    

    This example has been generated automatically.

  • #5QueryResponse-users

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    active

    boolean

    description

    string

    id

    string

    format: uuid

    Format: UUID.

    lastActive

    string

    format: date-time

    Format: LocalDateTime.

    lastLogin

    string

    format: date-time

    Format: LocalDateTime.

    loginIp

    string

    loginType

    string

    name

    string

    totpDeviceName

    string

    totpState

    string

    Allowed values: DEACTIVATED, ACTIVATION_PENDING, ACTIVATED.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #6QueryResponse-zones

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    accessId

    integer

    format: int32

    description

    string

    entityMetadata

    Expand all

    array<object>

    Array

    id

    string

    format: uuid

    Format: UUID, The ID of the metadata definition.Required.

    name

    string

    The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

    value

    string

    The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

    id

    string

    format: uuid

    Format: UUID.

    installationPointCount

    integer

    format: int32

    installationPoints

    Expand all

    array<string>

    Array

    Items:

    string

    format: uuid

    name

    string

    partitionId

    string

    format: uuid

    Format: UUID.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
      "response": {
        "accessId": 0,
        "description": "string",
        "entityMetadata": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "value": "string"
          }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "installationPointCount": 0,
        "installationPoints": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "name": "string",
        "partitionId": "7b4399a0-21ce-4bee-ba43-e06e291248d2"
      }
    }
    

    This example has been generated automatically.

  • #7QueryResponse-time-profiles

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    description

    string

    exceptionTimePointSeries

    Expand all

    array<object>

    Array

    calendars

    Expand all

    array<string>

    Array. List of calendar IDs.

    Items:

    string

    format: uuid

    List of calendar IDs.

    points

    Expand all

    array<string>

    Array. List of time points. Example: ["10:00", "12:00"].

    Items:

    string

    format: time

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

    exceptionTimeSeries

    Expand all

    array<object>

    Array

    calendars

    Expand all

    array<string>

    Array. List of calendar IDs.

    Items:

    string

    format: uuid

    List of calendar IDs.

    times

    Expand all

    array<object>

    Array. A list of time intervals.

    end

    string

    format: time

    Format: LocalTime, Example: "23:59".

    Required.

    start

    string

    format: time

    Format: LocalTime, Example: "10:00".

    Required.

    id

    string

    format: uuid

    Format: UUID.

    name

    string

    timePointSeries

    Expand all

    array<object>

    Array

    days

    Expand all

    array<string>

    Array. List of weekdays. Example: ["MONDAY", "SATURDAY"].

    Items:

    string

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

    points

    Expand all

    array<string>

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

    Items:

    string

    format: time

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

    timeSeries

    Expand all

    array<object>

    Array

    days

    Expand all

    array<string>

    Array. A list of weekdays. Example: ["MONDAY", "SATURDAY"].

    Items:

    string

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

    times

    Expand all

    array<object>

    Array. A list of time intervals.

    end

    string

    format: time

    Format: LocalTime, Example: "23:59".

    Required.

    start

    string

    format: time

    Format: LocalTime, Example: "10:00".

    Required.

    type

    string

    Allowed values: OFFICE_MODE, AUTHORIZATION_PROFILE.

    validStandardTimeProfile

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #8QueryResponse-identification-media

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    accessBeginAt

    string

    format: date-time

    Format: LocalDateTime.

    accessEndAt

    string

    format: date-time

    Format: LocalDateTime.

    authorizationProfileId

    string

    format: uuid

    Format: UUID.

    authorizationProfileName

    string

    disengagePeriod

    string

    How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

    entityMetadata

    Expand all

    array<object>

    Array

    id

    string

    format: uuid

    Format: UUID, The ID of the metadata definition.Required.

    name

    string

    The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

    value

    string

    The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

    external

    boolean

    fitsOnHardware

    boolean

    hardwareId

    string

    hardwareStatus

    string

    This enum serves only for categories of textual descriptions in frontend (they are easier to understand for the users). Check MediumDisplayState for inner, logical categorizations of the medium state. Allowed values: ACTIVE, INACTIVE, EMPTY, NEW, DEACTIVATED.

    id

    string

    format: uuid

    Format: UUID.

    individualAuthorizationProfileIds

    Expand all

    array<string>

    Array

    Items:

    string

    format: uuid

    issuedAt

    string

    format: date-time

    Format: LocalDateTime.

    label

    string

    mediumIdentifier

    integer

    format: int64

    Format: Long.

    mediumState

    string

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

    mediumType

    string

    Allowed values: SMARTPHONE, PASSIVE.

    messageLanguage

    string

    nativeId

    string

    outdated

    boolean

    person

    string

    personId

    string

    format: uuid

    Format: UUID.

    phoneNumber

    string

    registrationCode

    string

    registrationCodeValidUntil

    string

    format: date-time

    Format: LocalDateTime.

    registrationState

    string

    Allowed values: STARTED, REGISTRATION_REQUESTED, COMPLETED, UNREGISTRATION_STARTED, REMOVED.

    requiredAction

    string

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

    secure

    boolean

    softwareStatus

    string

    This enum serves only for categories of textual descriptions in frontend (they are easier to understand for the users). Check MediumDisplayState for inner, logical categorizations of the medium state. Allowed values: UNAUTHORIZED, LOCKED_INSECURE, LOCKED_SECURE, DEACTIVATED, ACTIVE, INACTIVE, EMPTY, REVOKED, UNLINKED.

    syncedAt

    string

    format: date-time

    Format: LocalDateTime.

    userId

    string

    format: uuid

    Format: UUID.

    userName

    string

    validityBeginAt

    string

    format: date-time

    Format: LocalDateTime.

    validityBeginAtInHardware

    string

    format: date-time

    Format: LocalDateTime.

    validityDuration

    integer

    format: int32

    Format: Short.

    validityEndAt

    string

    format: date-time

    Format: LocalDateTime.

    validityEndAtInHardware

    string

    format: date-time

    Format: LocalDateTime.

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #9QueryResponse-evva-components

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    batteryCondition

    string

    batteryStatusUpdatedAt

    string

    format: date-time

    Format: LocalDateTime.

    bleMac

    string

    btbFirmwareVersion

    string

    componentType

    string

    firmwareVersion

    string

    id

    string

    format: uuid

    Format: UUID.

    maintenanceTask

    string

    maintenanceTaskReasons

    Expand all

    array<string>

    Array

    Items:

    string

    Shows why a maintenance task is needed for an EVVA component. The reason is usually a change or action that makes a synchronization necessary. Allowed values: ZONE, RELEASE_DURATION, BLACKLIST_VERSION, MANUAL_OFFICE_MODE, SHOP_MODE, TIME_PROFILE_DATA, CALENDAR_DATA, OPEN_DOOR, MEDIA_UPGRADE, DAYLIGHT_SAVING_TIMES, BLE_EVVA_COMPONENT_WITHOUT_MAC_ADDRESS, MOBILE_GROUP_IDENTIFIERS, MOBILE_KEYS, BLUETOOTH_STATE, MAINTENANCE_TASK_MANUALLY_TRIGGERED, ONLINE_MAINTENANCE_TASK_MANUALLY_TRIGGERED.

    serialNumber

    string

    stateChangedAt

    string

    format: date-time

    Format: LocalDateTime.

    status

    string

    upgradeMedia

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #10QueryResponse-coding-stations

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    online

    boolean

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

    {
      "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
      "response": {
        "online": true
      }
    }
    

    This example has been generated automatically.

  • #11QueryResponse-persons

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    defaultAuthorizationProfile

    string

    defaultAuthorizationProfileId

    string

    format: uuid

    Format: UUID.

    disengagePeriod

    string

    How long should the installation point be disengaged. The values for SHORT/LONG in seconds can be changed in the installation settings. Allowed values: SHORT, LONG.

    entityMetadata

    Expand all

    array<object>

    Array

    id

    string

    format: uuid

    Format: UUID, The ID of the metadata definition.Required.

    name

    string

    The name of the metadata instance.Required. All unicode characters allowed. Size between 1 and 255.

    value

    string

    The value of the metadata. Can be empty.All unicode characters allowed. Size between 0 and 255.

    external

    boolean

    externalId

    string

    firstName

    string

    id

    string

    format: uuid

    Format: UUID.

    identificationMediaCount

    integer

    format: int32

    identifier

    string

    installationPoints

    Expand all

    array<string>

    Array

    Items:

    string

    format: uuid

    lastName

    string

    outdatedMedia

    boolean

    partitionId

    string

    format: uuid

    Format: UUID.

    personalReferenceDuration

    Expand all

    object

    days

    integer

    format: int32

    Min: 0. Max: 9999.

    logMode

    string

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

    Additional properties are allowed.

    zones

    Expand all

    array<string>

    Array

    Items:

    string

    format: uuid

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.

  • #12QueryResponse-calendars

    Payload

    Expand all

    object

    requestId

    string

    format: uuid

    Format: UUID.

    response

    Expand all

    object

    response

    id

    string

    format: uuid

    Format: UUID.

    name

    string

    partitionId

    string

    format: uuid

    Format: UUID.

    specialDays

    Expand all

    array<string>

    Array

    Items:

    string

    format: date

    Additional properties are allowed.

    Additional properties are allowed.

    Examples

    Payload

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

    This example has been generated automatically.