Newer
Older
timezone:
description: Time zone of access point.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: dateTimeStamp
required:
- accessPointId
- connectionType
- operationStatus
- numberOfUsers
- resourceURL
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
type: object
AccessPointList:
description: A type containing list of access points.
properties:
accessPoint:
description: Collection of the access point information list.
items:
$ref: '#/components/schemas/AccessPointInfo'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: AccessPointInfo
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
type: object
CallbackReference:
properties:
callbackData:
description: Data the application can register with the server when subscribing to notifications, and that are passed back unchanged in each of the related notifications. These data can be used by the application in the processing of the notification, e.g. for correlation purposes.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
notificationFormat:
notifyURL:
description: Notify Callback URL
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: anyURI
required:
type: object
CircleNotificationSubscription:
description: A type containing data for notifications, when the area is defined as a circle.
description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)
items:
type: string
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: anyURI
callbackReference:
checkImmediate:
description: Check location immediately after establishing notification.
type: boolean
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: boolean
clientCorrelator:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
count:
description: Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
duration:
description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications."
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
enteringLeavingCriteria:
description: Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: int
latitude:
description: Latitude of center point.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
link:
description: Link to other resources that are in relationship with the resource.
items:
$ref: '#/components/schemas/Link'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Link
longitude:
description: Longitude of center point.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
radius:
description: Radius circle around center point in meters.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
requester:
description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
trackingAccuracy:
description: Number of meters of acceptable error in tracking distance.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
required:
- callbackReference
- address
- latitude
- longitude
- radius
- trackingAccuracy
- enteringLeavingCriteria
- checkImmediate
- frequency
type: object
ConnectionType:
description: The connection type for the access point
enum:
- Femto
- LTE-femto
- Smallcell
- LTE-smallcell
- Wifi
- Pico
- Micro
- Macro
- Wimax
- Unknown
- AllWithinDistance
- AnyWithinDistance
- AllBeyondDistance
- AnyBeyondDistance
type: string
DistanceNotificationSubscription:
description: A type containing data for distance subscription, with reference to other devices.
checkImmediate:
description: Check location immediately after establishing notification.
type: boolean
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: boolean
clientCorrelator:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
count:
description: Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
criteria:
distance:
description: Distance between devices that shall be monitored.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
duration:
description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications."
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
frequency:
description: Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: int
link:
description: Link to other resources that are in relationship with the resource.
items:
$ref: '#/components/schemas/Link'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Link
monitoredAddress:
description: Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
items:
type: string
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: anyURI
referenceAddress:
description: Indicates address of each device that will be used as reference devices from which the distances towards monitored devices indicated in the Addresses will be monitored (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
items:
type: string
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: anyURI
requester:
description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
trackingAccuracy:
description: Number of meters of acceptable error in tracking distance.
format: float
type: number
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: float
required:
- callbackReference
- monitoredAddress
- distance
- trackingAccuracy
- criteria
- checkImmediate
- frequency
type: object
EnteringLeavingCriteria:
enum:
type: string
Link:
description: Link to other resources
properties:
href:
description: URI
format: anyURI
type: string
rel:
description: Describes the relationship between the URI and the resource.
type: string
required:
type: object
LocationInfo:
properties:
accuracy:
Muhammad Rehan Abbasi
committed
description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if "shape" equals 4, 5 or 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
accuracyAltitude:
Muhammad Rehan Abbasi
committed
description: Altitude accuracy / uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if "shape" equals 3 or 4
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
accuracySemiMinor:
Muhammad Rehan Abbasi
committed
description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if "shape" equals 4, 5 or 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
altitude:
description: Location altitude relative to the WGS84 ellipsoid surface.
format: float
type: number
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Float
confidence:
Muhammad Rehan Abbasi
committed
description: Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in ETSI TS 123 032 [14]. Present only if "shape" equals 1, 4 or 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
includedAngle:
description: Present only if "shape" equals 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
innerRadius:
description: Present only if "shape" equals 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
latitude:
description: "Location latitude, expressed in the range -90\xB0 to +90\xB0. Cardinality greater than one only if \"shape\" equals 7."
items:
format: float
type: number
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Float
longitude:
description: "Location longitude, expressed in the range -180\xB0 to +180\xB0. Cardinality greater than one only if \"shape\" equals 7."
items:
format: float
type: number
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Float
offsetAngle:
description: Present only if "shape" equals 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
orientationMajorAxis:
Muhammad Rehan Abbasi
committed
description: "Angle of orientation of the major axis, expressed in the range 0\xB0 to 180\xB0, as defined in ETSI TS 123 032 [14]. Present only if \"shape\" equals 4 or 6"
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
shape:
Muhammad Rehan Abbasi
committed
description: 'Shape information, as detailed in ETSI TS 123 032 [14], associated with the reported location coordinate: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON'
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum_inlined
timestamp:
uncertaintyRadius:
description: Present only if "shape" equals 6
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
velocity:
Muhammad Rehan Abbasi
committed
description: "Structure with attributes relating to the target entity\u2019s velocity, as defined in ETSI TS 123 032 [14]."
Muhammad Rehan Abbasi
committed
description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in ETSI TS 123 032 [14]."
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: UnsignedInt
horizontalSpeed:
Muhammad Rehan Abbasi
committed
description: Horizontal speed, expressed in km/h and defined in ETSI TS 123 032 [14].
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: UnsignedInt
uncertainty:
Muhammad Rehan Abbasi
committed
description: Horizontal uncertainty, as defined in ETSI TS 123 032 [14]. Present only if "velocityType" equals 3 or 4
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
velocityType:
Muhammad Rehan Abbasi
committed
description: 'Velocity information, as detailed in ETSI TS 123 032 [14], associated with the reported location coordinate: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT'
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum_inlined
verticalSpeed:
Muhammad Rehan Abbasi
committed
description: Vertical speed, expressed in km/h and defined in ETSI TS 123 032 [14]. Present only if "velocityType" equals 2 or 4
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Int
verticalUncertainty:
Muhammad Rehan Abbasi
committed
description: Vertical uncertainty, as defined in ETSI TS 123 032 [14]. Present only if "velocityType" equals 4
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: UnsignedInt
required:
- velocityType
- bearing
- horizontalSpeed
type: object
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Structure (inlined)
required:
- latitude
- longitude
- shape
type: object
x-etsi-ref: 6.5.3
NotificationFormat:
enum:
type: string
NotificationSubscriptionList:
properties:
circleNotificationSubscription:
description: Collection of CircleNotificationSubscription elements, see note 2.
items:
$ref: '#/components/schemas/CircleNotificationSubscription'
minItems: 0
type: array
x-etsi-mec-cardinality: 0.. N
x-etsi-mec-origin-type: CircleNotificationSubscription
distanceNotificationSubscription:
description: Collection of DistanceNotificationSubscription elements, see note 2.
items:
$ref: '#/components/schemas/DistanceNotificationSubscription'
minItems: 0
type: array
x-etsi-mec-cardinality: 0.. N
x-etsi-mec-origin-type: DistanceNotificationSubscription
periodicNotificationSubscription:
description: Collection of PeriodicNotificationSubscription elements, see note 2.
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
items:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
minItems: 0
type: array
x-etsi-mec-cardinality: 0.. N
x-etsi-mec-origin-type: PeriodicNotificationSubscription
resourceURL:
description: Self-referring URL, see note 1.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: AnyURI
userTrackingSubscription:
description: Collection of UserTrackingSubscription elements, see note 1.
items:
$ref: '#/components/schemas/UserTrackingSubscription'
minItems: 0
type: array
x-etsi-mec-cardinality: 0.. N
x-etsi-mec-origin-type: UserTrackingSubscription
zonalTrafficSubscription:
description: Collection of ZonalTrafficSubscription elements, see note 1.
items:
$ref: '#/components/schemas/ZonalTrafficSubscription'
minItems: 0
type: array
x-etsi-mec-cardinality: 0.. N
x-etsi-mec-origin-type: ZonalTrafficSubscription
zoneStatusSubscription:
description: Collection of ZoneStatusSubscription elements, see note 1.
items:
$ref: '#/components/schemas/ZoneStatusSubscription'
minItems: 0
type: array
x-etsi-mec-cardinality: 0.. N
x-etsi-mec-origin-type: ZoneStatusSubscription
required:
x-etsi-notes: "NOTE 1:\tAs specified in [5], clause 5.2.2.8.\nNOTE 2: \tAs specified in [6], clause 5.2.2.7."
x-etsi-ref: 6.3.3
OperationStatus:
enum:
- Serviceable
- Unserviceable
- Unknown
type: string
PeriodicNotificationSubscription:
description: A type containing data for periodic subscription.
properties:
address:
description: Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)
items:
type: string
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: anyURI
callbackReference:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
duration:
description: "Period of time (in seconds) notifications are provided for. If set to \u201C0\u201D (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications."
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: int
frequency:
description: Maximum frequency (in seconds) of notifications (can also be considered minimum time between notifications) per subscription.
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: int
link:
description: Link to other resources that are in relationship with the resource.
items:
$ref: '#/components/schemas/Link'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Link
requestedAccuracy:
description: Accuracy of the provided distance in meters.
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: int
requester:
description: Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
required:
- callbackReference
- address
- requestedAccuracy
- frequency
type: object
ProblemDetails:
properties:
detail:
description: A human-readable explanation specific to this occurrence of the problem
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
instance:
description: A URI reference that identifies the specific occurrence of the problem
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: URI
status:
description: The HTTP status code for this occurrence of the problem
format: uint32
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Uint32
title:
description: A short, human-readable summary of the problem type
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
type:
description: A URI reference according to IETF RFC 3986 that identifies the problem type
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: URI
type: object
RetrievalStatus:
enum:
- Retrieved
- NotRetrieved
- Error
type: string
ServiceError:
description: used to indicate a notification termination or cancellation.
properties:
messageId:
description: Message identifier, either with prefix SVC or with prefix POL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
text:
description: Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
variables:
description: Variables to substitute into text string
items:
type: string
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: string
required:
type: object
SubscriptionNotification:
description: A type containing the notification subscription.
properties:
callbackData:
description: CallbackData if passed by the application in the receiptRequest element during the associated subscription operation
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
distanceCriteria:
isFinalNotification:
description: Set to true if it is a final notification about location change.
type: boolean
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: boolean
link:
description: Link to other resources that are in relationship with the resource.
items:
$ref: '#/components/schemas/Link'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Link
terminalLocation:
description: Collection of the terminal locations.
items:
$ref: '#/components/schemas/TerminalLocation'
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: TerminalLocation
required:
description: A type containing information about the distance from a terminal to a location or between two terminals, in addition the accuracy and a timestamp of the information are provided.
properties:
accuracy:
description: Accuracy of the provided distance in meters
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: integer
distance:
description: Distance from terminal to a location or between two terminals specified in meters
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: integer
timestamp:
description: A type containing device address, retrieval status and location information.
description: Address of the terminal to which the location information applies (e.g., 'sip' URI, 'tel' URI, 'acr' URI).
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
currentLocation:
- address
- locationRetrievalStatus
type: object
TimeStamp:
properties:
nanoSeconds:
description: 'The nanoseconds part of the time. Time is defined as
Unix-time since January 1, 1970, 00:00:00 UTC.'
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
seconds:
description: 'The seconds part of the time. Time is defined as
Unix-time since January 1, 1970, 00:00:00 UTC.'
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
required:
type: object
x-etsi-ref: 6.5.2
UserEventType:
enum:
- Entering
- Leaving
- Transferring
type: string
UserInfo:
properties:
accessPointId:
description: The identity of the access point the user is currently on, see note 1.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
address:
description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: AnyURI
ancillaryInfo:
description: Reserved for future use.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
contextLocationInfo:
description: Contextual information of a user location (e.g. aisle, floor, room number, etc.).
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
locationInfo:
resourceURL:
description: Self-referring URL, see note 1.
type: string
x-etsi-mec-cardinality: '1'
description: The identity of the zone the user is currently within, see note 1.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- address
- accessPointId
- zoneId
- resourceURL
- timestamp
x-etsi-notes: "NOTE 1:\tAs specified in [5], clause 5.2.2.7.\nNOTE 2: \tAs specified in [5], clause 5.2.2.5."
x-etsi-ref: 6.2.2
UserList:
description: A type containing list of users.
properties:
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
user:
description: Collection of the zone information list.
items:
$ref: '#/components/schemas/UserInfo'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: UserInfo
required:
type: object
UserTrackingSubscription:
description: A type containing user tracking subscription.
properties:
address:
description: Address of user (e.g. "sip" URI, "tel" URI, "acr" URI) to monitor
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
callbackReference:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
userEventCriteria:
description: List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.
items:
$ref: '#/components/schemas/UserEventType'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: UserEventType
required:
- callbackReference
- address
type: object
ZonalPresenceNotification:
description: A type containing zonal presence notification
properties:
address:
description: Address of user (e.g. "sip" URI, "tel" URI, "acr" URI) to monitor
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
callbackData:
description: CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
currentAccessPointId:
description: Identifier of access point.
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
interestRealm:
description: Interest realm of access point (e.g. geographical area, a type of industry etc.).
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
link:
description: Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification
items:
$ref: '#/components/schemas/Link'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Link
previousAccessPointId:
description: Identifier of access point.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
timestamp:
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
- zoneId
- address
- userEventType
- currentAccessPointId
- timestamp
type: object
ZonalTrafficSubscription:
description: A type containing zonal traffic subscription
properties:
callbackReference:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
duration:
description: Period (in seconds) of time notifications are provided for. If set to "0" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: unsignedInt
interestRealm:
description: Interest realm of access point (e.g. geographical area, a type of industry etc.).
items:
type: string
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: string
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
userEventCriteria:
description: List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.
items:
$ref: '#/components/schemas/UserEventType'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: UserEventType
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
- callbackReference
- zoneId
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
type: object
ZoneInfo:
description: A type containing zone information.
properties:
numberOfAccessPoints:
description: The number of access points within the zone
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: unsignedInt
numberOfUnserviceableAccessPoints:
description: Number of inoperable access points within the zone.
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: unsignedInt
numberOfUsers:
description: The number of users currently on the access point.
type: integer
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: unsignedInt
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
- zoneId
- numberOfAccessPoints
- numberOfUnserviceableAccessPoints
- numberOfUsers
- resourceURL
type: object
ZoneList:
description: A type containing a list of zones.
properties:
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: anyURI
zone:
description: Collection of the zone information list.
items:
$ref: '#/components/schemas/ZoneInfo'
type: array
required:
type: object
ZoneStatusNotification:
description: A type containing zone status notification.
properties:
accessPointId:
description: Identifier of an access point.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
callbackData:
description: CallBackData if passed by the application during the associated ZoneStatusSubscription operation. See [REST_NetAPI_Common].
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
link:
description: Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification
items:
$ref: '#/components/schemas/Link'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Link
numberOfUsersInAP:
description: This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: unsignedInt
numberOfUsersInZone:
description: This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: unsignedInt
operationStatus:
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
type: object
ZoneStatusSubscription:
description: A type containing zone status subscription.
properties:
callbackReference:
description: A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: string
numberOfUsersAPThreshold:
description: Threshold number of users in an access point which if crossed shall cause a notification
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: unsignedInt
numberOfUsersZoneThreshold:
description: Threshold number of users in a zone which if crossed shall cause a notification
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: unsignedInt
operationStatus:
description: List of operation status values to generate notifications for (these apply to all access points within a zone).
items:
$ref: '#/components/schemas/OperationStatus'
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: OperationStatus
resourceURL:
description: Self referring URL
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: anyURI
zoneId:
description: Identifier of zone
type: string
x-etsi-mec-cardinality: 1
x-etsi-mec-origin-type: string
required:
- callbackReference
- zoneId