Newer
Older
"UserLocationEventSubscription": {
"properties": {
"_links": {
"$ref": "#/components/schemas/_links"
},
"address": {
"description": "Address of user (e.g. ‘sip’ URI, ‘tel’ URI, ‘acr’ URI) to monitor.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uri"
},
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
"format": "uri",
"type": "string",
"x-etsi-mec-origin-type": "Uri"
"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. See note 2.",
"type": "string",
"x-etsi-mec-origin-type": "String"
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"locationEventCriteria": {
"description": "List of user event values to generate notifications for (these apply to address specified). ",
"$ref": "#/components/schemas/LocationEventType"
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Array(LocationEventType)"
},
"requestTestNotification": {
"description": "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"UserLocationEventSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"userEventPara": {
"$ref": "#/components/schemas/UserEventPara"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": ["subscriptionType", "address"],
"type": "object",
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.",
"x-etsi-ref": "6.3.4"
},
"UserLocationPeriodicSubscription": {
"properties": {
"_links": {
"$ref": "#/components/schemas/_links"
"address": {
"description": "Address of user (e.g. ‘sip’ URI, ‘tel’ URI, ‘acr’ URI) to monitor.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uri"
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
"format": "uri",
"type": "string",
"x-etsi-mec-origin-type": "Uri"
"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. See note 2.",
"type": "string",
"x-etsi-mec-origin-type": "String"
"periodicEventInfo": {
"$ref": "#/components/schemas/PeriodicEventInfo"
"requestTestNotification": {
"description": "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.",
"type": "boolean",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"UserLocationPeriodicSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
"required": ["subscriptionType", "address", "periodicEventInfo"],
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [17], clause 6.1.6.2.24.",
"x-etsi-ref": "6.3.5"
"PeriodicEventInfo": {
"description": "NOTE: reportingAmount x reportingInterval shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP.",
"type": "object",
"required": ["reportingAmount", "reportingInterval"],
"reportingAmount": {
"description": "Number of event reports",
"type": "number",
"x-etsi-mec-cardinality": 1,
"x-etsi-mec-origin-type": "ReportingAmount"
"reportingInterval": {
"description": "Interval of event reports",
"type": "number",
"x-etsi-mec-cardinality": 1,
"x-etsi-mec-origin-type": "reportingInterval"
}
}
},
"ZoneLocationEventSubscription": {
"properties": {
"_links": {
"$ref": "#/components/schemas/_links"
"addressList": {
"description": "List of the users to be monitored. If not present, all the users need to be monitored.",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Array(Uri)"
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
"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. See note 2.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
"locationEventCriteria": {
"description": "List of user event values to generate notifications for. ",
"$ref": "#/components/schemas/LocationEventType"
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Array(LocationEventType)"
},
"reportingCtrl": {
"$ref": "#/components/schemas/ReportingCtrl"
},
"requestTestNotification": {
"description": "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"ZoneLocationEventSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
},
"zoneId": {
"description": "Identifier of zone (e.g. zone001) to monitor.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"required": ["subscriptionType", "zoneId"],
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.",
"x-etsi-ref": "6.3.6"
"UserAreaSubscription": {
"_links": {
"$ref": "#/components/schemas/_links"
},
"addressList": {
"description": "List of the users to be monitored. ",
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Array(Uri)"
"areaDefine": {
"$ref": "#/components/schemas/AreaInfo"
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
"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. See note 2.",
"type": "string",
"x-etsi-mec-origin-type": "String"
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
"locationEventCriteria": {
"description": "List of user event values to generate notifications for (these apply to address specified). ",
"$ref": "#/components/schemas/LocationEventType"
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Array(LocationEventType)"
"reportingCtrl": {
"$ref": "#/components/schemas/ReportingCtrl"
"reportingLocationReq": {
"description": "This IE shall be set to true if a location estimate is required for each event report.",
"type": "boolean",
"x-etsi-mec-origin-type": "boolean"
"requestTestNotification": {
"description": "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.",
"type": "boolean",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"UserAreaSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"trackingAccuracy": {
"description": "Number of meters of acceptable error.",
"format": "float",
"type": "number",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Float"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
"subscriptionType",
"areaDefine",
"addressList",
"trackingAccuracy"
"type": "object",
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.",
"x-etsi-ref": "6.3.8"
"UserDistanceSubscription": {
"_links": {
"$ref": "#/components/schemas/_links"
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
"checkImmediate": {
"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. See note 2.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"criteria": {
"$ref": "#/components/schemas/DistanceCriteria"
"distance": {
"description": "Distance between users that shall be monitored. The unit is meter.",
"format": "float",
"type": "number",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Float"
"expiryDeadline": {
"$ref": "#/components/schemas/TimeStamp"
},
"monitoredAddress": {
"description": "Contains addresses of users to monitor (e.g., ‘sip’ URI, ‘tel’ URI, ‘acr’ URI). Reference to a group could be provided here if supported by implementation.\nIf the ReferenceAddress is specified, then the distance between each monitored user and reference user(s) will be monitored.\nIf the ReferenceAddress is not present, then the distance between each pair of the monitored users will be monitored. Note that in that case there shall be at least two addresses specified here.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Array(Uri)"
},
"referenceAddress": {
"description": "If specified, indicates address of each user that will be used as reference users from which the distances towards monitored users indicated in the Addresses will be monitored (e.g., ‘sip’ URI, ‘tel’ URI, ‘acr’ URI). Reference to a group could be provided here if supported by implementation.",
"type": "array",
"x-etsi-mec-cardinality": "0..N",
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
"x-etsi-mec-origin-type": "Array(Uri)"
},
"reportingCtrl": {
"$ref": "#/components/schemas/ReportingCtrl"
},
"requestTestNotification": {
"description": "Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [4], clause 6.12a.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"subscriptionType": {
"description": "Shall be set to \"UserDistanceSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"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"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
"required": [
"subscriptionType",
"monitoredAddress",
"distance",
"trackingAccuracy",
"criteria",
"checkImmediate"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to location server to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [4], clause 6.12a.\nNOTE 2:\tThis allows the client to recover from communication failures during resource creation and therefore avoids duplicate subscription creation in such situations. In case the element is present, the server shall not alter its value, and shall provide it as part of the representation of this resource. In case the element is not present, the server shall not generate it.\nNOTE 3:\tAs specified in [6], clause 5.2.3.2.",
"x-etsi-ref": "6.3.9"
},
"DistanceCriteria": {
"description": "An enumeration, defining the distance criteria between devices.",
"enum": [
"AllWithinDistance",
"AnyWithinDistance",
"AllBeyondDistance",
"AnyBeyondDistance"
],
"type": "string"
"UserDistanceNotification": {
"_links": {
"$ref": "#/components/schemas/_links"
"monitoredUsers": {
"$ref": "#/components/schemas/UserList"
"notificationType": {
"description": "Shall be set to \"UserDistanceNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
"required": [
"notificationType",
"monitoredUsers",
"distanceEvent",
"_links"
],
"type": "object",
"x-etsi-notes": "NOTE:\tAs specified in [6], clause 5.2.3.2.",
"x-etsi-ref": "6.4.9"
"UserLocationEventNotification": {
"_links": {
"$ref": "#/components/schemas/_links"
"accessPointId": {
"description": "The identity of the access point.\nFor the events of \"ENTERING_AREA_EVENT\", it indicates the access point that the user is currently within. \nFor the event of \"LEAVING_AREA_EVENT\", it indicates the access point that the user used to be within.\nSee note 2.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"description": "Address of user (e.g. ‘sip’ URI, ‘tel’ URI, ‘acr’ URI).",
"format": "uri",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
"civicInfo": {
"$ref": "#/components/schemas/CivicAddress"
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
"notificationType": {
"description": "Shall be set to \"UserLocationEventNotification\".",
"type": "string",
"x-etsi-mec-origin-type": "String"
"relativeLocationInfo": {
"$ref": "#/components/schemas/RelativeLocationInfo"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"userLocationEvent": {
"$ref": "#/components/schemas/LocationEventType"
},
"zoneId": {
"description": "The identity of the zone. \nFor the events of \"ENTERING_AREA_EVENT\", it is the zone that the user is currently within. \nFor the event of \"LEAVING_AREA_EVENT\", it is the zone that the user used to be within.\nSee note 2.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"required": ["notificationType", "userLocationEvent", "_links"],
"x-etsi-notes": "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAs specified in [5], clause 5.2.2.7.\nNOTE 3:\tAt least one of these attributes shall be present only when reportingLocationReq is set to TRUE in the UserLocationEventSubscription.",
"x-etsi-ref": "6.4.4"
"UserLocationPeriodicNotification": {
"_links": {
"$ref": "#/components/schemas/_links"
},
"description": "The identity of the access point that the user is currently within. \nSee note 2.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"address": {
"description": "Address of user (e.g. ‘sip’ URI, ‘tel’ URI, ‘acr’ URI).",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
"civicInfo": {
"$ref": "#/components/schemas/CivicAddress"
},
"isFinalNotification": {
"description": "Shall be set to true if it is a final notification.",
"type": "boolean",
"x-etsi-mec-origin-type": "Boolean"
},
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"notificationType": {
"description": "Shall be set to \"UserLocationPeriodicNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"relativeLocationInfo": {
"$ref": "#/components/schemas/RelativeLocationInfo"
},
"result": {
"$ref": "#/components/schemas/NotificationResult"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"zoneId": {
"description": "The identity of the zone that the user is currently within. \nSee note 2.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
}
},
"required": ["notificationType", "result", "_links"],
"type": "object",
"x-etsi-notes": "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAs specified in [5], clause 5.2.2.7.\nNOTE 3:\tIf the result is SUCCESS, at least one of locationInfo, civicInfo and relativeLocationInfo shall be present.",
"x-etsi-ref": "6.4.5"
},
"ZoneLocationEventNotification": {
"properties": {
"_links": {
"$ref": "#/components/schemas/_links"
"address": {
"description": "Address of user (e.g. ‘sip’ URI, ‘tel’ URI, ‘acr’ URI).",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uri"
"notificationType": {
"description": "Shall be set to \"ZoneLocationEventNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"userLocationEvent": {
"$ref": "#/components/schemas/LocationEventType"
},
"description": "The identity of the zone. ",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"UserAreaNotification": {
"_links": {
"$ref": "#/components/schemas/_links"
},
"address": {
"description": "Address of user (e.g. ‘sip’ URI, ‘tel’ URI, ‘acr’ URI).",
"format": "uri",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uri"
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
"civicInfo": {
"$ref": "#/components/schemas/CivicAddress"
},
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
},
"notificationType": {
"description": "Shall be set to \"UserAreaNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"relativeLocationInfo": {
"$ref": "#/components/schemas/RelativeLocationInfo"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"userLocationEvent": {
"$ref": "#/components/schemas/LocationEventType"
}
},
"required": [
"notificationType",
"address",
"userLocationEvent",
"_links"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tAs specified in [17], clause 6.1.6.2.14.\nNOTE 2:\tAt least one of these attributes shall be present only when reportingLocationReq is set to TRUE in the UserAreaSubscription.",
"x-etsi-ref": "6.4.8"
},
"AreaInfo": {
"properties": {
"points": {
"description": "Shall include one point if the shape is CIRCLE. Shall include 3-15 points if the shape is POLYGON.",
"$ref": "#/components/schemas/Point"
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Array(Point)"
},
"radius": {
"description": "Shall be present if the shape is CIRCLE.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "UnsignedInt"
},
"shape": {
"description": "The shape of the area monitored: 1 = CIRCLE. 2 = POLYGON",
"enum": ["SEE_DESCRIPTION"],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum(inlined)"
"required": ["shape", "points"],
"type": "object",
"x-etsi-ref": "6.5.7"
"latitude": {
"description": "Location latitude, expressed in the range -90° to +90°.",
"format": "float",
"type": "number",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Float"
"longitude": {
"description": "Location longitude, expressed in the range -180° to +180°.",
"format": "float",
"type": "number",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Float"
}
},
"required": ["latitude", "longitude"],
"type": "object",
"x-etsi-ref": "6.5.8"
},
"ReportingCtrl": {
"properties": {
"maximumCount": {
"description": "Maximum number of notifications. 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": "UnsignedInt"
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
"maximumFrequency": {
"description": "Maximum frequency (in seconds) of notifications per subscription.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "UnsignedInt"
},
"minimumInterval": {
"description": "Minimum interval between reports in case frequently reporting. Unit is second.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "UnsignedInt"
}
},
"type": "object",
"x-etsi-ref": "6.5.6"
},
"_links": {
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["self"],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"UserEventPara": {
"properties": {
"accessPointList": {
"description": "One or more access points forming a monitoring area that could be any shape. See note 1.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Array(String)"
},
"occurrenceInfo": {
"$ref": "#/components/schemas/OccurrenceInfo"
},
"reportingLocationReq": {
"description": "This IE shall be set to true if a location estimate is required for each event report.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "boolean"
},
"zoneId": {
"description": "Identifier of zone (e.g. zone001) to monitor. See note 1.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
}
},
"type": "object",
"x-etsi-notes": "NOTE 1:\tOnly one of accessPointList and zoneId may be present.\nNOTE 2:\tAs specified in [17], clause 6.1.6.3.16.",
"x-etsi-ref": "6.5.5"
},
"WebsockNotifConfig": {
"properties": {
"requestWebsocketUri": {
"description": "Set to true by the service consumer to indicate that Websocket delivery is requested.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
"websocketUri": {
"description": "Set by location server to indicate to the service consumer the Websocket URI to be used for delivering notifications.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uri"
}
},
"type": "object",
"x-etsi-ref": "6.5.4"
},
"TestNotification": {
"properties": {
"_links": {
"$ref": "#/components/schemas/_links"
"notificationType": {
"description": "Shall be set to \"TestNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"required": ["notificationType", "_links"],
"type": "object",
"x-etsi-ref": "6.4.3"
"LocationEventType": {
"description": "This type represents specified event types for UE location report.",
"enum": ["ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT"],
"type": "string"
},
"NotificationResult": {
"description": "This enumeration represents the result of a localization associated with a notification",
"enum": ["SUCCESS", "ABNORMAL"],
"type": "string"
},
"OccurrenceInfo": {
"description": "The enumeration OccurrenceInfo indicates whether event reporting is one time.",
"enum": ["ONE_TIME_EVENT", "MULTIPLE_TIME_EVENT"],
"type": "string"
},
"CivicAddress": {
"description": "Indicates a Civic address",
"type": "object",
"required": ["country"],
"country": {
"description": "The two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US",
"type": "string",
"x-etsi-mec-cardinality": 1,
"x-etsi-mec-origin-type": "String"
"A1": {
"description": "National subdivisions (state, canton, region, province, prefecture)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"A2": {
"description": "County, parish, gun (JP), district (IN)",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"A3": {
"description": "City, township, shi (JP)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"A4": {
"description": "City division, borough, city district, ward, chou (JP)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"A5": {
"description": "Neighbourhood, block",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"A6": {
"description": "Group of streets below the neighbourhood level",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"PRD": {
"description": "Leading street direction",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"POD": {
"description": "Trailing street suffix",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"STS": {
"description": "Street suffix or type",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"HNO": {
"description": "House number",
"type": "string",
"x-etsi-mec-origin-type": "String"
"HNS": {
"description": "House number suffix",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"LMK": {
"description": "Landmark or vanity address",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"LOC": {
"description": "Additional location information",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"NAM": {
"description": "Name (residence and office occupant)",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"PC": {
"description": "Postal/zip code",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"BLD": {
"description": "Building (structure)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"UNIT": {
"description": "Unit (apartment, suite)",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"FLR": {
"description": "Floor",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ROOM": {
"description": "Room",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"PLC": {
"description": "Place-type",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"PCN": {
"description": "Postal community name",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"POBOX": {
"description": "Post office box (P.O. box)",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"ADDCODE": {
"description": "Additional code",
"type": "string",
"x-etsi-mec-origin-type": "String"
"SEAT": {
"description": "Seat (desk, cubicle, workstation)",
"type": "string",
"x-etsi-mec-origin-type": "String"
"RD": {
"description": "Primary road or street",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"RDSEC": {
"description": "Road clause",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"RDBR": {
"description": "Road branch",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"RDSUBBR": {
"description": "Road sub-branch",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"PRM": {
"description": "Road pre-modifier",
"type": "string",
"x-etsi-mec-origin-type": "String"
"POM": {
"description": "Road post-modifier",
"type": "string",
"x-etsi-mec-origin-type": "String"
"usageRules": {
"description": "When present, this IE shall carry the value of \"usagerules\" Element of the PIDL-LO XML document, with UTF-8 encoding.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"method": {
"description": "When present, this IE shall contain the method token, carried by the \"method\" Element of the PIDLLO XML document.",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
"providedBy": {
"description": "When present, this IE shall carry the value of \"provided-by\" Element of the PIDL-LO XML document, with UTF-8 encoding.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"