Verizon 5G Edge API Portal

vv1.0

DevicesRequestFilter

Devices filter criteria or pagination token

DevicesRequestFilter

Devices filter criteria or pagination token

One of

DevicesFilter

Optional filter criteria. Can specify one or more of:

  • ClientType: Filter devices by client type
  • ClientSubtype: Filter devices by client subtype
  • MecId: Filter devices by MEC ID
  • PageSize: Number of devices to return per page

Valid combinations:

  • ClientType only
  • ClientSubtype only
  • ClientType and ClientSubtype together
  • MecId only
  • MecId and ClientType together
  • MecId and ClientSubtype together
  • MecId, ClientType, and ClientSubtype together
  • PageSize only
  • PageSize with any of the above combinations

If no filter is provided, all devices for the vendor are returned.

Properties

NameTypeRequiredDescription
ClientTypestring (one of: Vehicle, VulnerableRoadUser, TrafficLightController, InfrastructureSensor, OnboardSensor, Software)NoThe type of the client that is to be registered. This is one of the major traffic participant groups considered in V2X communication. The system uses this value to define which topics the client will be able to publish and subscribe to. Values: - Vehicle - Vehicle with an enclosure around the passengers. (Subtypes: Motorcycle, PassengerCar, Truck, Bus, EmergencyVehicle, SchoolBus, MaintenanceVehicle) - VulnerableRoadUser - Traffic participants without a protecting enclosure. (Subtypes: Bicycle, Pedestrian, Scooter) - TrafficLightController - A Traffic light controller system. (Subtypes: NA) - InfrastructureSensor - Sensors that are deployed in the infrastructure. (Subtypes: RoadSideUnit, Camera, Lidar, Radar, InductiveLoop, MagneticSensor) - OnboardSensor - Sensors that are onboard on a vehicle(Subtypes: Camera, Lidar, Radar) - Software - A software system or application. (Subtypes: Platform, Application, NA)
ClientSubtypestring (one of: PassengerCar, Truck, Bus, EmergencyVehicle, SchoolBus, MaintenanceVehicle, Pedestrian, Bicycle, Scooter, Motorcycle, RoadSideUnit, Camera, Lidar, Radar, InductiveLoop, MagneticSensor, Platform, Application, NA)NoThe subtype or subgroup of the client type. This further specifies the client type. For example it will specify if the client is a passenger car or a truck. See the ClientType description for the supported Subtypes for each client type.
MecIdstringNoThe unique identifier for a Multi-access Edge Computing (MEC) location in the ETX system. This ID is used to reference and manage MEC locations for registration, update, retrieval, and deletion operations.
PageSizeinteger (1–500)NoNumber of devices to return per page. If not provided, the server default is used.

PaginationFilter

Pagination filter containing an opaque token for fetching the next/previous page of results. The page token is returned in the response headers (X-Next, X-Prev) and should be passed as-is.

Properties

NameTypeRequiredDescription
PagestringYesOpaque pagination token for fetching the next/previous page of results. This is a encoded string. Do not parse or modify; pass it as received.

On this page