Newer
Older
/**
* @author ETSI / STF569
* @version $Url$
* $Id$
* @desc Types ANd Values for ETSI GS MEC 013 V2.1.1 (2019-09)
* @copyright ETSI Copyright Notification
* No part may be reproduced except as authorized by written permission.
* The copyright and the foregoing restriction extend to reproduction in all media.
* All rights reserved.
*/
// LibCommon
import from LibCommon_BasicTypesAndValues all;
/**
* @desc The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
*/
type UInt32 Seconds;
/**
* @desc The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
*/
type UInt32 NanoSeconds;
/**
* @desc
* @member seconds The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
* @member nanoSeconds The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
* @see ETSI GS MEC 013 V2.1.1 (2019-09) Clause 6.5.2 Type: TimeStamp
/**
* @desc A type containing list of users.
* @member user Collection of the zone information list.
* @member resourceURL Self referring URL.
* @see ETSI GS MEC 013 V2.1.1 (2019-09) Clause
*/
type record of UserInfo UserInfos;
type record UserList {
UserInfos user optional,
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/**
* @desc Shape information, as detailed in [14], associated with the reported location coordinate
* @see ETSI GS MEC 013 V2.1.1 (2019-09) Table 6.5.3-1: Definition of type LocationInfo
*/
type enumerated Shape {
ELLIPSOID_ARC (1),
ELLIPSOID_POINT (2),
ELLIPSOID_POINT_ALTITUDE (3),
ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID (4),
ELLIPSOID_POINT_UNCERT_CIRCLE (5),
ELLIPSOID_POINT_UNCERT_ELLIPSE (6),
POLYGON (7)
}
/**
* @desc Velocity information, as detailed in [14], associated with the reported location coordinate
* @see ETSI GS MEC 013 V2.1.1 (2019-09) Table 6.5.3-1: Definition of type LocationInfo
*/
type enumerated VelocityType {
HORIZONTAL (1),
HORIZONTAL_VERTICAL (2),
HORIZONTAL_UNCERT (3),
HORIZONTAL_VERTICAL_UNCERT (4)
}
type record Velocity {
VelocityType velocityType,
UInt32 bearing,
UInt32 horizontalSpeed,
Int32 verticalSpeed optional,
UInt32 verticalUncertainty optional
}
/**
* @desc A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.
* @member latitude Location latitude, expressed in the range -90° to +90°. Cardinality greater than one only if "shape" equals 7.
* @member longitude Location longitude, expressed in the range -180° to +180°. Cardinality greater than one only if "shape" equals 7.
* @member altitude Location altitude relative to the WGS84 ellipsoid surface.
* @member accuracy Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
* @see ETSI GS MEC 013 V2.1.1 (2019-09) Clause 6.5.3 Type: LocationInfo
JSON.Number latitude,
JSON.Number longitude,
JSON.Number altitude optional,
UInt32 accuracy optional,
UInt32 accuracySemiMinor optional,
UInt32 accuracyAltitude optional,
UInt32 orientationMajorAxis optional,
UInt32 confidence optional,
UInt32 innerRadius optional,
UInt32 uncertaintyRadius optional,
UInt32 offsetAngle optional,
UInt32 includedAngle optional,
Shape shape,
Velocity velocity optional
} // End of type LocationInfo
/**
* @desc A type containing zone information.
* @member zoneId Identifier of zone
* @member numberOfAccessPoints The number of access points within the zone
* @member numberOfUnservicableAccessPoints Number of inoperable access points within the zone.
* @member numberOfUsers The number of users currently on the access point.
* @member resourceURL Self referring URL.
ZoneId zoneId,
NumberOfAccessPoints numberOfAccessPoints,
NumberOfUnserviceableAccessPoints numberOfUnservicableAccessPoints,
NumberOfUsers numberOfUsers,
ResourceURL resourceURL
/**
* @desc Collection of the zone information list.
* @member zone Collection of the zone information list.
* @member resourceURL Self referring URL.
*/
type record of ZoneInfo ZoneInfos;
type record ZoneList {
ZoneInfos zone optional,
ResourceURL resourceURL
}
/**
* @desc Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element
* @see ETSI GS MEC 013 V2.1.1 (2019-09) 6.6.1 accessPointId
/**
* @desc A type containing access point information.
* @member accessPointId
* @member connectionType The connection type for the access poin
* @member operationStatus The operation status of the access point
* @member numberOfUsers The number of users currently on the access point.
* @member resourceURL Self referring URL.
*/
type record AccessPointInfo {
AccessPointId accessPointId,
ConnectionType connectionType,
OperationStatus operationStatus,
NumberOfUsers numberOfUsers,
InterestRealm interestRealm,
/**
* @desc A type containing list of access points.
* @member zoneId
* @member accessPoint Collection of the access point information list.
* @member resourceURL
*/
type record AccessPointList {
ZoneId zoneId,
ResourceURL resourceURL
}
/**
* @desc Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI).
*/
type JSON.AnyURI Address
/**
* @desc Reserved for future use.
*/
/**
* @desc CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [\
REST_NetAPI_Common].
*/
/**
* @desc Notification callback definition.
* @member notifyURL
*/
type record CallbackReference {
NotifyURL notifyURL
* @desc Uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription.
*/
/**
* @desc The connection type for the access point
Femto,
LTE_femto,
Smallcell,
LTE_smallcell,
Wifi,
Pico,
Micro,
Macro,
Wimax,
Unknown
/**
* @desc Contextual information of a user location (e.g., aisle, floor, room number, etc.)
*/
/**
* @desc 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.
*/
/**
* @desc Interest realm of access point (e.g. geographical area, a type of industry etc.).
*/
/**
* @desc Link to other resources
* @member rel Describes the relationship between the URI and the resource.
* @member href UTI
*/
type record Link {
}
/**
* @desc The URL of your own listener application.
*/
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
/**
* @desc The number of access points within the zone
*/
type UInt32 NumberOfAccessPoints;
/**
* @desc Number of inoperable access points within the zone.
*/
type UInt32 NumberOfUnserviceableAccessPoints;
/**
* @desc The number of users currently on the access point.
*/
type UInt32 NumberOfUsers;
/**
* @desc Threshold number of users in an access point which if crossed shall cause a notification.
*/
type UInt32 NumberOfUsersAPThreshold;
/**
* @desc 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 UInt32 NumberOfUsersInAP;
/**
* @desc Threshold number of users in a zone which if crossed shall cause a notification.
*/
type UInt32 NumberOfUsersInZone;
/**
* @desc Threshold number of users in a zone which if crossed shall cause a notification.
*/
type UInt32 NumberOfUsersZoneThreshold;
/**
* @desc The operation status of the access point
*/
type enumerated OperationStatus {
/**
* @desc Indicates the time of day for zonal presence notification.
*/
/**
* @desc Time zone of access point
*/
/**
* @desc User event
*/
type enumerated UserEventType {
Entering,
Leaving,
Transferring
}
/**
* @desc 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.
*/
type record of UserEventType UserEventCriteria;
/**
* @desc A type containing user information.
* @member address_ Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI).
* @member accessPointId Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171).
* @member zoneId Identifier of zone
* @member locationInfo A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.
* @member contextLocationInfo Contextual information of a user location (e.g. aisle, floor, room number, etc.).
* @member ancillaryInfo Reserved for future use
* @see ETSI GS MEC 013 V2.1.1 (2019-09) Clause 6.2.2 Type: UserInfo
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
type record UserInfo {
Address address_,
AccessPointId accessPointId,
ZoneId zoneId,
ResourceURL resourceURL,
LocationInfo locationInfo optional,
ContextLocationInfo contextLocationInfo optional,
AncillaryInfo ancillaryInfo optional
} with {
variant (address_) "name as 'address'";
} // End of type UserInfo
/**
* @desc A type containing user tracking subscription.
* @member
*/
type record UserTrackingSubscription {
ClientCorrelator clientCorrelator optional,
CallbackReference callbackReference,
Address address_,
UserEventCriteria userEventCriteria optional,
ResourceURL resourceURL optional
} with {
variant (address_) "name as 'address'";
}
/**
* @desc A type containing zonal presence notification
* @member
* @member link 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.
*/
type record ZonalPresenceNotification {
CallbackReference callbackReference optional,
ZoneId zoneId,
Address address_,
InterestRealm interestRealm optional,
UserEventType userEventType,
CurrentAccessPointId currentAccessPointId,
PreviousAccessPointId previousAccessPointId optional,
Timestamp timestamp_,
Link link optional
} with {
variant (address_) "name as 'address'";
variant (timestamp_) "name as 'timestamp'";
}
/**
* @desc A type containing zonal traffic subscription
* @member
* @member interestRealm Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).
* @member userEventCriteria 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.
* @member resourceURL
*/
type record ZonalTrafficSubscription {
ClientCorrelator clientCorrelator optional,
CallbackReference callbackReference,
ZoneId zoneId,
InterestRealm interestRealm optional,
UserEventCriteria userEventCriteria optional,
Duration duration optional,
ResourceURL resourceURL optional
}
/**
* @desc Identifier of zone
*/
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
/**
* @desc A type containing zone status notification.
* @member zoneId
* @member
*/
type record ZoneStatusNotification {
CallbackData callbackData optional,
ZoneId zoneId,
AccessPointId accessPointId optional,
NumberOfUsersInZone numberOfUsersInZone optional,
NumberOfUsersInAP numberOfUsersInAP optional,
OperationStatus operationStatus optional,
Timestamp timestamp_,
Link link
} with {
variant (timestamp_) "name as 'timestamp'";
}
/**
* @desc A type containing zone status subscription.
* @member zoneId
* @member
* @member
* @member
* @member operationStatus List of operation status values to generate notifications for (these apply to all access points within a zone).
*/
type record ZoneStatusSubscription {
ClientCorrelator clientCorrelator optional,
ResourceURL resourceURL optional,
CallbackReference callbackReference,
ZoneId zoneId,
NumberOfUsersZoneThreshold numberOfUsersZoneThreshold optional,
NumberOfUsersAPThreshold numberOfUsersAPThreshold optional,
OperationStatus operationStatus optional
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
type record CircleNotificationSubscription { // FIXME Incomplete data structure desciption
ClientCorrelator clientCorrelator optional,
ResourceURL resourceURL optional,
CallbackReference callbackReference,
Address address_ optional
} with {
variant (address_) "name as 'address'";
}
type record TerminalDistance {
JSON.Number distance
}
type record DistanceNotificationSubscription { // FIXME Incomplete data structure desciption
ClientCorrelator clientCorrelator optional,
ResourceURL resourceURL optional,
CallbackReference callbackReference,
Address address_ optional
} with {
variant (address_) "name as 'address'";
}
type record PeriodicNotificationSubscription { // FIXME Incomplete data structure desciption
ClientCorrelator clientCorrelator optional,
ResourceURL resourceURL optional,
CallbackReference callbackReference,
Address address_ optional
} with {
variant (address_) "name as 'address'";
}
/**
* @desc This type contains a list of subscriptions
* @ see ETSI GS MEC 013 V2.1.1 (2019-09) Clause 6.3.3 Type: NotificationSubscriptionList
*/
type record NotificationSubscriptionList {
ZonalTrafficSubscription zonalTrafficSubscription optional,
UserTrackingSubscription userTrackingSubscription optional,
ZoneStatusSubscription zoneStatusSubscription optional,
CircleNotificationSubscription circleNotificationSubscription optional,
PeriodicNotificationSubscription periodicNotificationSubscription optional,
DistanceNotificationSubscription distanceNotificationSubscription optional,
ResourceURL resourceURL
}