API Reference

Retrieve QoD sessions by device v1.1

Querying for QoS session resource information details for a device

NOTES:

  • The access token may be either 2-legged or 3-legged.
    • If a 3-legged access token is used, the subject associated with the session must also be associated with the access token. In this case the optional device parameter MUST NOT be provided in the request.
    • If a 2-legged access token is used, the device parameter must be provided and identify a device.
  • The session must have been created by the same API consumer given in the access token
  • If no QoS session is found for the requested device, an empty array is returned.
  • This call uses the POST method instead of GET to comply with the CAMARA Commonalities guidelines for sending sensitive or complex data in API calls. Since the device field may contain personally identifiable information, it should not be sent via GET.
    CAMARA API Design Guidelines
Body Params

Parameters to get QoS session information by device

Parameters to get QoS session information by device

device
object

End-user equipment 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

NOTE: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json