Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-027801.5 MB
Device Roaming Status Subscriptions v0.7

Create a device roaming status event subscription for a device

Create a device roaming status event subscription for a device

post/device-status/device-roaming-status-subscriptions/v0.7/subscriptions

Headers

x-correlatorstring

Correlation id for the different services

x-rapidapi-hoststring required
Example:network-as-code.p-eu.rapidapi.com

The API's Host value as defined in the RapidAPI Hub.

Request body

protocol'HTTP' | 'MQTT3' | 'MQTT5' | 'AMQP' | 'NATS' | 'KAFKA' required

Identifier of a delivery protocol. Only HTTP is allowed for now

sinkstring uri required

The address to which events shall be delivered using the selected protocol.

typesstring[] required

Camara Event types eligible to be delivered by this subscription. Note: for the current Commonalities version (v0.5) only one event type per subscription is allowed, yet in the following releases use of array of event types SHALL be specified without changing this definition.

Response

protocol'HTTP' | 'MQTT3' | 'MQTT5' | 'AMQP' | 'NATS' | 'KAFKA' required

Identifier of a delivery protocol. Only HTTP is allowed for now

sinkstring url required

The address to which events shall be delivered using the selected protocol.

typesstring[] required

Camara Event types eligible to be delivered by this subscription. Note: for the Commonalities meta-release v0.4 we enforce to have only event type per subscription then for following meta-release use of array MUST be decided

at API project level.

idstring required

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.

startsAtstring date-time

Date when the event subscription will begin/began It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)

expiresAtstring date-time

Date when the event subscription will expire. Only provided when subscriptionExpireTime is indicated by API client or Telco Operator has specific policy about that. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)

status'ACTIVATION_REQUESTED' | 'ACTIVE' | 'EXPIRED' | 'INACTIVE' | 'DELETED'

Current status of the subscription - Management of Subscription State engine is not mandatory for now. Note not all statuses may be considered to be implemented. Details:

  • ACTIVATION_REQUESTED: Subscription creation (POST) is triggered but subscription creation process is not finished yet.
  • ACTIVE: Subscription creation process is completed. Subscription is fully operative.
  • INACTIVE: Subscription is temporarily inactive, but its workflow logic is not deleted.
  • EXPIRED: Subscription is ended (no longer active). This status applies when subscription is ended due to SUBSCRIPTION_EXPIRED or ACCESS_TOKEN_EXPIRED event.
  • DELETED: Subscription is ended as deleted (no longer active). This status applies when subscription information is kept (i.e. subscription workflow is no longer active but its meta-information is kept).