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 Assignment API

Manage the permanent assignment of a QoS profile to a device

CAMARA Project QoS Assignment 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 Assignment. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 20 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.

4 operations 3 paths 20 schemas 1 DELETE1 GET2 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 Assignment 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 4

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

QoS Assignment 4

Manage the permanent assignment of a QoS profile to a device

POST
/qos-assignments
Triggers the provisioning process for the assignment of a QoS profile to a device
createQosAssignment 1 param body → 201400401403404409422429
GET
/qos-assignments/{assignmentId}
Get the QoS profile assignment information identified by an assignment record ID
getQosAssignmentById 2 params → 200400401403404429
DELETE
/qos-assignments/{assignmentId}
Revokes a QoS profile assignment identified by an assignment record ID
revokeQosAssignment 2 params → 204202400401403404429
POST
/retrieve-qos-assignment
Returns the assignment record details of the QoS profile assignment for a device
getQosAssignmentByDevice 1 param body → 200400401403404422429

Schemas 20

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

StatusInfo
string
Reason for the new status: NETWORKTERMINATED - Network terminated the QoS profile assignment DELETEREQUESTED - User requested the deletion of the QoS profile a…
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…
AssignmentInfo
Information about a QoS profile assignment returned in responses. Optional device object only to be returned if provided in createQosAssignment. If more than o…
CreateAssignment
Attributes to request a new QoS profile assignment
CloudEvent
object
Event compliant with the CloudEvents specification
7 properties 5 required
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
BaseAssignmentInfo
object
Common attributes of the assignment record for a QoS profile assignment
4 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…
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
ErrorInfo
object
Common schema for errors
3 properties 3 required
SinkCredential
object
A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
1 property 1 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…
RetrieveAssignmentByDevice
object
Attributes to look for a QoS profile assignment
1 property
AssignmentId
string
Identifier of the assignment record for the QoS profile assignment, that was created by the createQosAssignment operation
Port
integer
TCP or UDP port number
Device
object
End-user equipment able to connect to the network. Examples of devices include smartphones or IoT sensors/actuators. The API consumer can choose to provide the…
4 properties
Status
The current status of the requested QoS profile assignment. The status can be one of the following: REQUESTED - QoS profile assignment has been requested but i…
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-assignment-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