Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CAMARA Project QoS Profiles API

Manage QoS Profiles

CAMARA Project QoS Profiles API is one of 30 APIs that CAMARA Project publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, {apiRoot}/call-forwarding-signal/vwip.

2 operations 2 paths 18 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
wip
Server
{apiRoot}/call-forwarding-signal/vwip
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

CAMARA Project QoS Profiles API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

  • openId — to support Consent Management

Paths & Operations 2

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

QoS Profiles 2

Manage QoS Profiles

POST
/retrieve-qos-profiles
Retrieve QoS profiles
retrieveQoSProfiles 1 param body → 200400401403404422429
GET
/qos-profiles/{name}
Get QoS Profile for a given name
getQosProfile 2 params → 200400401403404429

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are QosProfile (18 properties), Device (4 properties), DeviceIpv4Addr (3 properties), QosProfileDeviceRequest (3 properties). Each schema is shown below with its type and property counts.

Availability
array
A list of countries, and optionally networks, for which the API provider makes the profile available
QosProfile
object
Data type with attributes of a QosProfile
18 properties 2 required
QosProfileName
string
A unique name for identifying a specific QoS profile. This may follow different formats depending on the service providers implementation. Some options address…
QosProfileDeviceRequest
object
Request object for QoS Profiles for a given device
3 properties
RateUnitEnum
string
Units of rate
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
Duration
object
Specification of duration
2 properties
XCorrelator
string
Value for the x-correlator
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
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
TimeUnitEnum
string
Units of time
Rate
object
Specification of rate
2 properties
ErrorInfo
object
Common schema for errors
3 properties 3 required
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…
Port
integer
TCP or UDP port number
Device
object
End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. The API consumer can choose to provid…
4 properties
QosProfileStatusEnum
string
The current status of the QoS Profile - ACTIVE- QoS Profile is available to be used - INACTIVE- QoS Profile is not currently available to be deployed - DEPRECA…
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camara-project-qos-profiles-api-openapi.yml Raw ↑

Other APIs CAMARA Project publishes across the network.

CAMARA Project Age Verification API
CAMARA Project Call Forwarding information retrieval API
CAMARA Project Check Device Swap API
CAMARA Project Check SIM swap API
CAMARA Project Connected Network Type API
CAMARA Project Device reachability status API
CAMARA Project Discovery API
CAMARA Project Fill-in API
CAMARA Project Geofencing subscriptions API
CAMARA Project Home Devices QoD API
CAMARA Project Location retrieval API
CAMARA Project Location verification API