README.md

DeviceLocation

Repository to describe, develop, document and test the DeviceLocation API family

Scope

• Service APIs for “Device Location” (see APIBacklog.md)
• It provides the customer with the ability to:
  • verify the location of a device.
  • retrieve the location of a device.
  • subscribe and receive notifications about a device entering or leaving certain location (geofencing).
  • NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G.
• Describe, develop, document and test the APIs (with 1-2 Telcos)
• Started: July 2022
• Location: virtually

Meetings

• Meetings are held virtually
• Schedule: bi-weekly (odd weeks), Tuesday, 9 AM CET/CEST
• Meeting link: Microsoft Teams Meeting
• Slack channel: camara-project.slack.com #sp-device-location

Status and released versions

• Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. For best results, use the latest available release.
• The latest available release for the DeviceLocation API family is 0.2.0. There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments.

Note

Release 0.2.0 is still in RELEASE CANDIDATE status. The links below will be updated when the release is completed and the definitive branch is created.

• Release 0.2.0 of the API family is available within the release-0.2.0-rc2 branch. The API family now includes 3 APIs, in different state of progress:

  • location-verification v0.2.0, which is the second alpha release of this API.
    • OpenAPI YAML spec file
    • View it on ReDoc
    • View it on Swagger Editor
  • location-retrieval v0.1.0, which is the first alpha release.
    • OpenAPI YAML spec file
    • View it on ReDoc
    • View it on Swagger Editor
  • geofencing v0.1.0, which is the first alpha release.
    • OpenAPI YAML spec file
    • View it on ReDoc
    • View it on Swagger Editor

• The previous release version v0.1.0 of DeviceLocation API is available within the release-0.1.0 branch

  • This past release only included the first alpha version of the API now renamed to location-verification, but it was then named as "location v0.1.0"

Contributorship and mailing list

• To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit https://lists.camaraproject.org/g/sp-dlo.
• A message to all Contributors of this Sub Project can be sent using [email protected].