Skip to content

r3.2

Latest
Latest

Choose a tag to compare

View all tags
@bigludo7 bigludo7 released this 16 Sep 11:41
· 18 commits to main since this release
r3.2
bc17cee
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

This public release contains the definition and documentation of

  • location-verification v3.0.0
  • location-retrieval v0.5.0
  • geofencing-subscriptions v0.5.0

The API definition(s) are based on

  • Commonalities r3.3
  • Identity and Consent Management r3.3

location-verification v3.0.0

location-verification v3.0.0 is the public release for the next stable version of the API Location Verification.

There is breaking change compared to the previous release r2.2, due to the deprecation of UNKNOWN value for verificationResult in favor of the new error 422 LOCATION_VERIFICATION.UNABLE_TO_LOCATE.

Added

  • New error code 422 LOCATION_VERIFICATION.UNABLE_TO_LOCATE.
  • New DeviceResponse object in responses limited to one identifier.
  • Clarifications on non-documented error responses.

Changed

  • Updated string pattern for x-correlatorheaders.
  • Type of radius for CIRCLE Area changed from integer to number, and maximum removed.
  • Clarified format for properties with format date-time.

Removed

  • verificationResult: UNKNOWN for 200 responses.
  • Error 422 IDENTIFIER_MISMATCH.
  • Error 401 AUTHENTICATION_REQUIRED.

location-retrieval v0.5.0

location-retrieval v0.5.0 is the public release for the next initial version of the API Location Retrieval. It introduces breaking changes compared to the previous release r2.2, due to the deprecation of error 404 LOCATION_RETRIEVAL.DEVICE_NOT_FOUND in favor of the new error 422 LOCATION_RETRIEVAL.UNABLE_TO_LOCATE.

Added

  • New error 422 LOCATION_RETRIEVAL.UNABLE_TO_LOCATE.
  • New DeviceResponse object in responses limited to one identifier.
  • Clarifications on non-documented error responses.

Changed

  • Updated string pattern for x-correlatorheaders.
  • Clarified format for properties with format date-time.

Removed

  • Error 404 LOCATION_RETRIEVAL.DEVICE_NOT_FOUND.
  • Error 422 IDENTIFIER_MISMATCH.
  • Error 401 AUTHENTICATION_REQUIRED.

geofencing-subscriptions v0.5.0

geofencing-subscriptions v0.5.0 is the public release for the next initial version of the API Geofencing Subscriptions. It introduces breaking changes compared to the previous release r2.2, coming from the alignment to the new guidelines in Commonalities for APIs with subscriptions.

Added

  • New subscription event types for subscription-started and subscription-updated.
  • New DeviceResponse object in responses and events, limited to one identifier.
  • Pattern to property sink and new error 400 INVALID_SINK.
  • Clarifications on non-documented error responses.

Changed

  • Subscription event type subscription-ends renamed to subscription-ended.
  • Property id becomes required for SubscriptionAsync objects.
  • operationId createSubscription renamed to createGeofencingSubscription.
  • Updated string pattern for x-correlatorheaders.
  • Type of radius for CIRCLE Area changed from integer to number, and maximum removed.
  • Clarified format for properties with format date-time.

Fixed

  • Subscription types array items must be limited to allowed SubscriptionEventType values

Removed

  • Error 422 IDENTIFIER_MISMATCH.
  • Error 401 AUTHENTICATION_REQUIRED.
Assets 3
Loading