openapi: 3.0.3
info:
title: Device Location Retrieval Check Device Swap Geofencing subscriptions API
description: "This API provides the ability to retrieve a device location.\n\n# Introduction\n\nWith this API, API consumers can retrieve the area where a certain user device is localized.\nThe area provided in the response could be described:\n- by a circle determined by coordinates (latitude and longitude) and a radius.\n- by a simple polygon delimited by segments connecting consecutively an array of coordinates (points). The last point connects to the first point to delimit a closed shape bounded with straight sides.\n\nThe retrieved shape depends on the network conditions at the device's location and any of the supported shapes could be received.\n\nThe requester could optionally ask for\n * a freshness of the localization information by providing a `maxAge` (\"I want a location not older than 600 seconds\").\n * an accuracy of the localization information by providing a `maxSurface` (\"I want a location not larger than 1000000 square meters\").\n\n\nThe result accuracy depends on the network's ability and accuracy to locate the device.\n\nAdditionally to location information, the answer will also provide indication about the location time.\n\nLocation retrieval API could be useful in scenarios such as:\n\n- Fraud protection to ensure a given user is located in the region, country or location authorized for financial transactions\n- Verify the GPS coordinates reported by the app on a device to ensure the GPS was not faked e.g. for content delivery with regional restrictions\n- Contextual-based advertising, to trigger advertising after verifying the device is in the area of interest\n\n- Smart Mobility (Vehicle/bikes renting): obtain the location of a vehicle/bike to guarantee they are rented correctly\n\n**Note**: Location is in most jurisdictions considered to be sensitive data and thereby consent by device owner/user must be verified before providing it to the developer.\n\n# Relevant terms and definitions\n\n* **Device**: A device refers to any physical entity that can connect to a network and participate in network communication.\n\n* **Area**: It specifies the geographical surface where a device may be physically located.\n\n* **Max Age**: Maximum age of the location information which is accepted for the location retrieval (in seconds).\n\n * Absence of `maxAge` means that \"any age\" is acceptable for the client. In other words, this is like `maxAge`=infinite. The system will return `lastLocationTime` in the response. If the system is not able to provide location, an error 422 with code LOCATION_RETRIEVAL.UNABLE_TO_LOCATE is sent back.\n * `maxAge`=0 means that a fresh calculation is requested by the client. If the system is not able to provide the fresh location, an error 422 with code LOCATION_RETRIEVAL.UNABLE_TO_FULFILL_MAX_AGE is sent back.\n\n* **Last Location Time** : Last date and time when the device was localized.\n\n* **Max Surface**: Maximum surface in square meters which is accepted by the client for the location retrieval.\n\n * absence of `maxSurface` means that \"any surface size\" is acceptable for the client.\n * API implementation could specify the minimum acceptable `maxSurface` in the documentation (for example a minimum of 10000 square meters are allowed).\n * If the system is not able to provide an area with a surface acceptable with the client request, an error 422 with code LOCATION_RETRIEVAL.UNABLE_TO_FULFILL_MAX_SURFACE is sent back.\n * Note: if both `maxAge` and `maxSurface` requirements fail, the system can either send back one or the other error code.\n\n# API Functionality\n\nThe API exposes a single endpoint/operation:\n\n- `/retrieve` : Retrieve where the device is localized.\n The operation returns:\n * a localization defined either as a circle, with the center specified by the latitude and longitude, and a radius for answer accuracy, or as polygon defined by the array of points delimiting its boundary.\n * a timestamp with the location information freshness.\n\n# Authorization and authentication\n\nThe \"Camara Security and Interoperability Profile\" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.\n\nThe specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.\n\nIn cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.\n\n# Identifying the device from the access token\n\nThis API requires the API consumer to identify a device as the subject of the API as follows:\n- When the API is invoked using a two-legged access token, the subject will be identified from the optional `device` object, which therefore MUST be provided.\n- When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.\n\nThis approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.\n\n## Error handling:\n\n- If the subject cannot be identified from the access token and the optional `device` object is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.\n\n- If the subject can be identified from the access token and the optional `device` object is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same device is identified by these two methods, as the server is unable to make this comparison.\n\n# Multi-SIM scenario handling\n\nIn multi-SIM scenarios, where more than one mobile device is associated with the phone number given as input in the API call (e.g. a smartphone with an associated smartwatch), it might not be possible to uniquely identify the device whose location is to be verified. Check with the API provider what is the expected behaviour when a phone number belonging to a multi-SIM group is used as the device identifier, as the API may response with:\n\n- an error indicating that that phone number is not supported for this API, or\n- the location of a single device in the multi-SIM group, if one of the devices is considered linked to the main SIM and this concept is supported by the operator, or\n- a location value that combines the location of all the SIMs associated to the requested phone number.\n\nPossible solutions to make the scenario more deterministic include:\n\n- Using preferably the authorisation code flow to obtain an access token, which will automatically identify the intended device.\n- Identifying the intended device from a unique identifier for that device, such as its source IP address and port.\n- Check with the API provider whether a unique \"secondary\" phone number is already associated with each device and use the secondary phone number to identify the intended device if available.\n\n# Additional CAMARA error responses\n\n The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.\n\n Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.\n\n As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.\n\n# Further info and support\n\n(FAQs will be added in a later version of the documentation)\n"
version: wip
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
x-camara-commonalities: tbd
servers:
- url: '{apiRoot}/location-retrieval/vwip'
variables:
apiRoot:
default: http://localhost:9091
description: API root
tags:
- name: Geofencing subscriptions
description: Operations to manage event subscriptions on geofencing events for leaving and entering an area.
paths:
/subscriptions:
post:
tags:
- Geofencing subscriptions
summary: Create a geofencing subscription for a device
description: Create a subscription for a device to receive notifications when the device enters or exits a specified area.
operationId: createGeofencingSubscription
parameters:
- $ref: '#/components/parameters/x-correlator'
security:
- openId:
- geofencing-subscriptions:org.camaraproject.geofencing-subscriptions.v0.area-entered:create
- geofencing-subscriptions:org.camaraproject.geofencing-subscriptions.v0.area-left:create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionRequest'
examples:
CIRCLE_AREA_ENTERED:
$ref: '#/components/examples/REQUEST_CIRCLE_AREA_ENTERED'
REQUEST_CIRCLE_AREA_ENTERED_MULTIPLE_IDENTIFIERS:
$ref: '#/components/examples/REQUEST_CIRCLE_AREA_ENTERED_MULTIPLE_IDENTIFIERS'
required: true
callbacks:
notifications:
'{$request.body#/sink}':
post:
summary: notifications callback
description: 'Important: This endpoint is to be implemented by the API consumer.
The Geofencing server will call this endpoint whenever a Geofencing event occurs.
The `operationId` value will have to be replaced accordingly with WG API specific semantics.
'
operationId: postNotification
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
required: true
content:
application/cloudevents+json:
schema:
$ref: '#/components/schemas/CloudEvent'
examples:
CIRCLE_AREA_ENTERED:
$ref: '#/components/examples/CIRCLE_AREA_ENTERED'
CIRCLE_AREA_LEFT:
$ref: '#/components/examples/CIRCLE_AREA_LEFT'
SUBSCRIPTION_STARTED:
$ref: '#/components/examples/SUBSCRIPTION_STARTED'
SUBSCRIPTION_UPDATED:
$ref: '#/components/examples/SUBSCRIPTION_UPDATED'
SUBSCRIPTION_ENDED:
$ref: '#/components/examples/SUBSCRIPTION_ENDED'
SUBSCRIPTION_UNPROCESSABLE:
$ref: '#/components/examples/SUBSCRIPTION_UNPROCESSABLE'
responses:
'204':
description: Successful notification.
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
'400':
$ref: '#/components/responses/Generic400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
'410':
$ref: '#/components/responses/Generic410'
'429':
$ref: '#/components/responses/Generic429'
security:
- notificationsBearerAuth: []
- {}
responses:
'201':
description: Created (Successful creation of subscription).
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
'202':
description: Request accepted to be processed. It applies for async creation process.
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionAsync'
'400':
$ref: '#/components/responses/CreateSubscriptionBadRequest400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
'422':
$ref: '#/components/responses/CreateSubscriptionUnprocessableEntity422'
'429':
$ref: '#/components/responses/Generic429'
get:
tags:
- Geofencing subscriptions
summary: Retrieve a list of geofencing event subscription
description: Retrieve a list of geofencing event subscription(s).
operationId: retrieveGeofencingSubscriptionList
parameters:
- $ref: '#/components/parameters/x-correlator'
security:
- openId:
- geofencing-subscriptions:read
responses:
'200':
description: List of event subscription details.
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/Subscription'
'400':
$ref: '#/components/responses/Generic400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
/subscriptions/{subscriptionId}:
get:
tags:
- Geofencing subscriptions
summary: Operation to retrieve a subscription based on the provided ID
description: Retrieve Geofencing subscription information for a given subscription ID.
operationId: retrieveGeofencingSubscription
security:
- openId:
- geofencing-subscriptions:read
parameters:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: '#/components/parameters/x-correlator'
responses:
'200':
description: OK
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
'400':
$ref: '#/components/responses/SubscriptionIdRequired'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
'404':
$ref: '#/components/responses/Generic404'
delete:
tags:
- Geofencing subscriptions
summary: Delete a Geofencing event subscription
operationId: deleteGeofencingSubscription
description: Delete a given Geofencing subscription.
security:
- openId:
- geofencing-subscriptions:delete
parameters:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: '#/components/parameters/x-correlator'
responses:
'204':
description: Geofencing subscription deleted.
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
'202':
description: Request accepted to be processed. It applies for async deletion process.
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionAsync'
'400':
$ref: '#/components/responses/SubscriptionIdRequired'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
'404':
$ref: '#/components/responses/Generic404'
components:
examples:
CIRCLE_AREA_LEFT:
description: The cloud event when a geofence area was left.
value:
id: '123655'
source: https://notificationSendServer12.supertelco.com
type: org.camaraproject.geofencing-subscriptions.v0.area-left
specversion: '1.0'
datacontenttype: application/json
time: 2023-03-22 05:40:23.682000+00:00
data:
subscriptionId: 987654321
device:
phoneNumber: 123456789
area:
areaType: CIRCLE
center:
latitude: 50.735851
longitude: 7.10066
radius: 2000
CIRCLE_AREA_ENTERED:
description: The cloud event when a geofence area was entered.
value:
id: '123655'
source: https://notificationSendServer12.supertelco.com
type: org.camaraproject.geofencing-subscriptions.v0.area-entered
specversion: '1.0'
datacontenttype: application/json
time: 2023-03-22 05:40:23.682000+00:00
data:
subscriptionId: 987654321
device:
phoneNumber: 123456789
area:
areaType: CIRCLE
center:
latitude: 50.735851
longitude: 7.10066
radius: 2000
SUBSCRIPTION_UNPROCESSABLE:
description: The cloud event when the subscription process was aborted.
value:
id: '123655'
source: https://notificationSendServer12.supertelco.com
type: org.camaraproject.geofencing-subscriptions.v0.subscription-ended
specversion: '1.0'
datacontenttype: application/json
time: 2023-03-22 05:40:23.682000+00:00
data:
device:
phoneNumber: 123456789
area:
areaType: CIRCLE
center:
latitude: 50.735851
longitude: 7.10066
radius: 2000
terminationReason: SUBSCRIPTION_UNPROCESSABLE
terminationDescription: The requested area cannot be covered by the network.
SUBSCRIPTION_ENDED:
description: The cloud event when a geofence subscription ended.
value:
id: '123655'
source: https://notificationSendServer12.supertelco.com
type: org.camaraproject.geofencing-subscriptions.v0.subscription-ended
specversion: '1.0'
datacontenttype: application/json
time: 2023-03-22 05:40:23.682000+00:00
data:
subscriptionId: 987654321
device:
phoneNumber: 123456789
area:
areaType: CIRCLE
center:
latitude: 50.735851
longitude: 7.10066
radius: 2000
terminationReason: SUBSCRIPTION_EXPIRED
REQUEST_CIRCLE_AREA_ENTERED:
description: A sample geofence for entering for a circle area.
value:
protocol: HTTP
sink: https://notificationSendServer12.supertelco.com
types:
- org.camaraproject.geofencing-subscriptions.v0.area-entered
config:
subscriptionDetail:
device:
phoneNumber: '+12345678912'
area:
areaType: CIRCLE
center:
latitude: 50.735851
longitude: 7.10066
radius: 2000
initialEvent: true
subscriptionMaxEvents: 10
subscriptionExpireTime: '2024-03-22T05:40:58.469Z'
SUBSCRIPTION_STARTED:
description: The cloud event when a geofence subscription was started.
value:
id: '124003'
source: https://dataUsageServer.supertelco.com
type: org.camaraproject.geofencing-subscriptions.v0.subscription-started
specversion: '1.0'
datacontenttype: application/json
data:
initiationReason: SUBSCRIPTION_CREATED
subscriptionId: dv10-h556-rt89-1403
device:
phoneNumber: 123456789
area:
areaType: CIRCLE
center:
latitude: 50.735851
longitude: 7.10066
radius: 2000
time: '2024-03-05T15:00:23.682Z'
REQUEST_CIRCLE_AREA_ENTERED_MULTIPLE_IDENTIFIERS:
description: A sample geofence for entering for a circle area.
value:
protocol: HTTP
sink: https://notificationSendServer12.supertelco.com
types:
- org.camaraproject.geofencing-subscriptions.v0.area-entered
config:
subscriptionDetail:
device:
phoneNumber: '+12345678912'
ipv4Address:
publicAddress: 123.234.1.2
publicPort: 1234
area:
areaType: CIRCLE
center:
latitude: 50.735851
longitude: 7.10066
radius: 2000
initialEvent: true
subscriptionMaxEvents: 10
subscriptionExpireTime: '2024-03-22T05:40:58.469Z'
SUBSCRIPTION_UPDATED:
description: The cloud event when a geofence subscription was updated.
value:
id: '124003'
source: https://dataUsageServer.supertelco.com
type: org.camaraproject.geofencing-subscriptions.v0.subscription-updated
specversion: '1.0'
datacontenttype: application/json
data:
updateReason: SUBSCRIPTION_ACTIVE
subscriptionId: dv10-h556-rt89-1403
device:
phoneNumber: 123456789
area:
areaType: CIRCLE
center:
latitude: 50.735851
longitude: 7.10066
radius: 2000
time: '2024-03-05T15:00:23.682Z'
schemas:
SubscriptionId:
type: string
description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as subscriptionId as per Commonalities Event Notification Model.
example: qs15-h556-rt89-1298
AreaType:
type: string
description: 'Type of this area.
CIRCLE - The area is defined as a circle.
'
enum:
- CIRCLE
SubscriptionDetailRequest:
description: The detail of the requested event subscription.
type: object
properties:
device:
$ref: '#/components/schemas/Device'
area:
$ref: '#/components/schemas/Area'
required:
- area
ConfigRequest:
allOf:
- $ref: '#/components/schemas/Config'
- description: 'Implementation-specific configuration parameters are needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent`.
Specific event type attributes requested by the client must be defined in `subscriptionDetail`.
Note: If a request is performed for several event types, all subscribed events will use the same `config` parameters.
'
type: object
required:
- subscriptionDetail
properties:
subscriptionDetail:
$ref: '#/components/schemas/SubscriptionDetailRequest'
DateTime:
type: string
format: date-time
description: Timestamp of when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
example: '2018-04-05T17:31:00Z'
Source:
type: string
format: uri-reference
minLength: 1
description: "Identifies the context in which an event happened - be a non-empty `URI-reference` like:\n- URI with a DNS authority:\n * https://github.com/cloudevents\n * mailto:cncf-wg-serverless@lists.cncf.io\n- Universally-unique URN with a UUID:\n * urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66\n- Application-specific identifier:\n * /cloudevents/spec/pull/123\n * 1-555-123-4567\n"
example: https://notificationSendServer12.supertelco.com
ConfigResponse:
allOf:
- $ref: '#/components/schemas/Config'
- description: 'Implementation-specific configuration parameters are needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent`.
Specific event type attributes granted by the implementation are included in `subscriptionDetail`.
Note: If a request is performed for several event types, all subscribed events will use the same `config` parameters.
'
type: object
required:
- subscriptionDetail
properties:
subscriptionDetail:
$ref: '#/components/schemas/SubscriptionDetailResponse'
SubscriptionDetailResponse:
description: The detail of the event subscription granted by the implementation.
type: object
properties:
device:
$ref: '#/components/schemas/DeviceResponse'
area:
$ref: '#/components/schemas/Area'
required:
- area
ErrorInfo:
description: The error info object for possible error cases.
type: object
required:
- status
- code
- message
properties:
status:
type: integer
description: HTTP response status code.
code:
type: string
description: A human-readable code to describe the error.
message:
type: string
description: A human-readable description of what the event represents.
DeviceIpv4Addr:
type: object
description: 'The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers).
If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then the same address should be specified for both publicAddress and privateAddress.
If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object)
In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone.
'
properties:
publicAddress:
$ref: '#/components/schemas/SingleIpv4Addr'
privateAddress:
$ref: '#/components/schemas/SingleIpv4Addr'
publicPort:
$ref: '#/components/schemas/Port'
anyOf:
- required:
- publicAddress
- privateAddress
- required:
- publicAddress
- publicPort
example:
publicAddress: 84.125.93.10
publicPort: 59765
Area:
type: object
description: The geofencing area where the monitor is active. This area is specified by API consumers in the subscription request. The same area definition is included in event notifications without any modifications.
properties:
areaType:
$ref: '#/components/schemas/AreaType'
required:
- areaType
discriminator:
propertyName: areaType
mapping:
CIRCLE: '#/components/schemas/Circle'
Device:
description: 'End-user device able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.
The developer can choose to provide the below specified device identifiers:
* `ipv4Address`
* `ipv6Address`
* `phoneNumber`
* `networkAccessIdentifier`
NOTE1: the API provider might support only a subset of these options. The API consumer can provide multiple identifiers to be compatible across different API providers. In this case the identifiers MUST belong to the same device. Where more than one device identifier is provided, only one identifier will be selected by the implementation and this choice indicated to the API consumer in the response or event.
NOTE2: as for this Commonalities release, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines.
'
type: object
properties:
phoneNumber:
$ref: '#/components/schemas/PhoneNumber'
networkAccessIdentifier:
$ref: '#/components/schemas/NetworkAccessIdentifier'
ipv4Address:
$ref: '#/components/schemas/DeviceIpv4Addr'
ipv6Address:
$ref: '#/components/schemas/DeviceIpv6Address'
minProperties: 1
XCorrelator:
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: b4333c46-49c0-4f62-80d7-f0ef930f1c46
Config:
description: 'Implementation-specific configuration parameters are needed by the subscription manager for acquiring events.
In CAMARA we have predefined attributes like `subscriptionExpireTime`, `subscriptionMaxEvents`, `initialEvent`.
'
type: object
properties:
subscriptionExpireTime:
type: string
format: date-time
example: '2023-01-17T13:18:23.682Z'
description: The subscription expiration time (in date-time format) requested by the API consumer. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
subscriptionMaxEvents:
type: integer
description: 'Identifies the maximum number of event reports to be generated (>=1) requested by the API consumer - Once this number is reached, the subscription ends.
Note on combined usage of `initialEvent` and `subscriptionMaxEvents`:
If an event is triggered following `initialEvent` set to `true`, this event will be counted towards `subscriptionMaxEvents`.
'
minimum: 1
example: 5
initialEvent:
type: boolean
description: 'Set to `true` by API consumer if consumer wants to get an event as soon as the subscription is created and current situation reflects event request.
Example: Consumer request area entered event. If consumer sets initialEvent to true and device is already in the geofence, an event is triggered.
'
Port:
description: TCP or UDP port number.
type: integer
minimum: 0
maximum: 65535
PhoneNumber:
description: A public identifier addressing a telephone subscription. In mobile networks, it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with '+'.
type: string
pattern: ^\+[1-9][0-9]{4,14}$
example: '+123456789'
NotificationEventType:
type: string
description: 'area-entered - Event triggered when the device enters the given area
area-left - Event triggered when the device leaves the given area
subscription-started - Event triggered when the subscription starts.
subscription-updated - Event triggered when the subscription is updated.
subscription-ended - Event triggered when the subscription ends
'
enum:
- org.camaraproject.geofencing-subscriptions.v0.area-entered
- org.camaraproject.geofencing-subscriptions.v0.area-left
- org.camaraproject.geofencing-subscriptions.v0.subscription-started
- org.camaraproject.geofencing-subscriptions.v0.subscription-updated
- org.camaraproject.geofencing-subscriptions.v0.subscription-ended
NetworkAccessIdentifier:
description: A public identifier addressing a subscription in a mobile ne
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/orange-business/refs/heads/main/openapi/orange-business-geofencing-subscriptions-api-openapi.yml