How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orange Business Geofencing subscriptions API

Operations to manage event subscriptions on geofencing events for leaving and entering an area.

Orange Business Geofencing subscriptions API is one of 92 APIs that Orange Business publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Geofencing subscriptions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version wip.

Requests are made against a single base URL, {apiRoot}/location-retrieval/vwip.

4 operations 2 paths 28 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
wip
Base URL
https://api.orange.com/camara/playground/api/geofencing-subscriptions/v0.3
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

Orange Business Geofencing subscriptions API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

  • openId — OpenID Connect authentication

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Geofencing subscriptions 4

Operations to manage event subscriptions on geofencing events for leaving and entering an area.

POST
/subscriptions
Create a geofencing subscription for a device
createGeofencingSubscription 1 param body → 201202400401403422429
GET
/subscriptions
Retrieve a list of geofencing event subscription
retrieveGeofencingSubscriptionList 1 param → 200400401403
GET
/subscriptions/{subscriptionId}
Operation to retrieve a subscription based on the provided ID
retrieveGeofencingSubscription 2 params → 200400401403404
DELETE
/subscriptions/{subscriptionId}
Delete a Geofencing event subscription
deleteGeofencingSubscription 2 params → 204202400401403404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Subscription (8 properties), CloudEvent (7 properties), SubscriptionRequest (5 properties), Device (4 properties). Each schema is shown below with its type and property counts.

Subscription
object
Represents a event-type subscription.
8 properties 6 required
SinkCredential
object
A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
1 property 1 required
DeviceIpv4Addr
object
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 (o…
3 properties
Protocol
string
Identifier of a delivery protocol. Only HTTP is allowed for now.
SubscriptionId
string
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this conce…
Area
object
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 e…
1 property 1 required
ConfigResponse
Config
object
Implementation-specific configuration parameters are needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like subs…
3 properties
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks, it corresponds to the MSISDN (Mobile Station International Subscriber Directory Nu…
SubscriptionEventType
string
area-entered - Event triggered when the device enters the given area area-left - Event triggered when the device leaves the given area
DeviceIpv6Address
string
The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to…
Device
object
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…
4 properties
Port
integer
TCP or UDP port number.
SubscriptionDetailResponse
object
The detail of the event subscription granted by the implementation.
2 properties 1 required
NotificationEventType
string
area-entered - Event triggered when the device enters the given area area-left - Event triggered when the device leaves the given area subscription-started - E…
CloudEvent
object
The notification callback.
7 properties 6 required
AreaType
string
Type of this area. CIRCLE - The area is defined as a circle.
SubscriptionAsync
object
Response for an event-type subscription request managed asynchronously (Creation or Deletion).
1 property 1 required
ConfigRequest
DateTime
string
Timestamp of when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) and must have time zone.
NetworkAccessIdentifier
string
A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Loc…
SubscriptionRequest
object
The request for creating an event-type event subscription.
5 properties 4 required
XCorrelator
string
SingleIpv4Addr
string
A single IPv4 address with no subnet mask.
Source
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
ErrorInfo
object
The error info object for possible error cases.
3 properties 3 required
SubscriptionDetailRequest
object
The detail of the requested event subscription.
2 properties 1 required
DeviceResponse
An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer incl…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orange-business-geofencing-subscriptions-api-openapi.yml Raw ↑

Other APIs Orange Business publishes across the network.

Orange Business IoT Managed Global Connectivity API
Orange Business Orange Money WebPay API
Orange Business Pay With Orange Bill API
Orange Business SMS Middle East and Africa API
Orange Business Voice as a Service API
Orange Business Contact Everyone API
Orange Business Business Talk API
Orange Business Cloud Avenue API
Orange Business Evolution Platform IaaS API
Orange Business EVPL Online API
Orange Business EVPL Monitoring API
Orange Business Content Delivery Boost API
Where this information came from

This is an independent, third-party profile of Orange Business Geofencing subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.