Skip to content

Releases Notes

Jump to bottom
Jeremy Brown edited this page Jun 10, 2024 · 1 revision

Here we will provide the changes to the sample code that matches each API version release.

[TOC]

v2.5

  • Default page size has been increased to 50.
  • Credential card type is defaulted to Normal if none is supplied or the Default Activation Card Type is not specified in DNA Fusion
  • Mercury inputs and outputs are no longer returned when associated with a door.
  • Breaking Changes
    • Page size has an upper limit of 500. Request will return an error if the page size is set higher.
    • status/{key}/uniquekey is changed to status/{uniqueKey:guid}/{parentKey:guid?}
    • hardware/isonas/status is now an HTTP POST method instead of a GET

v2.4

  • Health checks
    • /health
      • Healthy - Indicates that the health check determined that the component was healthy.
      • Degraded - Indicates that the health check determined that the component was in a degraded state.
      • Unhealthy - Indicates that the health check determined that the component was unhealthy, or an unhandled exception was thrown while executing the health check.
  • The API now supports creating and editing access levels. (Known as Global Access Levels in DNA)
  • Elevator Flags
    • ThyssenKrupp
    • Kone
    • Otis
    • Mitsubishi
  • Credential Override Flag
  • Elevator Floor Groups
  • Cardholder photo upload mechanism will now allow for the authorization header

v2.3

  • AccessToken query string parameter added to support bearer token authentication through a URL without having to add a header to the request. This is useful if you want to have a tag to display a cardholder image.
  • Updated swagger documentation to indicate what methods consume. Mostly affects POST methods that require a JSON body.
  • Client credentials grant types are used to authenticate outside of the context of an operator. However, DNA Fusion required an operator for authorization, and filtering data. You can now specify the resource owner (the DNA operator) to an identity client. When an identity client does not have an operator context it will use the resource owner instead. The downside to this is that all actions will be tied to this identity client and operator. It is recommended to use a different grant type if your integration has users performing actions against the Flex API.
  • Added CardholderTypes to the global Settings. Useful for knowing what the CardholderType value relates to on a Cardholder.
  • New Methods
    • /api/v2/cardholder/{uniqueKey}/deactivate
      • Deactivates supplied credentials or all credentials assigned to a cardholder
    • /api/v2/cardholder/{uniqueKey}/credentials/deleted
      • Returns a collection of deleted credentials that were assigned to the specified cardholder record
      • DNA does not expose the credentials GUID based UniqueKey on the credential. We can return the deleted credentials, but you won’t have a reference point unless you compare the card number. That would be an issue if someone added a credential with card number 123, deleted that credential, and then turned around and created another card number with 123. The DNA team is aware of the issue and will provide an update to include the unique key.
  • Fixes
    • Updating a credential without supplying the card number in the payload would change the card number to 0
    • Update the cardholder last modified when a credential or photos are modified
  • Breaking Changes
    • PersonnelType renamed to CardholderType to match the naming convention.
    • Operator privileges are now enforced on the following methods:
      • /api/v2/hardware/door/{uniqueKey}/mask/forced
      • /api/v2/hardware/door/{uniqueKey}/mask/held
      • /api/v2/hardware/door/{uniqueKey}/mode
      • /api/v2/hardware/door/{uniqueKey}/overridemode
      • /api/v2/hardware/door/{uniqueKey}/momentaryunlock

v2.2

  • The initial release of the API samples.

Clone this wiki locally