diff --git a/LocationAPI.yaml b/LocationAPI.yaml index e76f86ec5d37e502ac696b8964db4f17cfb7a2f0..582922a7d37a411a654e8599839fbb8900efc596 100644 --- a/LocationAPI.yaml +++ b/LocationAPI.yaml @@ -1,42 +1,38 @@ openapi: 3.1.0 +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema info: contact: url: https://forge.etsi.org/rep/mec/gs013-location-api - title: ETSI GS MEC 013 - Location API - version: 3.1.1 - description: The ETSI MEC ISG MEC013 Location API described using OpenAPI. + title: ETSI GS MEC 013 Location API + version: 3.2.1 + description: The ETSI MEC ISG Location API described using OpenAPI. license: name: BSD-3-Clause - url: 'https://forge.etsi.org/legal-matters' -externalDocs: - description: ETSI MEC013 V3.1.1 Location API - url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/03.01.01_60/gs_mec013v030101p.pdf' + url: https://forge.etsi.org/legal-matters servers: - - url: 'https://localhost/location/v2' -tags: - - name: 'location' - +- url: https://localhost/location/v3 paths: - /queries/distance: + /queries/users: get: + summary: UE Location Lookup of a specific UE or group of UEs. + description: The GET method is used to query location information about a specific UE or a group of UEs. + operationId: QueriesUsersGET tags: - - 'location' - summary: 'Query information about distance from a user to a location or between two users' - description: 'The GET method is used to query information about distance from a user to a location or between two users.' - operationId: distanceGET + - queries parameters: - - $ref: '#/components/parameters/Query.Address' - - $ref: '#/components/parameters/Query.Location' + - $ref: '#/components/parameters/Query.zoneId' + - $ref: '#/components/parameters/Query.accessPointId' + - $ref: '#/components/parameters/Query.address' responses: '200': - description: 'Upon success, a response body containing the list of distance information is returned.' + description: Upon success, a response body containing the list of user location information is returned. content: application/json: schema: type: object properties: - terminalDistance: - $ref: '#/components/schemas/TerminalDistance' + UserList: + $ref: '#/components/schemas/UserList' '400': $ref: '#/components/responses/400' '401': @@ -49,28 +45,188 @@ paths: $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'queries' - /queries/users: + /subscriptions/users: get: + summary: Retrieves information about the subscriptions for the requestor. + description: The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor. + operationId: SubscriptionsUsersGET tags: - - 'location' - summary: 'Query location information about a specific UE or a group of Ues' - description: 'The GET method is used to query location information about a specific UE or a group of Ues.' - operationId: usersGET + - subscriptions parameters: - - $ref: '#/components/parameters/Query.ZoneId' - - $ref: '#/components/parameters/Query.AccessPointId' - - $ref: '#/components/parameters/Query.Address_3' + - $ref: '#/components/parameters/Query.subscription_type' + - $ref: '#/components/parameters/Query.address1' responses: '200': - description: 'Upon success, a response body containing the list of user location information is returned.' + description: Upon success, a response body containing the list of links to requestor's subscriptions is returned. content: application/json: schema: type: object properties: - userList: - $ref: '#/components/schemas/UserList' + NotificationSubscriptionList: + $ref: '#/components/schemas/NotificationSubscriptionList' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + post: + summary: Create subscription to UE location. + description: The POST method is used to create a new subscription to UE location notifications. Upon success, the response contains entity body describing the created subscription. + operationId: SubscriptionsUsersPOST + tags: + - subscriptions + requestBody: + description: 'The entity body in the request contains data type of the specific UE location event subscription that is to be created, where the data type options are listed below and defined in clauses 6.3.4 and 6.3.5: + + UserLocationEventSubscription. + + UserLocationPeriodicSubscription.' + content: + application/json: + schema: + type: object + properties: + UserLocationEventSubscription: + $ref: '#/components/schemas/UserLocationEventSubscription' + responses: + '201': + description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field. + + + In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type from the list below and as defined in clauses 6.3.4 and 6.3.5: + + UserLocationEventSubscription. + + UserLocationPeriodicSubscription.' + content: + application/json: + schema: + type: object + properties: + UserLocationEventSubscription: + $ref: '#/components/schemas/UserLocationEventSubscription' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '415': + $ref: '#/components/responses/415' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + callbacks: + notification: + '{$request.body#/callbackUri}': + post: + summary: Callback POST used to send a notification + description: Subscription notification + operationId: notificationPOST670630 + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + type: object + properties: + subscriptionNotification: + oneOf: + - $ref: '#/components/schemas/UserLocationEventSubscription' + - $ref: '#/components/schemas/UserLocationPeriodicSubscription' + responses: + '204': + description: No content + '404': + description: Not found + parameters: [] + /subscriptions/users/{subscriptionId}: + get: + summary: Retrieve subscription information. + description: The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription. + operationId: SubscriptionsUsersGETSubscriptionid + tags: + - subscriptions + responses: + '200': + description: 'Upon success, a response body containing data type describing the specific Location event subscription is returned. The allowed data types for subscriptions are defined in clauses 6.3.4 and 6.3.5: + + UserLocationEventSubscription. + + UserLocationPeriodicSubscription.' + content: + application/json: + schema: + type: object + properties: + UserLocationEventSubscription: + $ref: '#/components/schemas/UserLocationEventSubscription' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string + put: + summary: Updates a subscription information. + description: The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request. + operationId: SubscriptionsUsersPUTSubscriptionid + tags: + - subscriptions + requestBody: + description: 'New NotificationSubscription is included as entity body of the request. The allowed data types for subscriptions are defined in clauses 6.3.4 and 6.3.5: + + UserLocationEventSubscription. + + UserLocationPeriodicSubscription.' + content: + application/json: + schema: + type: object + properties: + UserLocationEventSubscription: + $ref: '#/components/schemas/UserLocationEventSubscription' + responses: + '200': + description: 'Upon success, a response body containing data type describing the updated subscription is returned. The allowed data types for subscriptions are defined in clauses 6.3.4 and 6.3.5: + + UserLocationEventSubscription. + + UserLocationPeriodicSubscription.' + content: + application/json: + schema: + type: object + properties: + UserLocationEventSubscription: + $ref: '#/components/schemas/UserLocationEventSubscription' '400': $ref: '#/components/responses/400' '401': @@ -81,27 +237,61 @@ paths: $ref: '#/components/responses/404' '406': $ref: '#/components/responses/406' + '412': + $ref: '#/components/responses/412' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string + delete: + summary: Delete a subscription. + description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription. + operationId: SubscriptionsUsersDELETESubscriptionid + tags: + - subscriptions + responses: + '204': + $ref: '#/components/responses/204' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'queries' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string /queries/zones: get: + summary: Zones information Lookup. + description: The GET method is used to query the information about one or more specific zones or a list of zones. + operationId: QueriesZonesGET tags: - - 'location' - summary: 'Query the information about one or more specific zones or a list of zones.' - description: 'The GET method is used to query the information about one or more specific zones or a list of zones.' - operationId: zonesGET + - queries parameters: - - $ref: '#/components/parameters/Query.ZoneId' + - $ref: '#/components/parameters/Query.zoneId' responses: '200': - description: 'Upon success, a response body containing the list of zone information is returned.' + description: Upon success, a response body containing the list of zone information is returned. content: application/json: schema: type: object properties: - zoneList: + ZoneList: $ref: '#/components/schemas/ZoneList' '400': $ref: '#/components/responses/400' @@ -115,25 +305,22 @@ paths: $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'queries' /queries/zones/{zoneId}: get: + summary: Zones information Lookup. + description: The GET method is used to query the information about a specific zone. + operationId: QueriesZonesGETZoneid tags: - - 'location' - summary: 'Query information about a specific zone' - description: 'The GET method is used to query the information about a specific zone.' - operationId: zoneGetById - parameters: - - $ref: '#/components/parameters/Path.ZoneId' + - queries responses: '200': - description: 'Upon success, a response body containing the zone information is returned.' + description: Upon success, a response body containing the zone information is returned. content: application/json: schema: type: object properties: - zoneInfo: + ZoneInfo: $ref: '#/components/schemas/ZoneInfo' '400': $ref: '#/components/responses/400' @@ -147,26 +334,37 @@ paths: $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'queries' + parameters: + - name: zoneId + in: path + required: true + description: The unique identifier of the zoneId. + schema: + type: string /queries/zones/{zoneId}/accessPoints: get: + summary: Radio Node Location Lookup. + description: The GET method is used to query the information about a specific access point or a list of access points under a zone. + operationId: QueriesZonesAccesspointsGETZoneid tags: - - 'location' - summary: 'Query information about a specific access point or a list of access points under a zone' - description: 'The GET method is used to query the information about a specific access point or a list of access points under a zone.' - operationId: accessPointsGET + - queries parameters: - - $ref: '#/components/parameters/Path.ZoneId' - - $ref: '#/components/parameters/Query.AccessPointId' + - $ref: '#/components/parameters/Query.accessPointId' + - name: zoneId + in: path + required: true + description: The unique identifier of the zoneId. + schema: + type: string responses: '200': - description: 'Upon success, a response body containing the list of access point information is returned.' + description: Upon success, a response body containing the list of access point information is returned. content: application/json: schema: type: object properties: - accessPointList: + AccessPointList: $ref: '#/components/schemas/AccessPointList' '400': $ref: '#/components/responses/400' @@ -180,26 +378,22 @@ paths: $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'queries' /queries/zones/{zoneId}/accessPoints/{accessPointId}: get: + summary: Radio Node Location Lookup. + description: The GET method is used to query the information about a specific access point under a zone. + operationId: QueriesZonesAccesspointsGETZoneidAccesspointid tags: - - 'location' - summary: 'Query information about a specific access point under a zone.' - description: 'The GET method is used to query the information about a specific access point under a zone.' - operationId: accessPointGetById - parameters: - - $ref: '#/components/parameters/Path.ZoneId' - - $ref: '#/components/parameters/Path.AccessPointId' + - queries responses: '200': - description: 'Upon success, a response body containing the access point information is returned.' + description: Upon success, a response body containing the access point information is returned. content: application/json: schema: type: object properties: - accessPointInfo: + AccessPointInfo: $ref: '#/components/schemas/AccessPointInfo' '400': $ref: '#/components/responses/400' @@ -213,35 +407,39 @@ paths: $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'queries' - /subscriptions/area: + parameters: + - name: zoneId + in: path + required: true + description: The unique identifier of the zoneId. + schema: + type: string + - name: accessPointId + in: path + required: true + description: The unique identifier of the accessPointId. + schema: + type: string + /subscriptions/zones: get: + summary: Retrieves all active subscriptions to zone notifications. + description: The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor. + operationId: SubscriptionsZonesGET tags: - - 'location' - summary: 'Retrieves information about the subscriptions for this requestor.' - description: 'The GET method is used to request information about the subscriptions for this requestor.' - operationId: areaSubListGET + - subscriptions parameters: - - $ref: '#/components/parameters/Query.Subscription_type' + - $ref: '#/components/parameters/Query.subscription_type1' + - $ref: '#/components/parameters/Query.zoneId1' responses: '200': - description: "Upon success, a response body containing the list of links to requestor's subscriptions is returned." + description: Upon success, a response body containing the list of links to requestor's subscriptions is returned. content: application/json: schema: type: object - required: - - notificationSubscriptionList properties: - notificationSubscriptionList: + NotificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - examples: - - notificationSubscriptionList: - subscription: - - href: 'http://meAppServer.example.com/location/v2/subscriptions/area/subscription123' - subscriptionType: 'UserAreaSubscription' - resourceURL: - href: 'http://meAppServer.example.com/location/v2/subscriptions/area' '400': $ref: '#/components/responses/400' '401': @@ -255,73 +453,41 @@ paths: '429': $ref: '#/components/responses/429' post: + summary: Creates a subscription to zone notifications. + description: The POST method is used to create a new subscription to zone notifications. Upon success, the response contains entity body describing the created subscription. + operationId: SubscriptionsZonesPOST tags: - - 'location' - summary: 'Creates subscription to area notifications.' - description: 'The POST method is used to create a new subscription to area notifications.' - operationId: areaSubPOST + - subscriptions requestBody: - description: 'Subscription to be created' - required: true + description: 'The entity body in the request contains data type of the specific UE location event subscription that is to be created, where the data type options are listed below and defined in clauses 6.3.6 and 6.3.7: + + ZoneLocationEventSubscription. + + ZoneStatusSubscription.' content: application/json: schema: type: object properties: - userAreaSubscription: - $ref: '#/components/schemas/UserAreaSubscription' - examples: - - userAreaSubscription: - subscriptionType: 'userAreaSubscription' - clientCorrelator: '0123' - callbackReference: 'http://my.callback.com/area_notification/some-id' - _links: - self: - href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123 - areaDefine: - shape: 1 - points: - - latitude: -80.86302 - longitude: 41.277306 - radius: - addressList: - - acr:10.0.0.1 - - acr:10.0.0.2 - trackingAccuracy: 10.99 - expiryDeadline: - seconds: 1973507343 - nanoSeconds": 0 + ZoneLocationEventSubscription: + $ref: '#/components/schemas/ZoneLocationEventSubscription' responses: '201': - description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field.' + description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field. + + + In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type from the list below and as defined in clauses 6.3.6 and 6.3.7: + + ZoneLocationEventSubscription. + + ZoneStatusSubscription.' content: application/json: schema: type: object properties: - userAreaSubscription: - $ref: '#/components/schemas/UserAreaSubscription' - examples: - - userAreaSubscription: - subscriptionType: 'userAreaSubscription' - clientCorrelator: '0123' - callbackReference: 'http://my.callback.com/area_notification/some-id' - _links: - self: - href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123 - areaDefine: - shape: 1 - points: - - latitude: -80.86302 - longitude: 41.277306 - radius: - addressList: - - acr:10.0.0.1 - - acr:10.0.0.2 - trackingAccuracy: 10.99 - expiryDeadline: - seconds: 1973507343 - nanoSeconds": 0 + ZoneLocationEventSubscription: + $ref: '#/components/schemas/ZoneLocationEventSubscription' '400': $ref: '#/components/responses/400' '401': @@ -334,69 +500,52 @@ paths: $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' + '422': + $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' callbacks: notification: - '{$request.body#/userAreaSubscription.callbackReference}': + '{$request.body#/callbackUri}': post: - summary: 'Callback POST used to send a notification' - description: 'Notification from Location service, content based on subscription type' - operationId: areaNotificationPOST + summary: Callback POST used to send a notification + description: Subscription notification + operationId: notificationPOST667656 requestBody: - description: 'Subscription notification' + description: Subscription notification required: true content: application/json: schema: type: object properties: - userAreaNotification: - $ref: '#/components/schemas/UserAreaNotification' - examples: - - userAreaNotification: - notificationType: 'UserAreaNotification' - timestamp: - seconds: 1673507343 - nanoSeconds": 0 - address: 'acr:10.0.0.1' - userLocationEvent: 'ENTERING_AREA_EVENT' - _links: - subscription: - href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123 + subscriptionNotification: + oneOf: + - $ref: '#/components/schemas/ZoneLocationEventSubscription' + - $ref: '#/components/schemas/ZoneStatusSubscription' responses: '204': - $ref: '#/components/responses/204' - x-swagger-router-controller: 'subscriptions' - /subscriptions/area/{subscriptionId}: + description: No content + '404': + description: Not found + parameters: [] + /subscriptions/zones/{subscriptionId}: get: + summary: Retrieve zone subscription information. + description: The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription. + operationId: SubscriptionsZonesGETSubscriptionid tags: - - 'location' - summary: 'Retrieve subscription information' - description: 'The GET method is used to retrieve information about this subscription.' - operationId: areaSubGET - parameters: - - $ref: '#/components/parameters/Path.SubscrId' + - subscriptions responses: '200': - description: 'Upon success, a response body containing data type describing the specific zone subscription is returned.' + description: "Upon success, a response body containing data type describing the specific zone subscription is returned. The allowed data types for subscriptions are defined in clauses\_6.3.6 and 6.3.7:\nZoneLocationEventSubscription.\nZoneStatusSubscription." content: application/json: schema: type: object - required: - - userAreaSubscription properties: - userAreaNotification: - $ref: '#/components/schemas/UserAreaNotification' - examples: - - userAreaNotification: - notificationType: 'UserAreaNotification' - address: 'acr:10.0.0.1' - userLocationEvent: 'ENTERING_AREA_EVENT' - _links: - subscription: - href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123 + ZoneLocationEventSubscription: + $ref: '#/components/schemas/ZoneLocationEventSubscription' '400': $ref: '#/components/responses/400' '401': @@ -409,51 +558,46 @@ paths: $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string put: + summary: Updates a zone subscription information. + description: The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request. + operationId: SubscriptionsZonesPUTSubscriptionid tags: - - 'location' - summary: 'Updates a subscription information' - description: 'The PUT method is used to update the existing subscription.' - operationId: areaSubPUT + - subscriptions requestBody: - description: 'Subscription to be modified' - required: true + description: 'New NotificationSubscription is included as entity body of the request. The allowed data types for subscriptions are defined in clauses 6.3.6 and 6.3.7: + + ZoneLocationEventSubscription. + + ZoneStatusSubscription.' content: application/json: schema: type: object properties: - userAreaNotification: - $ref: '#/components/schemas/UserAreaNotification' - examples: - - userAreaNotification: - notificationType: 'UserAreaNotification' - address: 'acr:10.0.0.1' - userLocationEvent: 'ENTERING_AREA_EVENT' - _links: - subscription: - href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123 - parameters: - - $ref: '#/components/parameters/Path.SubscrId' + ZoneLocationEventSubscription: + $ref: '#/components/schemas/ZoneLocationEventSubscription' responses: '200': - description: 'Upon success, a response body containing data type describing the updated subscription is returned.' + description: 'Upon success, a response body containing data type describing the updated subscription is returned. The allowed data types for subscriptions are defined in clauses 6.3.6 and 6.3.7: + + ZoneLocationEventSubscription. + + ZoneStatusSubscription.' content: application/json: schema: type: object properties: - userAreaNotification: - $ref: '#/components/schemas/UserAreaNotification' - examples: - - userAreaNotification: - notificationType: 'UserAreaNotification' - address: 'acr:10.0.0.1' - userLocationEvent: 'ENTERING_AREA_EVENT' - _links: - subscription: - href: http://meAppServer.example.com/location/v2/subscriptions/area/subscription123 + ZoneLocationEventSubscription: + $ref: '#/components/schemas/ZoneLocationEventSubscription' '400': $ref: '#/components/responses/400' '401': @@ -470,15 +614,19 @@ paths: $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string delete: + summary: Cancel a zone subscription. + description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription. + operationId: SubscriptionsZonesDELETESubscriptionid tags: - - 'location' - summary: 'Cancel a subscription' - description: 'The DELETE method is used to cancel the existing subscription.' - operationId: areaSubDELETE - parameters: - - $ref: '#/components/parameters/Path.SubscrId' + - subscriptions responses: '204': $ref: '#/components/responses/204' @@ -490,87 +638,107 @@ paths: $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string + /queries/distance: + get: + summary: UE Distance Lookup of a specific UE. + description: The GET method is used to query information about distance from a user to a location or between two users. + operationId: QueriesDistanceGET + tags: + - queries + parameters: + - $ref: '#/components/parameters/Query.address2' + - $ref: '#/components/parameters/Query.location' + responses: + '200': + description: Upon success, a response body containing the list of distance information is returned. + content: + application/json: + schema: + type: object + properties: + TerminalDistance: + $ref: '#/components/schemas/TerminalDistance' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' /subscriptions/distance: get: + summary: Retrieves all active subscriptions to distance change notifications. + description: The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor. + operationId: SubscriptionsDistanceGET tags: - - 'location' - summary: 'Retrieves all active subscriptions to distance change notifications' - description: 'This operation is used for retrieving all active subscriptions to a distance change notifications.' - operationId: distanceSubListGET + - subscriptions responses: '200': - description: "Upon success, a response body containing the list of links to requestor's subscriptions is returned." + description: Upon success, a response body containing the list of links to requestor's subscriptions is returned. content: application/json: schema: type: object - required: - - notificationSubscriptionList properties: - notificationSubscriptionList: + NotificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - examples: - - notificationSubscriptionList: - subscription: - - href: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123' - subscriptionType: 'UserDistanceSubscription' - resourceURL: - href: 'http://meAppServer.example.com/location/v2/subscriptions/distance' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + parameters: [] post: + summary: Creates a subscription for distance change notification. + description: The POST method is used to create a new subscription to user distance notifications. Upon success, the response contains entity body describing the created subscription. + operationId: SubscriptionsDistancePOST tags: - - 'location' - summary: 'Creates a subscription for distance change notification' - description: 'Creates a subscription to the Location Service for a distance change notification.' - operationId: distanceSubPOST + - subscriptions requestBody: - description: 'The POST method is used to create a new subscription to user distance notifications.' - required: true + description: 'The entity body in the request contains data type of the user distance subscription that is to be created, where the data type options are listed below and defined in clause 6.3.9: + + UserDistanceSubscription.' content: application/json: schema: type: object properties: - userDistanceSubscription: + UserDistanceSubscription: $ref: '#/components/schemas/UserDistanceSubscription' - examples: - - userDistanceSubscription: - subscriptionType: 'UserDistanceSubscription' - clientCorrelator: '0123' - callbackReference: 'http://my.callback.com/user-distance/some-id' - referenceAddress: - - 'acr:10.0.0.3' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - distance: 100 - trackingAccuracy: 10 - criteria: 'AllWithinDistance' - checkImmediate: true responses: '201': - description: 'Successful subscription' + description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field. + + + In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type from the list below and as defined in clause 6.3.9: + + UserDistanceSubscription.' content: application/json: schema: type: object properties: - userDistanceSubscription: + UserDistanceSubscription: $ref: '#/components/schemas/UserDistanceSubscription' - examples: - - userDistanceSubscription: - subscriptionType: 'UserDistanceSubscription' - clientCorrelator: '0123' - callbackReference: 'http://my.callback.com/user-distance/some-id' - referenceAddress: - - 'acr:10.0.0.3' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - distance: 100 - trackingAccuracy: 10 - criteria: 'AllWithinDistance' - checkImmediate: true '400': $ref: '#/components/responses/400' '401': @@ -589,79 +757,46 @@ paths: $ref: '#/components/responses/429' callbacks: notification: - '{$request.body#/userDistanceSubscription.callbackReference}': + '{$request.body#/callbackUri}': post: - summary: 'Callback POST used to send a notification' - description: 'Notification from Location service, content based user distance subscription type' - operationId: distanceNotificationPOST + summary: Callback POST used to send a notification + description: Subscription notification + operationId: notificationPOST197708 requestBody: - description: 'User Distance Notification' + description: Subscription notification required: true content: application/json: schema: type: object properties: - userDistanceNotification: - $ref: '#/components/schemas/UserDistanceNotification' - examples: - - userDistanceNotification: - notificationType: 'UserDistanceNotification' - timestamp: - seconds: 1673507343 - nanoSeconds": 0 - monitoredUsers: - - user: - address: 'acr:10.0.0.1' - accessPointId: '001010000000000000000000000000001' - zoneId: 'zone01' - timestamp: - seconds: 1673507343 - nanoSeconds": 0 - resourceURL: 'http://meAppServer.example.com/location/v3/queries/users' - distanceEvent: 'AllWithinDistance' - _links: - subscription: - href: 'http://meAppServer.example.com/location/v3/subscriptions/distance/subscription123' + subscriptionNotification: + $ref: '#/components/schemas/UserDistanceSubscription' responses: '204': - $ref: '#/components/responses/204' - x-swagger-router-controller: 'subscriptions' + description: No content + '404': + description: Not found + parameters: [] /subscriptions/distance/{subscriptionId}: get: + summary: Retrieve user distance subscription information. + description: The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription. + operationId: SubscriptionsDistanceGETSubscriptionid tags: - - 'location' - summary: 'Retrieve user distance subscription information' - description: 'The GET method is used to retrieve information about user distance subscription subscription.' - operationId: distanceSubGET - parameters: - - $ref: '#/components/parameters/Path.SubscrId' + - subscriptions responses: '200': - description: 'Upon success, a response body containing data type describing the specific distance event subscription is returned.' + description: 'Upon success, a response body containing data type describing the specific distance event subscription is returned. The allowed data types for subscriptions are defined in clause 6.3.9: + + UserDistanceSubscription.' content: application/json: schema: type: object - required: - - UserDistanceSubscription properties: - userDistanceSubscription: + UserDistanceSubscription: $ref: '#/components/schemas/UserDistanceSubscription' - examples: - - userDistanceSubscription: - subscriptionType: 'UserDistanceSubscription' - clientCorrelator: '0123' - callbackReference: 'http://my.callback.com/user-distance/some-id' - referenceAddress: - - 'acr:10.0.0.3' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - distance: 100 - trackingAccuracy: 10 - criteria: 'AllWithinDistance' - checkImmediate: true '400': $ref: '#/components/responses/400' '401': @@ -674,63 +809,42 @@ paths: $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string put: + summary: Updates a user distance subscription information. + description: The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request. + operationId: SubscriptionsDistancePUTSubscriptionid tags: - - 'location' - summary: 'Updates a user distance subscription information' - description: 'The PUT method is used to update the existing user distance subscription.' - operationId: distanceSubPUT + - subscriptions requestBody: - description: 'Subscription to be modified' - required: true + description: 'New NotificationSubscription is included as entity body of the request. The allowed data types for subscriptions are defined in clause 6.3.9: + + UserDistanceSubscription.' content: application/json: schema: type: object properties: - userDistanceSubscription: + UserDistanceSubscription: $ref: '#/components/schemas/UserDistanceSubscription' - examples: - - userDistanceSubscription: - subscriptionType: 'UserDistanceSubscription' - clientCorrelator: '0123' - callbackReference: 'http://my.callback.com/user-distance/some-id' - referenceAddress: - - 'acr:10.0.0.3' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - distance: 100 - trackingAccuracy: 10 - criteria: 'AllWithinDistance' - checkImmediate: true - parameters: - - $ref: '#/components/parameters/Path.SubscrId' responses: '200': - description: 'Upon success, a response body containing data type describing the updated subscription is returned.' + description: 'Upon success, a response body containing data type describing the updated subscription is returned. The allowed data types for subscriptions are defined in clause 6.3.9: + + UserDistanceSubscription.' content: application/json: schema: type: object properties: - userDistanceSubscription: + UserDistanceSubscription: $ref: '#/components/schemas/UserDistanceSubscription' - examples: - - userDistanceSubscription: - subscriptionType: 'UserDistanceSubscription' - clientCorrelator: '0123' - callbackReference: 'http://my.callback.com/user-distance/some-id' - referenceAddress: - - 'acr:10.0.0.3' - monitoredAddress: - - 'acr:10.0.0.1' - - 'acr:10.0.0.2' - distance: 100 - trackingAccuracy: 10 - criteria: 'AllWithinDistance' - checkImmediate: true '400': $ref: '#/components/responses/400' '401': @@ -747,15 +861,19 @@ paths: $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string delete: + summary: Cancel a subscription. + description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription. + operationId: SubscriptionsDistanceDELETESubscriptionid tags: - - 'location' - summary: 'Cancel a subscription' - description: 'The DELETE method is used to cancel the existing subscription.' - operationId: distanceSubDELETE - parameters: - - $ref: '#/components/parameters/Path.SubscrId' + - subscriptions responses: '204': $ref: '#/components/responses/204' @@ -767,38 +885,32 @@ paths: $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' - /subscriptions/users: + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string + /subscriptions/area: get: + summary: Retrieves information about the subscriptions for this requestor. + description: The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor. + operationId: SubscriptionsAreaGET tags: - - 'location' - summary: 'Retrieves information about the subscriptions for the requestor' - description: 'The GET method is used to request information about the subscriptions for the requestor. ' - operationId: userSubListGET + - subscriptions parameters: - - $ref: '#/components/parameters/Query.Subscription_type_2' - - $ref: '#/components/parameters/Query.Address_2' + - $ref: '#/components/parameters/Query.subscription_type2' responses: '200': - description: "Upon success, a response body containing the list of links to requestor's subscriptions is returned." + description: Upon success, a response body containing the list of links to requestor's subscriptions is returned. content: application/json: schema: type: object - required: - - notificationSubscriptionList properties: - notificationSubscriptionList: + NotificationSubscriptionList: $ref: '#/components/schemas/NotificationSubscriptionList' - examples: - - notificationSubscriptionList: - subscription: - - href: 'http://meAppServer.example.com/location/v2/subscriptions/users/subscription123' - subscriptionType: 'UserLocationEventSubscription' - - href: 'http://meAppServer.example.com/location/v2/subscriptions/users/subscription456' - subscriptionType: 'UserLocationPeriodicSubscription' - resourceURL: - href: 'http://meAppServer.example.com/location/v2/subscriptions/users' '400': $ref: '#/components/responses/400' '401': @@ -812,304 +924,37 @@ paths: '429': $ref: '#/components/responses/429' post: + summary: Creates subscription to area notifications. + description: The POST method is used to create a new subscription to area notifications. Upon success, the response contains entity body describing the created subscription. + operationId: SubscriptionsAreaPOST tags: - - 'location' - summary: 'Create subscription to UE location notifications.' - description: 'The POST method is used to create a new subscription to UE location notifications.' - operationId: userSubPOST + - subscriptions requestBody: - description: 'Subscription to be created' - required: true + description: 'The entity body in the request contains data type of the specific UE location event subscription that is to be created, where the data type options are listed below and defined in clause 6.3.8: + + UserAreaSubscription.' content: application/json: schema: type: object properties: - userLocationEventSubscription: - $ref: '#/components/schemas/UserLocationEventSubscription' - userLocationPeriodicSubscription: - $ref: '#/components/schemas/UserLocationPeriodicSubscription' - examples: - - userLocationEventSubscription: - subscriptionType: 'UserLocationEventSubscription' - callbackReference: 'http://my.callback.com/user-location-notification/some-id' - address: 'acr:10.0.0.1' - locationEventCriteria: - - ENTERING_AREA_EVENT + UserAreaSubscription: + $ref: '#/components/schemas/UserAreaSubscription' responses: '201': - description: 'Indicates successful subscription creation.' - content: - application/json: - schema: - type: object - properties: - userLocationEventSubscription: - $ref: '#/components/schemas/UserLocationEventSubscription' - userLocationPeriodicSubscription: - $ref: '#/components/schemas/UserLocationPeriodicSubscription' - examples: - - userLocationEventSubscription: - subscriptionType: 'UserLocationEventSubscription' - callbackReference: 'http://my.callback.com/user-location-notification/some-id' - address: 'acr:10.0.0.1' - locationEventCriteria: - - ENTERING_AREA_EVENT - '400': - $ref: '#/components/responses/400' - '401': - $ref: '#/components/responses/401' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '406': - $ref: '#/components/responses/406' - '429': - $ref: '#/components/responses/429' - callbacks: - notification: - '{$request.body#/userLocationEventSubscription.callbackReference}': - post: - summary: 'Callback POST used to send a notification' - description: 'Notification from Location service, content based on subscription type' - operationId: userNotificationPOST - requestBody: - description: 'User LocationEvent Notification' - required: true - content: - application/json: - schema: - type: object - properties: - userLocationEventNotification: - $ref: '#/components/schemas/UserLocationEventNotification' - userLocationPeriodicNotification: - $ref: '#/components/schemas/UserLocationPeriodicNotification' - examples: - - userLocationEventNotification: - notificationType: 'UserLocationEventNotification' - timestamp: - seconds: 1673507343 - nanoseconds: 0 - address: 'acr:10.0.0.1' - userLocationEvent: 'ENTERING_AREA_EVENT' - zoneId: 'zone01' - accessPointId: '001010000000000000000000000000001' - _links: - subscription: - href: "http://meAppServer.example.com/location/v3/subscriptions/user/subscription123" - responses: - '204': - $ref: '#/components/responses/204' - x-swagger-router-controller: 'subscriptions' - /subscriptions/users/{subscriptionId}: - get: - tags: - - 'location' - summary: 'Retrieve subscription information' - description: 'The GET method is used to retrieve information about this subscription. ' - operationId: userSubGET - parameters: - - $ref: '#/components/parameters/Path.SubscrId' - responses: - '200': - description: 'Upon success, a response body containing data type describing the specific Location event subscription is returned.' - content: - application/json: - schema: - type: object - required: - - UserLocationEventSubscription - properties: - userLocationEventSubscription: - $ref: '#/components/schemas/UserLocationEventSubscription' - userLocationPeriodicSubscription: - $ref: '#/components/schemas/UserLocationPeriodicSubscription' - examples: - - userLocationEventSubscription: - subscriptionType: 'UserLocationEventSubscription' - callbackReference: 'http://my.callback.com/user-location-notification/some-id' - address: 'acr:10.0.0.1' - locationEventCriteria: - - ENTERING_AREA_EVENT - '400': - $ref: '#/components/responses/400' - '401': - $ref: '#/components/responses/401' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '406': - $ref: '#/components/responses/406' - '429': - $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' - put: - tags: - - 'location' - summary: 'Updates a subscription information' - description: 'The PUT method is used to update the existing subscription.' - operationId: userSubPUT - requestBody: - description: 'Subscription to be modified' - required: true - content: - application/json: - schema: - type: object - properties: - userLocationEventSubscription: - $ref: '#/components/schemas/UserLocationEventSubscription' - userLocationPeriodicSubscription: - $ref: '#/components/schemas/UserLocationPeriodicSubscription' - examples: - - userLocationEventSubscription: - subscriptionType: 'UserLocationEventSubscription' - callbackReference: 'http://my.callback.com/user-location-notification/some-id' - address: 'acr:10.0.0.1' - locationEventCriteria: - - ENTERING_AREA_EVENT - parameters: - - $ref: '#/components/parameters/Path.SubscrId' - responses: - '200': - description: 'Upon success, a response body containing data type describing the updated subscription is returned. ' - content: - application/json: - schema: - type: object - properties: - userLocationEventSubscription: - $ref: '#/components/schemas/UserLocationEventSubscription' - userLocationPeriodicSubscription: - $ref: '#/components/schemas/UserLocationPeriodicSubscription' - examples: - - userLocationEventSubscription: - subscriptionType: 'UserLocationEventSubscription' - callbackReference: 'http://my.callback.com/user-location-notification/some-id' - address: 'acr:10.0.0.1' - locationEventCriteria: - - ENTERING_AREA_EVENT - '400': - $ref: '#/components/responses/400' - '401': - $ref: '#/components/responses/401' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '406': - $ref: '#/components/responses/406' - '412': - $ref: '#/components/responses/412' - '422': - $ref: '#/components/responses/422' - '429': - $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' - delete: - tags: - - 'location' - summary: 'Cancel a subscription' - description: 'The DELETE method is used to cancel the existing subscription.' - operationId: userSubDELETE - parameters: - - $ref: '#/components/parameters/Path.SubscrId' - responses: - '204': - $ref: '#/components/responses/204' - '401': - $ref: '#/components/responses/401' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '429': - $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' - /subscriptions/zones: - get: - tags: - - 'location' - summary: 'Retrieves all active subscriptions to zone notifications' - description: 'This operation is used for retrieving all active subscriptions to zone notifications.' - operationId: zoneSubListGET - parameters: - - $ref: '#/components/parameters/Query.Subscription_type_3' - - $ref: '#/components/parameters/Query.ZoneId_2' - responses: - '200': - description: "Upon success, a response body containing the list of links to requestor's subscriptions is returned." - content: - application/json: - schema: - type: object - required: - - notificationSubscriptionList - properties: - notificationSubscriptionList: - $ref: '#/components/schemas/NotificationSubscriptionList' - examples: - - notificationSubscriptionList: - subscription: - - href: 'http://meAppServer.example.com/location/v2/subscriptions/zones/subscription123' - subscriptionType: 'ZoneLocationEventSubscription' - - href: 'http://meAppServer.example.com/location/v2/subscriptions/zones/subscription456' - subscriptionType: 'ZoneStatusSubscription' - resourceURL: - href: 'http://meAppServer.example.com/location/v2/subscriptions/zones' - post: - tags: - - 'location' - summary: 'Creates a subscription to zone notifications' - description: 'The POST method is used to create a new subscription to zone notifications.' - operationId: zoneSubPOST - requestBody: - description: 'Subscription to be created' - required: true - content: - application/json: - schema: - type: object - properties: - zoneLocationEventSubscription: - $ref: '#/components/schemas/ZoneLocationEventSubscription' - zoneStatusSubscription: - $ref: '#/components/schemas/ZoneStatusSubscription' - examples: - - zoneLocationEventSubscription: - subscriptionType: 'ZoneLocationEventSubscription' - callbackReference: 'http://my.callback.com/zone-notification/some-id' - zoneId: 'zone01' - locationEventCriteria: - - ENTERING_AREA_EVENT - expiryDeadline": - seconds: 1977836800 - nanoseconds": 0 - responses: - '201': - description: 'Indicates successful resource creation' + description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field. + + + In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type from the list below and as defined in clause 6.3.8: + + UserAreaSubscription.' content: application/json: schema: type: object properties: - zoneLocationEventSubscription: - $ref: '#/components/schemas/ZoneLocationEventSubscription' - zoneStatusSubscription: - $ref: '#/components/schemas/ZoneStatusSubscription' - examples: - - zoneLocationEventSubscription: - subscriptionType: 'ZoneLocationEventSubscription' - callbackReference: 'http://my.callback.com/zone-notification/some-id' - zoneId: 'zone01' - locationEventCriteria: - - ENTERING_AREA_EVENT - expiryDeadline": - seconds: 1977836800 - nanoseconds": 0 + UserAreaSubscription: + $ref: '#/components/schemas/UserAreaSubscription' '400': $ref: '#/components/responses/400' '401': @@ -1128,72 +973,44 @@ paths: $ref: '#/components/responses/429' callbacks: notification: - '{$request.body#/zoneLocationEventSubscription.callbackReference}': + '{$request.body#/callbackUri}': post: - summary: 'Callback POST used to send a notification' - description: 'Notification from Location service, content based on subscription type' - operationId: zoneNotificationPOST + summary: Callback POST used to send a notification + description: Subscription notification + operationId: notificationPOST179890 requestBody: - description: 'Subscription notification' + description: Subscription notification required: true content: application/json: schema: type: object properties: - zoneLocationEventNotification: - $ref: '#/components/schemas/ZoneLocationEventNotification' - zoneStatusNotification: - $ref: '#/components/schemas/ZoneStatusNotification' - examples: - - zoneLocationEventNotification: - notificationType: 'ZoneLocationEventNotification' - timestamp: - seconds: 1673507343 - nanoseconds: 0 - address: 'acr:10.0.0.1' - zoneId: 'zone01' - _links: - subscription: - href: "http://meAppServer.example.com/location/v3/subscriptions/zone/subscription123" + subscriptionNotification: + $ref: '#/components/schemas/UserAreaSubscription' responses: '204': - $ref: '#/components/responses/204' - x-swagger-router-controller: 'subscriptions' - /subscriptions/zones/{subscriptionId}: + description: No content + '404': + description: Not found + parameters: [] + /subscriptions/area/{subscriptionId}: get: + summary: Retrieve subscription information. + description: The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription. + operationId: SubscriptionsAreaGETSubscriptionid tags: - - 'location' - summary: 'Retrieve zone subscription information' - description: 'The GET method is used to retrieve information about zone subscription. ' - operationId: zoneSubGET - parameters: - - $ref: '#/components/parameters/Path.SubscrId' + - subscriptions responses: '200': - description: 'Upon success, a response body containing data type describing the specific zone subscription is returned.' + description: "Upon success, a response body containing data type describing the specific zone subscription is returned. The allowed data types for subscriptions are defined in clause\_6.3.8:\nUserAreaSubscription." content: application/json: schema: type: object - required: - - zoneLocationEventSubscription - - zoneStatusSubscription properties: - zoneLocationEventSubscription: - $ref: '#/components/schemas/ZoneLocationEventSubscription' - zoneStatusSubscription: - $ref: '#/components/schemas/ZoneStatusSubscription' - examples: - - zoneLocationEventSubscription: - subscriptionType: 'ZoneLocationEventSubscription' - callbackReference: 'http://my.callback.com/zone-notification/some-id' - zoneId: 'zone01' - locationEventCriteria: - - ENTERING_AREA_EVENT - expiryDeadline": - seconds: 1977836800 - nanoseconds": 0 + UserAreaSubscription: + $ref: '#/components/schemas/UserAreaSubscription' '400': $ref: '#/components/responses/400' '401': @@ -1206,59 +1023,42 @@ paths: $ref: '#/components/responses/406' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string put: + summary: Updates a subscription information. + description: The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request. + operationId: SubscriptionsAreaPUTSubscriptionid tags: - - 'location' - summary: 'Updates a zone subscription information' - description: 'The PUT method is used to update the existing zone subscription.' - operationId: zoneSubPUT + - subscriptions requestBody: - description: 'Subscription to be modified' - required: true + description: 'New NotificationSubscription is included as entity body of the request. The allowed data types for subscriptions are defined in clause 6.3.8: + + UserAreaSubscription.' content: application/json: schema: type: object properties: - zoneLocationEventSubscription: - $ref: '#/components/schemas/ZoneLocationEventSubscription' - zoneStatusSubscription: - $ref: '#/components/schemas/ZoneStatusSubscription' - examples: - - zoneLocationEventSubscription: - subscriptionType: 'ZoneLocationEventSubscription' - callbackReference: 'http://my.callback.com/zone-notification/some-id' - zoneId: 'zone01' - locationEventCriteria: - - ENTERING_AREA_EVENT - expiryDeadline": - seconds: 1977836800 - nanoseconds": 0 - parameters: - - $ref: '#/components/parameters/Path.SubscrId' + UserAreaSubscription: + $ref: '#/components/schemas/UserAreaSubscription' responses: '200': - description: 'Upon success, a response body containing data type describing the updated subscription is returned.' + description: 'Upon success, a response body containing data type describing the updated subscription is returned. The allowed data types for subscriptions are defined in clause 6.3.8: + + UserAreaSubscription.' content: application/json: schema: type: object properties: - zoneLocationEventSubscription: - $ref: '#/components/schemas/ZoneLocationEventSubscription' - zoneStatusSubscription: - $ref: '#/components/schemas/ZoneStatusSubscription' - examples: - - zoneLocationEventSubscription: - subscriptionType: 'ZoneLocationEventSubscription' - callbackReference: 'http://my.callback.com/zone-notification/some-id' - zoneId: 'zone01' - locationEventCriteria: - - ENTERING_AREA_EVENT - expiryDeadline": - seconds: 1977836800 - nanoseconds": 0 + UserAreaSubscription: + $ref: '#/components/schemas/UserAreaSubscription' '400': $ref: '#/components/responses/400' '401': @@ -1275,15 +1075,19 @@ paths: $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string delete: + summary: Cancel a subscription. + description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription. + operationId: SubscriptionsAreaDELETESubscriptionid tags: - - 'location' - summary: 'Cancel a zone subscription' - description: 'The DELETE method is used to cancel the existing zone subscription.' - operationId: zoneSubDELETE - parameters: - - $ref: '#/components/parameters/Path.SubscrId' + - subscriptions responses: '204': $ref: '#/components/responses/204' @@ -1295,1315 +1099,637 @@ paths: $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' - x-swagger-router-controller: 'subscriptions' + parameters: + - name: subscriptionId + in: path + required: true + description: The unique identifier of the subscriptionId. + schema: + type: string components: - responses: - '200': - description: 'OK' - '204': - description: 'No Content' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '404': - description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '406': - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '412': - description: - 'Precondition failed : used when a condition has failed during conditional requests, e.g. when - using ETags to avoid write conflicts when using PUT' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '414': - description: - 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is - longer than the server is willing or able to process.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '415': - description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '422': - description: - 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the - syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an - JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This - error condition can also occur if the capabilities required by the request are not supported.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - parameters: - Path.AccessPointId: - name: accessPointId - in: path - description: 'Identifier of access Point' - required: true - schema: - type: string - x-exportParamName: AccessPointId - Path.SubscrId: - name: subscriptionId - in: path - description: 'Subscription Identifier, specifically the "self" returned in the subscription request' - required: true - schema: - type: string - format: uri - x-exportParamName: SubscriptionId - Path.ZoneId: - name: zoneId - in: path - description: 'Indentifier of zone' - required: true - schema: - type: string - x-exportParamName: ZoneId - Query.Subscription_type: - name: subscription_type - in: query - description: "Query parameter to filter on a specific subscription type. Permitted values: - event" - required: false - schema: - type: string - x-exportParamName: Subscription_type - Query.Subscription_type_2: - name: subscription_type - in: query - description: "Query parameter to filter on a specific subscription type. Permitted values: - -event - -periodic" - required: false - schema: - type: string - x-exportParamName: Subscription_type_2 - Query.Subscription_type_3: - name: subscription_type - in: query - description: "Query parameter to filter on a specific subscription type. Permitted values: - -event - -status" - required: false - schema: - type: string - x-exportParamName: Subscription_type_3 - Query.AccessPointId: - name: accessPointId - in: query - description: Identifier of access point - required: false - schema: - type: array - items: + schemas: + ProblemDetails: + type: object + properties: + type: type: string - x-exportParamName: AccessPointId - Query.Address: - name: address - in: query - description: One or two addresses of user to check. - The second "address" parameter shall not be included when the distance between a user and a location is requested. - The second "address" parameter shall be included when a location is not provided. - required: false - schema: - type: array - items: + format: uri + description: A URI reference according to IETF RFC 3986 that identifies the problem type + title: type: string - x-exportParamName: Address - Query.Address_2: - name: address - in: query - description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). - required: false - schema: - type: string - x-exportParamName: Address_2 - Query.Address_3: - name: address - in: query - description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). - required: false - schema: - type: array - items: - type: string - x-exportParamName: Address_3 - Query.Location: - name: location - in: query - description: Shall not be included when the distance between two terminals is requested. - required: false - schema: - type: object - properties: - latitude: - description: "Location latitude, expressed in the range -90\xB0 to +90\xB0." - format: float - type: number - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float - longitude: - description: "Location longitude, expressed in the range -180\xB0 to +180\xB0." - format: float - type: number - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float - x-exportParamName: Location - Query.ZoneId: - name: zoneId - in: query - description: Identifier of zone - required: false - schema: - type: array - items: - type: string - x-exportParamName: ZoneId - Query.ZoneId_2: - name: zoneId - in: query - description: The identity of the zone - required: false - schema: - type: string - x-exportParamName: ZoneId_2 - schemas: - AccessPointInfo: - description: A type containing access point information. - properties: - accessPointId: - description: Identifier of access point. - type: string - x-etsi-mec-cardinality: 1 - x-etsi-mec-origin-type: string - connectionType: - $ref: '#/components/schemas/ConnectionType' - interestRealm: - description: Interest realm of access point. - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: string - locationInfo: - $ref: '#/components/schemas/LocationInfo' - numberOfUsers: - description: Number of users currently on the access point. + description: A short, human-readable summary of the problem type + status: type: integer - x-etsi-mec-cardinality: 1 - x-etsi-mec-origin-type: integer - operationStatus: - $ref: '#/components/schemas/OperationStatus' - resourceURL: - description: Self referring URL + format: uint32 + description: The HTTP status code for this occurrence of the problem + detail: type: string - x-etsi-mec-cardinality: 1 - x-etsi-mec-origin-type: anyURI - timezone: - description: Time zone of access point. + description: A human-readable explanation specific to this occurrence of the problem + instance: type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: dateTimeStamp - required: - - accessPointId - - connectionType - - operationStatus - - numberOfUsers - - resourceURL - type: object - + format: uri + description: A URI reference that identifies the specific occurrence of the problem OperationStatus: - description: An enumeration defining the operations status of an access point. + type: string enum: - - Serviceable - - Unserviceable - - Unknown + - Serviceable + - Unserviceable + - Unknown + PeriodicEventInfo: + x-etsi-notes: "NOTE 3:\tAs specified in [17], clause 6.1.6.2.24." + LocationEventType: + x-etsi-ref: 8.1.6.3 type: string - + enum: + - ENTERING_AREA_EVENT + - LEAVING_AREA_EVENT + x-etsi-mec-extensible: true + x-etsi-mec-enumeration-table: + - value: ENTERING_AREA_EVENT + description: Entering area reporting event. + - value: LEAVING_AREA_EVENT + description: Leaving area reporting event. + CivicAddress: + x-etsi-notes: "NOTE 3:\tAs specified in [17], clause 6.1.6.2.14." + NotificationResult: + x-etsi-notes: "NOTE 3:\tIf the result is SUCCESS, at least one of locationInfo, civicInfo and relativeLocationInfo shall be present. " + OccurrenceInfo: + x-etsi-notes: "NOTE 2:\tAs specified in [17], clause 6.1.6.3.16." AccessPointList: description: A type containing list of access points. + type: object + required: + - zoneId + - resourceURL properties: + zoneId: + description: Identifier of zone + type: string accessPoint: description: Collection of the access point information list. + type: array 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: - - zoneId - - resourceURL - type: object - ConnectionType: - description: This enumeration represents the connection type of an access point - enum: - - LTE - - Wifi - - Wimax - - 5G NR - - UNKNOWN + description: The connection type for the access point type: string - - LocationInfo: + enum: + - LTE + - "Wi-Fi\xAE" + - "WiMAX\xAE" + - 5G NR + - UNKNOWN + AccessPointInfo: + description: A type containing access point information. + type: object + required: + - accessPointId + - connectionType + - operationStatus + - numberOfUsers + - resourceURL properties: - accuracy: - description: Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [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: - description: Altitude accuracy/uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4. - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: UnsignedInt - accuracySemiMinor: - description: Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [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: - 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 [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." - format: float - items: - 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." - format: float - items: - 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: - description: "Angle of orientation of the major axis, expressed in the range 0\xB0 to 180\xB0, as defined in [14]. Present only if \"shape\" equals 4 or 6." - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: UnsignedInt - shape: - description: 'Shape information, as detailed in [14], associated with the reported location coordinate: - 1 = Ellipsoid_Arc - 2 = ellipsoid_Point - 3 = ellipsoid_Point_Altitude - 4 = ellipsoid_Point_Altitude_Uncert_Ellipsoid - 5 = ellipsoid_Point_Uncert_Circle - 6 = ellipsoid_Point_Uncert_Ellipse - 7 = polygon' - enum: - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - - 7 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum_inlined - uncertaintyRadius: - description: Present only if "shape" equals 6. + accessPointId: + description: Identifier of access point. + type: string + locationInfo: + $ref: '#/components/schemas/LocationInfo' + description: The coordinates of the access point. + connectionType: + $ref: '#/components/schemas/ConnectionType' + description: Connection type of access point. + operationStatus: + $ref: '#/components/schemas/OperationStatus' + description: Operation status of access point. + numberOfUsers: + description: Number of users currently on the access point. type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: UnsignedInt - velocity: - $ref: '#/components/schemas/Velocity' - required: - - latitude - - longitude - - shape + timezone: + description: Time zone of access point. + type: string + interestRealm: + description: Interest realm of access point. + type: string + resourceURL: + description: Self referring URL + type: string + ZoneInfo: + description: A type containing zone information. type: object - x-etsi-ref: 6.5.3 - - Velocity: - description: "Structure with attributes relating to the target entity\u2019s velocity, as defined in [14]." + required: + - zoneId + - numberOfAccessPoints + - numberOfUnserviceableAccessPoints + - numberOfUsers + - resourceURL properties: - bearing: - description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in [14]." - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UnsignedInt - horizontalSpeed: - description: Horizontal speed, expressed in km/h and defined in [14]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UnsignedInt - uncertainty: - description: Horizontal uncertainty, as defined in [14]. Present only if "velocityType" equals 3 or 4. - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: UnsignedInt - velocityType: - description: 'Velocity information, as detailed in [14], associated with the reported location coordinate: - 1 = Horizontal - 2 = Horizontal_Vertical - 3 = Horizontal_Uncert - 4 = Horizontal_Vertical_Uncert' - enum: - - 1 - - 2 - - 3 - - 4 + zoneId: + description: Identifier of zone + type: string + numberOfAccessPoints: + description: The number of access points within the zone type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum_inlined - verticalSpeed: - description: Vertical speed, expressed in km/h and defined in [14]. Present only if "velocityType" equals 2 or 4. + numberOfUnserviceableAccessPoints: + description: Number of inoperable access points within the zone. type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Int - verticalUncertainty: - description: Vertical uncertainty, as defined in [14]. Present only if "velocityType" equals 4. + numberOfUsers: + description: The number of users currently on the access point. 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) - - NotificationSubscriptionList: - description: This type contains a list of subscriptions. - properties: resourceURL: - $ref: '#/components/schemas/LinkType' - subscription: - items: - $ref: '#/components/schemas/Subscription' - type: array + description: Self referring URL + type: string + ZoneList: + description: A type containing a list of zones. + type: object required: - resourceURL - type: object - x-etsi-ref: 6.3.3 - - 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 + zone: + description: Collection of the zone information list. + type: array + items: + $ref: '#/components/schemas/ZoneInfo' + resourceURL: + description: Self referring URL type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI - type: object - TerminalDistance: 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. + type: object + required: + - distance 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: $ref: '#/components/schemas/TimeStamp' - required: - - distance - type: object - + description: Date and time that location from which distance is calculated was collected. + DistanceCriteria: + type: string + enum: + - AllWithinDistance = 'All monitored devices are within the specified distance' + - AnyWithinDistance = 'Any of monitored devices gets within the specified distance' + - AllBeyondDistance = 'All monitored devices are beyond the specified distance' + - AnyBeyondDistance = 'Any of monitored devices gets beyond the specified distance' TerminalLocation: description: A type containing device address, retrieval status and location information. - properties: - address: + type: object + required: + - address + - locationRetrievalStatus + properties: + address: 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 + locationRetrievalStatus: + $ref: '#/components/schemas/RetrievalStatus' + description: Status of retrieval for this terminal address. currentLocation: $ref: '#/components/schemas/LocationInfo' + description: Location of terminal. errorInformation: $ref: '#/components/schemas/ServiceError' - locationRetrievalStatus: - $ref: '#/components/schemas/RetrievalStatus' - required: - - address - - locationRetrievalStatus - type: object - + description: This is the reason for error. RetrievalStatus: - enum: - - Retrieved - - NotRetrieved - - Error type: string - + enum: + - Retrieved + - NotRetrieved + - Error ServiceError: - description: Used to indicate a notification termination or cancellation. + description: used to indicate a notification termination or cancellation. + type: object + required: + - messageId + - text 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 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 + type: array items: type: string - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: string - required: - - messageId - - text - 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.' - format: uint32 - type: integer - 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.' - format: uint32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - required: - - seconds - - nanoSeconds - type: object - x-etsi-ref: 6.5.2 - UserInfo: - description: This type represents the information related to a user attached to an access point - associated to the MEC host, such access point is in scope of the Location Service instance. - required: - - address - - accessPointId - - zoneId - - resourceURL - - timestamp - type: object - 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 + type: object properties: 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 + format: uri 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 zoneId: 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 resourceURL: - description: Self-referring URL, see note 1. + description: Self-referring URL, see note 1. This shall be only included in the procedure of UE Location Lookup. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: AnyURI - timestamp: + format: uri + timeStamp: + description: Date and time that location was collected. $ref: '#/components/schemas/TimeStamp' locationInfo: + description: The geographical coordinates where the user is. $ref: '#/components/schemas/LocationInfo' civicInfo: + description: Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 3. $ref: '#/components/schemas/CivicAddress' ancillaryInfo: description: Reserved for future use. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String relativeLocationInfo: + description: The relative location in a reference system. $ref: '#/components/schemas/RelativeLocationInfo' - - 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: - - resourceURL + - address + - AccessPointId + - zoneId + - timeStamp + description: "|-\n NOTE 1:\tAs specified in [5], clause 5.2.2.7.\nNOTE 2:\tVoid.\nNOTE 3:\tAs specified in [17], clause 6.1.6.2.14." + RelativeLocationInfo: + x-etsi-ref: 6.2.3 type: object + properties: + mapInfo: + description: Indicates a map corresponding to a location area. + $ref: '#/components/schemas/MapInfo' + X: + description: 'Indicates the value (in the unit of meters) on x-axis of the relative location in the Cartesian system. - ZoneInfo: - description: A type containing zone information. + + Positive value represents easting from origin.' + type: number + format: float + Y: + description: 'Indicates the value (in the unit of meters) on y-axis of the relative location in the Cartesian system. + + + Positive value represents northing from origin.' + type: number + format: float + Z: + description: 'Indicates the value (in the unit of meters) on z-axis of the relative location in the Cartesian system for a 3DPoint. + + + Positive value represents height above origin.' + type: number + format: float + required: + - mapInfo + - X + - Y + MapInfo: + x-etsi-ref: 6.2.4 + type: object 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 + mapId: + description: 'Indicates the ID of the map. ' type: string - x-etsi-mec-cardinality: 1 - x-etsi-mec-origin-type: string + origin: + $ref: '#/components/schemas/Origin' + ancillaryMapInfo: + description: Ancillary map information may be used to convert coordinates between different coordinate systems. + type: object required: - - zoneId - - numberOfAccessPoints - - numberOfUnserviceableAccessPoints - - numberOfUsers - - resourceURL + - mapId + UserList: + x-etsi-ref: 6.2.5 type: object - - ZoneList: - description: A type containing a list of zones. properties: + user: + description: 'Collection of the user location information list. ' + type: array + minItems: 0 + items: + $ref: '#/components/schemas/UserInfo' resourceURL: - description: Self referring URL + description: Self referring URL. This shall be only included in the procedure of UE Location Lookup. 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' + format: uri + NotificationSubscriptionList: + x-etsi-ref: 6.3.3 + type: object + properties: + subscription: type: array + items: + $ref: '#/components/schemas/Subscription' + resourceURL: + description: Self-referring URL. + $ref: '#/components/schemas/LinkType' required: - - resourceURL + - resourceURL + description: "|-\n NOTE 1:\tVoid.\nNOTE 2:\tVoid." + UserLocationEventSubscription: + x-etsi-ref: 6.3.4 type: object - - ZoneStatusNotification: properties: + subscriptionType: + description: Shall be set to "UserLocationEventSubscription". + type: string + 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 + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note 1. + type: string + format: uri + 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 + websockNotifConfig: + description: Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. + $ref: '#/components/schemas/WebsockNotifConfig' _links: $ref: '#/components/schemas/_links' - accessPointId: - description: Identifier of an access point (e.g. ap01). Shall be included when userNumEvent related with access point or operationStatus is included. - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - notificationType: - description: Shall be set to "ZoneStatusNotification". + 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: String - operationStatus: - # description': Shall be present when ZoneStatusSubscription includes operationStatus and the operation status value of an access point meets Serviceable or Unserviceable or Unknown defined in the subscription. See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': OperationStatus - $ref: '#/components/schemas/OperationStatus' - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp + format: uri + userEventPara: + description: Requirements for user event reporting. + $ref: '#/components/schemas/UserEventPara' + locationEventCriteria: + description: 'List of user event values to generate notifications for (these apply to address specified). ' + type: array + minItems: 0 + items: + $ref: '#/components/schemas/LocationEventType' + expiryDeadline: + description: The expiration time of the subscription determined by the UE Location Subscribe Service. $ref: '#/components/schemas/TimeStamp' - userNumEvent: - description: 'Shall be present when ZoneStatusSubscription includes upperNumberOfUsersZoneThreshold, lowerNumberOfUsersZoneThreshold, upperNumberOfUsersAPThreshold or lowerNumberOfUsersAPThreshold, and the number of users in a zone or an access point crosses the threshold defined in the subscription: - 1 = OVER_ZONE_UPPER_THD. - 2 = UNDER_ZONE_LOWER_THD. - 3 = OVER_AP_UPPER_THD. - 4 = UNDER_AP_LOWER_THD.' - enum: - - 1 - - 2 - - 3 - - 4 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Enum(inlined) - zoneId: - description: 'The identity of the zone. ' - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String required: - - notificationType - - zoneId - - _links + - subscriptionType + - address + description: "|-\n 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." + UserLocationPeriodicSubscription: + x-etsi-ref: 6.3.5 type: object - x-etsi-notes: "NOTE:\tAs specified in [5], clause 5.2.3.2." - x-etsi-ref: 6.4.7 - - ZoneStatusSubscription: properties: - _links: - $ref: '#/components/schemas/_links' + subscriptionType: + description: Shall be set to "UserLocationPeriodicSubscription". + type: string + 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 callbackReference: description: URI exposed by the client on which to receive notifications via HTTP. See note 1. + type: string + format: uri + 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 + websockNotifConfig: + description: Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. + $ref: '#/components/schemas/WebsockNotifConfig' + _links: + $ref: '#/components/schemas/_links' + address: + description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) to monitor. + type: string format: uri + periodicEventInfo: + description: Information for periodic event reporting. See note 3. + $ref: '#/components/schemas/PeriodicEventInfo' + expiryDeadline: + description: The expiration time of the subscription determined by the UE Location Subscribe Service. + $ref: '#/components/schemas/TimeStamp' + required: + - subscriptionType + - address + - periodicEventInfo + description: "|-\n 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." + ZoneLocationEventSubscription: + x-etsi-ref: 6.3.6 + type: object + properties: + subscriptionType: + description: Shall be set to "ZoneLocationEventSubscription". 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-cardinality: 0..1 - x-etsi-mec-origin-type: String - expiryDeadline: - # description': The expiration time of the subscription determined by the Zone Status Service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - lowerNumberOfUsersAPThreshold: - description: Threshold number of users in an access point which if crossed downward shall cause a notification - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: UnsignedInt - lowerNumberOfUsersZoneThreshold: - description: Threshold number of users in a zone which if crossed downward 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). See note 3. - items: - $ref: '#/components/schemas/OperationStatus' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: OperationStatus - reportingCtrl: - # description': Provides parameters that ctrl the reporting. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': ReportingCtrl - $ref: '#/components/schemas/ReportingCtrl' + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note 1. + type: string + format: uri 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 "ZoneStatusSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - upperNumberOfUsersAPThreshold: - description: Threshold number of users in an access point which if crossed upward shall cause a notification. - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: UnsignedInt - upperNumberOfUsersZoneThreshold: - description: Threshold number of users in a zone which if crossed upward shall cause a notification. - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: UnsignedInt websockNotifConfig: - # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': WebsockNotifConfig + description: Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. $ref: '#/components/schemas/WebsockNotifConfig' + _links: + $ref: '#/components/schemas/_links' zoneId: description: Identifier of zone (e.g. zone001) to monitor. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + addressList: + description: List of the users to be monitored. If not present, all the users need to be monitored. + type: array + minItems: 0 + items: + type: string + format: uri + locationEventCriteria: + description: 'List of user event values to generate notifications for. ' + type: array + minItems: 0 + items: + $ref: '#/components/schemas/LocationEventType' + reportingCtrl: + description: Provides parameters that ctrl the reporting. + $ref: '#/components/schemas/ReportingCtrl' + expiryDeadline: + description: The expiration time of the subscription determined by the Zone Location Event Service. + $ref: '#/components/schemas/TimeStamp' required: - subscriptionType - zoneId - 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 [5], clause 5.2.3.2." + description: "|-\n 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." + ZoneStatusSubscription: x-etsi-ref: 6.3.7 - - RelativeLocationInfo: - properties: - X: - description: 'Indicates the value (in the unit of meters) on x-axis of the relative location in the Cartesian system. - Positive value represents easting from origin.' - format: float - type: number - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float - Y: - description: 'Indicates the value (in the unit of meters) on y-axis of the relative location in the Cartesian system. - Positive value represents northing from origin.' - format: float - type: number - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float - Z: - description: 'Indicates the value (in the unit of meters) on z-axis of the relative location in the Cartesian system for a 3DPoint. - Positive value represents height above origin.' - format: float - type: number - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Float - mapInfo: - $ref: '#/components/schemas/MapInfo' - required: - - mapInfo - - 'X' - - 'Y' - type: object - x-etsi-ref: 6.2.3 - - MapInfo: - properties: - ancillaryMapInfo: - description: Ancillary map information may be used to convert coordinates between different coordinate systems. - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Not_specified - mapId: - description: 'Indicates the ID of the map. ' - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - origin: - $ref: '#/components/schemas/Origin' - required: - - mapId - type: object - x-etsi-ref: 6.2.4 - - Origin: - description: Indicates the location of the map origin in the local Cartesian coordinate system. - properties: - 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 - latitude: - description: "Location latitude, expressed in the range -90\xB0 to +90\xB0." - format: float - type: number - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float - longitude: - description: "Location longitude, expressed in the range -180\xB0 to +180\xB0." - format: float - type: number - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float - required: - - latitude - - longitude type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure(inlined) - - Subscription: - description: '' - minItems: 0 properties: - href: - description: The URI referring to the subscription. - format: uri - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uri subscriptionType: - description: "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses\_6.3.4, 6.3.5, 6.3.6, 6.3.7 6.3.8 and 6.3.9:\n\"UserLocationEventSubscription\"\n\"UserLocationPeriodicSubscription\"\n\"ZoneLocationEventSubscription\"\n\"ZoneStatusSubscription\"\n\"UserAreaSubscription\"\n\"UserDistanceSubscription\"" - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - href - - subscriptionType - type: object - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Structure (inlined) - - LinkType: - properties: - href: - description: URI referring to a resource. - format: uri + description: Shall be set to "ZoneStatusSubscription". type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uri - required: - - href - type: object - x-etsi-ref: 6.7.2 - - UserLocationEventSubscription: - properties: - _links: - $ref: '#/components/schemas/_links' - address: - description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI) to monitor." - format: 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: '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-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: - # description': The expiration time of the subscription determined by the UE Location Subscribe Service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - locationEventCriteria: - description: 'List of user event values to generate notifications for (these apply to address specified). ' - items: - $ref: '#/components/schemas/LocationEventType' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Array(LocationEventType) + format: uri 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: - # description': Requirements for user event reporting. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': UserEventPara - $ref: '#/components/schemas/UserEventPara' websockNotifConfig: - # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': WebsockNotifConfig + description: Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. $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. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 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-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. + zoneId: + description: Identifier of zone (e.g. zone001) to monitor. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + upperNumberOfUsersZoneThreshold: + description: Threshold number of users in a zone which if crossed upward shall cause a notification. + type: integer + lowerNumberOfUsersZoneThreshold: + description: Threshold number of users in a zone which if crossed downward shall cause a notification. + type: integer + upperNumberOfUsersAPThreshold: + description: Threshold number of users in an access point which if crossed upward shall cause a notification. + type: integer + lowerNumberOfUsersAPThreshold: + description: Threshold number of users in an access point which if crossed downward shall cause a notification. + type: integer + operationStatus: + description: List of operation status values to generate notifications for (these apply to all access points within a zone). See note 3. + type: array + minItems: 0 + items: + $ref: '#/components/schemas/OperationStatus' + reportingCtrl: + description: Provides parameters that ctrl the reporting. + $ref: '#/components/schemas/ReportingCtrl' expiryDeadline: - # description': The expiration time of the subscription determined by the UE Location Subscribe Service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp + description: The expiration time of the subscription determined by the Zone Status Service. $ref: '#/components/schemas/TimeStamp' - periodicEventInfo: - # description': Information for periodic event reporting. See note 3. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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-cardinality: 0..1 - 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: - # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': WebsockNotifConfig - $ref: '#/components/schemas/WebsockNotifConfig' required: - subscriptionType - - address - - periodicEventInfo - 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 [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." + - zoneId + description: "|-\n 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 [5], clause 5.2.3.2." + UserAreaSubscription: + x-etsi-ref: 6.3.8 type: object - required: - - reportingAmount - - reportingInterval - properties: - 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. - items: - type: string - minItems: 0 - type: array - 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. - format: uri + subscriptionType: + description: Shall be set to "UserAreaSubscription". 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-cardinality: 0..1 - x-etsi-mec-origin-type: String - expiryDeadline: - # description': The expiration time of the subscription determined by the Zone Location Event Service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - locationEventCriteria: - description: 'List of user event values to generate notifications for. ' - items: - $ref: '#/components/schemas/LocationEventType' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Array(LocationEventType) - reportingCtrl: - # description': Provides parameters that ctrl the reporting. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': ReportingCtrl - $ref: '#/components/schemas/ReportingCtrl' + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note 1. + type: string + format: uri 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: - # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': WebsockNotifConfig + description: Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. $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 - 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.6 - - UserAreaSubscription: - properties: _links: $ref: '#/components/schemas/_links' + areaDefine: + description: The parameters describing the area to subscribe. + $ref: '#/components/schemas/AreaInfo' addressList: description: 'List of the users to be monitored. ' + type: array + minItems: 1 items: type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: Array(Uri) - areaDefine: - # description': The parameters describing the area to subscribe. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': AreaInfo - $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-cardinality: 0..1 - x-etsi-mec-origin-type: String - expiryDeadline: - # description': The expiration time of the subscription determined by the UE Area Subscribe Service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' + format: uri + trackingAccuracy: + description: Number of meters of acceptable error. + type: number + format: float locationEventCriteria: description: 'List of user event values to generate notifications for (these apply to address specified). ' + type: array + minItems: 0 items: $ref: '#/components/schemas/LocationEventType' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Array(LocationEventType) reportingCtrl: - # description': Provides parameters that ctrl the reporting. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': ReportingCtrl + description: Provides parameters that ctrl the reporting. $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-cardinality: 0..1 - 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-cardinality: 0..1 - 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: - # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': WebsockNotifConfig - $ref: '#/components/schemas/WebsockNotifConfig' + expiryDeadline: + description: The expiration time of the subscription determined by the UE Area Subscribe Service. + $ref: '#/components/schemas/TimeStamp' required: - 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 - + description: "|-\n 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." UserDistanceSubscription: + x-etsi-ref: 6.3.9 + type: object properties: - _links: - $ref: '#/components/schemas/_links' - callbackReference: - description: URI exposed by the client on which to receive notifications via HTTP. See note 1. - format: uri + subscriptionType: + description: Shall be set to "UserDistanceSubscription". type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uri - checkImmediate: - # description': Check location immediately after establishing notification. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': Bool - 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: - # description': "Indicates whether the notification should occur when the geographical relationship between monitored and referenced users\u2019 changes. See note 3." - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': DistanceCriteria - $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: - # description': The expiration time of the subscription determined by the UE Distance Subscribe Service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - monitoredAddress: - description: "Contains addresses of users to monitor (e.g., \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 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." + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note 1. + type: string + format: uri + 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 + websockNotifConfig: + description: Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. + $ref: '#/components/schemas/WebsockNotifConfig' + _links: + $ref: '#/components/schemas/_links1' + 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 + minItems: 0 items: type: string - minItems: 1 + format: uri + 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. + + If the ReferenceAddress is specified, then the distance between each monitored user and reference user(s) will be monitored. + + If 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.' 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., \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI). Reference to a group could be provided here if supported by implementation." + minItems: 1 items: type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Array(Uri) - reportingCtrl: - # description': Provides parameters that ctrl the reporting. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': 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 + format: uri + distance: + description: Distance between users that shall be monitored. The unit is meter. + type: number + format: float 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: - # description': Provides details to negotiate and signal the use of a Websocket connection between the location server and the service consumer for notifications. See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': WebsockNotifConfig - $ref: '#/components/schemas/WebsockNotifConfig' + format: float + criteria: + description: Indicates whether the notification should occur when the geographical relationship between monitored and referenced users' changes. See note 3. + $ref: '#/components/schemas/DistanceCriteria' + checkImmediate: + description: Check location immediately after establishing notification. + type: boolean + reportingCtrl: + description: Provides parameters that ctrl the reporting. + $ref: '#/components/schemas/ReportingCtrl' + expiryDeadline: + description: The expiration time of the subscription determined by the UE Distance Subscribe Service. + $ref: '#/components/schemas/TimeStamp' required: - subscriptionType - monitoredAddress @@ -2611,597 +1737,680 @@ components: - trackingAccuracy - criteria - checkImmediate + description: "|-\n 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." + TestNotification: + x-etsi-ref: 6.4.3 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: properties: - _links: - $ref: '#/components/schemas/_links' - distanceEvent: - # description': Indicates the distance event triggering the notification. See note. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': DistanceCriteria - $ref: '#/components/schemas/DistanceCriteria' - monitoredUsers: - # description': Indicates the location information related to monitored users. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': UserList - $ref: '#/components/schemas/UserList' notificationType: - description: Shall be set to "UserDistanceNotification". + description: Shall be set to "TestNotification". type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' + _links: + $ref: '#/components/schemas/_links2' 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: + x-etsi-ref: 6.4.4 + type: object properties: - _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 - address: - description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)." - format: uri - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uri - civicInfo: - # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1. See note 3. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': CivicAddress - $ref: '#/components/schemas/CivicAddress' - locationInfo: - # description': The geographical coordinates where the user is. See note 3. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': LocationInfo - $ref: '#/components/schemas/LocationInfo' notificationType: description: Shall be set to "UserLocationEventNotification". type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - relativeLocationInfo: - # description': The relative location in a reference system. See note 3. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': RelativeLocationInfo - $ref: '#/components/schemas/RelativeLocationInfo' timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp + description: Time stamp. $ref: '#/components/schemas/TimeStamp' + address: + description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). + type: string + format: uri userLocationEvent: - # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT".. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LocationEventType + description: The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT". $ref: '#/components/schemas/LocationEventType' + locationInfo: + description: The geographical coordinates where the user is. See note 3. + $ref: '#/components/schemas/LocationInfo' + civicInfo: + description: Contextual information of a user location (e.g. aisle, floor, room number, etc.). See notes 1 and 3. + $ref: '#/components/schemas/CivicAddress' + relativeLocationInfo: + description: The relative location in a reference system. See note 3. + $ref: '#/components/schemas/RelativeLocationInfo' 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 + 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 + _links: + $ref: '#/components/schemas/_links3' required: - notificationType - userLocationEvent - _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:\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 - + description: "|-\n 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." UserLocationPeriodicNotification: + x-etsi-ref: 6.4.5 + type: object properties: - _links: - $ref: '#/components/schemas/_links' - accessPointId: - description: "The identity of the access point that the user is currently within. \nSee note 2." + notificationType: + description: Shall be set to "UserLocationPeriodicNotification". type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + timeStamp: + description: Time stamp. + $ref: '#/components/schemas/TimeStamp' address: - description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)." - format: uri + description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uri - civicInfo: - # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': CivicAddress - $ref: '#/components/schemas/CivicAddress' - isFinalNotification: - description: Shall be set to true if it is a final notification. - type: boolean - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Boolean + format: uri + result: + description: The result of Localization. See note 3. + $ref: '#/components/schemas/NotificationResult' locationInfo: - # description': The geographical coordinates where the user is. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': LocationInfo + description: The geographical coordinates where the user is. $ref: '#/components/schemas/LocationInfo' - notificationType: - description: Shall be set to "UserLocationPeriodicNotification". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + civicInfo: + description: Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1. + $ref: '#/components/schemas/CivicAddress' relativeLocationInfo: - # description': The relative location in a reference system. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': RelativeLocationInfo + description: The relative location in a reference system. $ref: '#/components/schemas/RelativeLocationInfo' - result: - # description': The result of Localization. See note 3. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': NotificationResult - $ref: '#/components/schemas/NotificationResult' - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': 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 + accessPointId: + description: "The identity of the access point that the user is currently within. \nSee note 2." + type: string + isFinalNotification: + description: Shall be set to true if it is a final notification. + type: boolean + _links: + $ref: '#/components/schemas/_links3' 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 - + description: "|-\n 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." ZoneLocationEventNotification: + x-etsi-ref: 6.4.6 + type: object properties: - _links: - $ref: '#/components/schemas/_links' - address: - description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 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 timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp + description: Time stamp. $ref: '#/components/schemas/TimeStamp' + address: + description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). + type: string + format: uri userLocationEvent: - # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT","LEAVING_AREA_EVENT". - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LocationEventType + description: The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT","LEAVING_AREA_EVENT". $ref: '#/components/schemas/LocationEventType' zoneId: description: 'The identity of the zone. ' type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + _links: + $ref: '#/components/schemas/_links3' required: - notificationType - address - userLocationEvent - zoneId - _links + ZoneStatusNotification: + x-etsi-ref: 6.4.7 type: object - x-etsi-ref: 6.4.6 - - UserAreaNotification: properties: + notificationType: + description: Shall be set to "ZoneStatusNotification". + type: string + timeStamp: + description: Time stamp. + $ref: '#/components/schemas/TimeStamp' + userNumEvent: + type: integer + enum: + - 1 + - 2 + - 3 + - 4 + description: 'Shall be present when ZoneStatusSubscription includes upperNumberOfUsersZoneThreshold, lowerNumberOfUsersZoneThreshold, upperNumberOfUsersAPThreshold or lowerNumberOfUsersAPThreshold, and the number of users in a zone or an access point crosses the threshold defined in the subscription: + + 1 = OVER_ZONE_UPPER_THD. + + 2 = UNDER_ZONE_LOWER_THD. + + 3 = OVER_AP_UPPER_THD. + + 4 = UNDER_AP_LOWER_THD.' + operationStatus: + description: Shall be present when ZoneStatusSubscription includes operationStatus and the operation status value of an access point meets Serviceable or Unserviceable or Unknown defined in the subscription. See note. + $ref: '#/components/schemas/OperationStatus' + zoneId: + description: 'The identity of the zone. ' + type: string + accessPointId: + description: Identifier of an access point (e.g. ap01). Shall be included when userNumEvent related with access point or operationStatus is included. + type: string _links: - $ref: '#/components/schemas/_links' + $ref: '#/components/schemas/_links3' + required: + - notificationType + - zoneId + - _links + description: "|-\n NOTE:\tAs specified in [5], clause 5.2.3.2." + UserAreaNotification: + x-etsi-ref: 6.4.8 + type: object + properties: + notificationType: + description: Shall be set to "UserAreaNotification". + type: string + timeStamp: + description: Time stamp. + $ref: '#/components/schemas/TimeStamp' address: - description: "Address of user (e.g. \u2018sip\u2019 URI, \u2018tel\u2019 URI, \u2018acr\u2019 URI)." - format: uri + description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uri - civicInfo: - # description': Contextual information of a user location (e.g. aisle, floor, room number, etc.). See note 1. See note 2. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': CivicAddress - $ref: '#/components/schemas/CivicAddress' + format: uri locationInfo: - # description': The geographical coordinates where the user is. See note 2. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': LocationInfo + description: The geographical coordinates where the user is. See note 2. $ref: '#/components/schemas/LocationInfo' - notificationType: - description: Shall be set to "UserAreaNotification". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + civicInfo: + description: Contextual information of a user location (e.g. aisle, floor, room number, etc.). See notes 1 and 2. + $ref: '#/components/schemas/CivicAddress' relativeLocationInfo: - # description': The relative location in a reference system. See note 2. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': RelativeLocationInfo + description: The relative location in a reference system. See note 2. $ref: '#/components/schemas/RelativeLocationInfo' - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' userLocationEvent: - # description': The specific event triggering this notification, e.g. "ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT". - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LocationEventType + description: The specific event triggering this notification, e.g."ENTERING_AREA_EVENT", "LEAVING_AREA_EVENT". $ref: '#/components/schemas/LocationEventType' + _links: + $ref: '#/components/schemas/_links3' required: - notificationType - address - userLocationEvent - _links + description: "|-\n 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." + UserDistanceNotification: + x-etsi-ref: 6.4.9 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. - items: - $ref: '#/components/schemas/Point' - minItems: 1 - type: array - 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: - - 1 - - 2 - 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 + notificationType: + description: Shall be set to "UserDistanceNotification". + type: string + timeStamp: + description: Time stamp. + $ref: '#/components/schemas/TimeStamp' + monitoredUsers: + description: Indicates the location information related to monitored users. + $ref: '#/components/schemas/UserList' + distanceEvent: + description: Indicates the distance event triggering the notification. See note. + $ref: '#/components/schemas/DistanceCriteria' + _links: + $ref: '#/components/schemas/_links3' + required: + - notificationType + - monitoredUsers + - distanceEvent + - _links + description: "|-\n NOTE:\tAs specified in [6], clause 5.2.3.2." + TimeStamp: + x-etsi-ref: 6.5.2 + type: object + properties: + seconds: + description: 'The seconds part of the time. Time is defined as: - Point: + Unix-time since January 1, 1970, 00:00:00 UTC.' + type: integer + format: uint32 + nanoSeconds: + description: 'The nanoseconds part of the time. Time is defined as: + + Unix-time since January 1, 1970, 00:00:00 UTC.' + type: integer + format: uint32 + required: + - seconds + - nanoSeconds + LocationInfo: + x-etsi-ref: 6.5.3 + type: object properties: latitude: - description: "Location latitude, expressed in the range -90\xB0 to +90\xB0." - format: float + description: "Location latitude, expressed in the range -90\xB0 to +90\xB0. Cardinality greater than one only if \"shape\" equals 7." type: number - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float + format: float longitude: - description: "Location longitude, expressed in the range -180\xB0 to +180\xB0." + description: "Location longitude, expressed in the range -180\xB0 to +180\xB0. Cardinality greater than one only if \"shape\" equals 7." + type: number format: float + altitude: + description: Location altitude relative to the WGS84 ellipsoid surface. type: number - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float + format: float + accuracy: + description: Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6. + type: integer + accuracySemiMinor: + description: Horizontal accuracy/(semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6. + type: integer + accuracyAltitude: + description: Altitude accuracy/uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4. + type: integer + orientationMajorAxis: + description: "Angle of orientation of the major axis, expressed in the range 0\xB0 to 180\xB0, as defined in [14]. Present only if \"shape\" equals 4 or 6." + type: integer + confidence: + 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 [14]. Present only if "shape" equals 1, 4 or 6. + type: integer + innerRadius: + description: Present only if "shape" equals 6. + type: integer + uncertaintyRadius: + description: Present only if "shape" equals 6. + type: integer + offsetAngle: + description: Present only if "shape" equals 6. + type: integer + includedAngle: + description: Present only if "shape" equals 6. + type: integer + shape: + type: integer + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + description: 'Shape information, as detailed in [14], associated with the reported location coordinate: + + 1 = Ellipsoid_Arc. + + 2 = ellipsoid_Point. + + 3 = ellipsoid_Point_Altitude. + + 4 = ellipsoid_Point_Altitude_Uncert_Ellipsoid. + + 5 = ellipsoid_Point_Uncert_Circle. + + 6 = ellipsoid_Point_Uncert_Ellipse. + + 7 = polygon.' + velocity: + $ref: '#/components/schemas/Velocity' required: - latitude - longitude + - shape + WebsockNotifConfig: + x-etsi-ref: 6.5.4 type: object - x-etsi-ref: 6.5.8 - + properties: + websocketUri: + description: Set by location server to indicate to the service consumer the Websocket URI to be used for delivering notifications. + type: string + format: uri + requestWebsocketUri: + description: Set to true by the service consumer to indicate that Websocket delivery is requested. + type: boolean + UserEventPara: + x-etsi-ref: 6.5.5 + type: object + properties: + reportingLocationReq: + description: This IE shall be set to true if a location estimate is required for each event report. + type: boolean + accessPointList: + description: One or more access points forming a monitoring area that could be any shape. See note 1. + type: array + minItems: 0 + items: + type: string + zoneId: + description: "Identifier of zone (e.g. zone001) to monitor. See note\_1." + type: string + occurrenceInfo: + description: One time only report indication. See note 2. + $ref: '#/components/schemas/OccurrenceInfo' + description: "|-\n NOTE 1:\tOnly one of accessPointList and zoneId may be present.\nNOTE 2:\tAs specified in [17], clause 6.1.6.3.16." ReportingCtrl: + x-etsi-ref: 6.5.6 + type: object 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. + 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 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. + 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 + AreaInfo: + x-etsi-ref: 6.5.7 type: object - x-etsi-ref: 6.5.6 + properties: + shape: + type: integer + enum: + - 1 + - 2 + description: 'The shape of the area monitored: + 1 = CIRCLE. + + 2 = POLYGON.' + points: + description: Shall include one point if the shape is CIRCLE. Shall include 3-15 points if the shape is POLYGON. + type: array + minItems: 1 + items: + $ref: '#/components/schemas/Point' + radius: + description: Shall be present if the shape is CIRCLE. + type: integer + required: + - shape + - points + Point: + x-etsi-ref: 6.5.8 + type: object + properties: + latitude: + description: "Location latitude, expressed in the range 90\xB0 to +90\xB0." + type: number + format: float + longitude: + description: "Location longitude, expressed in the range -180\xB0 to +180\xB0." + type: number + format: float + required: + - latitude + - longitude + LinkType: + x-etsi-ref: 6.7.2 + type: object + properties: + href: + description: URI referring to a resource. + type: string + format: uri + required: + - href + Origin: + description: Indicates the location of the map origin in the local Cartesian coordinate system. + type: object + properties: + latitude: + description: "Location latitude, expressed in the range -90\xB0 to +90\xB0." + type: number + format: float + longitude: + description: "Location longitude, expressed in the range -180\xB0 to +180\xB0." + type: number + format: float + altitude: + description: Location altitude relative to the WGS84 ellipsoid surface. + type: number + format: float + required: + - latitude + - longitude + Subscription: + description: '' + type: object + properties: + href: + description: The URI referring to the subscription. + type: string + format: uri + subscriptionType: + description: "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in clauses\_6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8 and 6.3.9:\n\"UserLocationEventSubscription\"\n\"UserLocationPeriodicSubscription\"\n\"ZoneLocationEventSubscription\"\n\"ZoneStatusSubscription\"\n\"UserAreaSubscription\"\n\"UserDistanceSubscription\"" + type: string + required: + - href + - subscriptionType _links: description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + type: object properties: self: + description: Self-referring URI. The URI shall be unique within the UE Location Subscribe as it acts as an ID for the subscription. $ref: '#/components/schemas/LinkType' required: - self + _links1: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. 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: - # description': One time only report indication. See note 2. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': 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 + self: + description: Self-referring URI. The URI shall be unique within the User Distance Subscribe as it acts as an ID for the subscription. + $ref: '#/components/schemas/LinkType' + required: + - self + _links2: + description: 'Hyperlink related to the resource. ' 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 + subscription: + description: URI identifying the subscription for the test notification. + $ref: '#/components/schemas/LinkType' + required: + - subscription + _links3: + description: Object containing hyperlinks related to the resource. 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 + subscription: + description: A link to the related subscription. + $ref: '#/components/schemas/LinkType' required: - - notificationType - - _links + - subscription + Velocity: + description: Structure with attributes relating to the target entity's velocity, as defined in [14]. type: object - x-etsi-ref: 6.4.3 + properties: + velocityType: + type: integer + enum: + - 1 + - 2 + - 3 + - 4 + description: 'Velocity information, as detailed in [14], associated with the reported location coordinate: - LocationEventType: - description: This type represents specified event types for UE location report. - enum: - - ENTERING_AREA_EVENT - - LEAVING_AREA_EVENT - type: string + 1 = Horizontal. - NotificationResult: - description: This enumeration represents the result of a localization associated with a notification - enum: - - SUCCESS - - ABNORMAL - type: string + 2 = Horizontal_Vertical. - OccurrenceInfo: - description: The enumeration OccurrenceInfo indicates whether event reporting is one time. - enum: - - ONE_TIME_EVENT - - MULTIPLE_TIME_EVENT - type: string + 3 = Horizontal_Uncert. - CivicAddress: - description: Indicates a Civic address - type: object + 4 = Horizontal_Vertical_Uncert.' + bearing: + description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in [14]." + type: integer + horizontalSpeed: + description: Horizontal speed, expressed in km/h and defined in [14]. + type: integer + uncertainty: + description: Horizontal uncertainty, as defined in [14]. Present only if "velocityType" equals 3 or 4. + type: integer + verticalSpeed: + description: Vertical speed, expressed in km/h and defined in [14]. Present only if "velocityType" equals 2 or 4. + type: integer + verticalUncertainty: + description: Vertical uncertainty, as defined in [14]. Present only if "velocityType" equals 4. + type: integer required: - - country - properties: - 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) - type: string - 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 - type: string - 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-cardinality: 0..1 - 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) - type: string - 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) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - FLR: - description: Floor - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ROOM: - description: Room - type: string - 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-cardinality: 0..1 - x-etsi-mec-origin-type: String - SEAT: - description: Seat (desk, cubicle, workstation) - type: string - x-etsi-mec-cardinality: 0..1 - 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 - type: string - 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-cardinality: 0..1 - x-etsi-mec-origin-type: String - POM: - description: Road post-modifier - type: string - x-etsi-mec-cardinality: 0..1 - 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. - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String \ No newline at end of file + - velocityType + - bearing + - horizontalSpeed + responses: + '200': + description: OK + '204': + description: No Content + '400': + description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized: used when the client did not submit credentials.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden: operation is not allowed given the current status of the resource.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: 'Not Found: used when a client provided a URI that cannot be mapped to a valid resource URI.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 'Not Acceptable: used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '412': + description: 'Precondition failed: used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '415': + description: 'Unsupported Media Type: used to indicate that the server or the client does not support the content type of the entity body.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '422': + description: 'Unprocessable Entity: used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests: used when a rate limiter has triggered.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + parameters: + Query.zoneId: + description: Identifier of zone (e.g. zone001). + name: zoneId + in: query + required: false + x-exportParamName: Query.zoneId + schema: + type: array + items: + type: string + Query.accessPointId: + description: Identifier of access point (e.g. 001010000000000000000000000000001). + name: accessPointId + in: query + required: false + x-exportParamName: Query.accessPointId + schema: + type: array + items: + type: string + Query.address: + description: Address of users (e.g. 'sip' URI, 'tel' URI, 'acr' URI). See note. + name: address + in: query + required: false + x-exportParamName: Query.address + schema: + type: array + items: + type: AnyUri + Query.subscription_type: + description: 'Query parameter to filter on a specific subscription type. Permitted values: + + event. + + periodic.' + name: subscription_type + in: query + required: false + x-exportParamName: Query.subscription_type + schema: + type: string + Query.address1: + description: Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI). + name: address1 + in: query + required: false + x-exportParamName: Query.address1 + schema: + type: Uri + Query.subscription_type1: + description: 'Query parameter to filter on a specific subscription type. Permitted values: + + event. + + status.' + name: subscription_type1 + in: query + required: false + x-exportParamName: Query.subscription_type1 + schema: + type: string + Query.zoneId1: + description: The identity of the zone. . + name: zoneId1 + in: query + required: false + x-exportParamName: Query.zoneId1 + schema: + type: string + Query.address2: + description: "One or two addresses of user to check.\nThe second \"address\" parameter shall not be included when the distance between a user and a location is requested. \nThe second \"address\" parameter shall be included when a location is not provided." + name: address2 + in: query + required: true + x-exportParamName: Query.address2 + schema: + type: array + items: + type: Array + Query.location: + description: Shall not be included when the distance between two terminals is requested. + name: location + in: query + required: false + x-exportParamName: Query.location + schema: + $ref: '#/components/schemas/Point' + Query.subscription_type2: + description: 'Query parameter to filter on a specific subscription type. Permitted values: + + event.' + name: subscription_type2 + in: query + required: false + x-exportParamName: Query.subscription_type2 + schema: + type: string + diff --git a/doc/config-LocationAPI.yaml b/doc/config-LocationAPI.yaml index 87833cc3760ebfc0206351df846343ccf7d3c441..c2cc3d27db704b048f7b12b025d53a38f726a08a 100644 --- a/doc/config-LocationAPI.yaml +++ b/doc/config-LocationAPI.yaml @@ -10,7 +10,7 @@ api_def_headings: - 'Annex A \(informative\)\:\nComplementary material for API utilization$' servers: - - url: https://localhost/location/v2 + - url: https://localhost/location/v3 tags: - 'queries' @@ -39,321 +39,12 @@ manual_types: type: string format: uri description: A URI reference that identifies the specific occurrence of the problem - LocationInfo1_: - properties: - accuracy: - type: integer - description: Horizontal accuracy / (semi-major) uncertainty of location - provided in meters, as defined in [14]. Present only if "shape" equals - 4, 5 or 6 - accuracyAltitude: - type: integer - description: Altitude accuracy / uncertainty of location provided in meters, - as defined in [14]. Present only if "shape" equals 3 or 4 - accuracySemiMinor: - type: integer - description: Horizontal accuracy / (semi-major) uncertainty of location - provided in meters, as defined in [14]. Present only if "shape" equals - 4, 5 or 6 - altitude: - description: Location altitude relative to the WGS84 ellipsoid surface. - type: number - format: float - confidence: - type: integer - 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 [14]. Present only if "shape" equals 1, 4 or 6 - includedAngle: - type: integer - description: Present only if "shape" equals 6 - innerRadius: - type: integer - description: Present only if "shape" equals 6 - latitude: - description: "Location latitude, expressed in the range -90\xB0 to +90\xB0\ - . Cardinality greater than one only if \"shape\" equals 7." - type: array - items: - type: number - format: float - minItems: 1 - longitude: - description: "Location longitude, expressed in the range -180\xB0 to +180\xB0\ - . Cardinality greater than one only if \"shape\" equals 7." - type: array - items: - type: number - format: float - minItems: 1 - offsetAngle: - type: integer - description: Present only if "shape" equals 6 - orientationMajorAxis: - type: integer - description: "Angle of orientation of the major axis, expressed in the range\ - \ 0\xB0 to 180\xB0, as defined in [14]. Present only if \"shape\" equals\ - \ 4 or 6" - shape: - description: 'Shape information, as detailed in [14], associated with the - reported location coordinate: -

1 = ELLIPSOID_ARC -

2 = ELLIPSOID_POINT -

3 = ELLIPSOID_POINT_ALTITUDE -

4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID -

5 = ELLIPSOID_POINT_UNCERT_CIRCLE -

6 = ELLIPSOID_POINT_UNCERT_ELLIPSE -

7 = POLYGON' - type: integer - uncertaintyRadius: - type: integer - description: Present only if "shape" equals 6 - velocity: - description: "Structure with attributes relating to the target entity\u2019\ - s velocity, as defined in [14]." - properties: - bearing: - type: integer - description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined\ - \ in [14]." - horizontalSpeed: - type: integer - description: Horizontal speed, expressed in km/h and defined in [14]. - uncertainty: - type: integer - description: Horizontal uncertainty, as defined in [14]. Present only - if "velocityType" equals 3 or 4 - velocityType: - description: 'Velocity information, as detailed in [14], associated - with the reported location coordinate: -

1 = HORIZONTAL -

2 = HORIZONTAL_VERTICAL -

3 = HORIZONTAL_UNCERT -

4 = HORIZONTAL_VERTICAL_UNCERT' - type: integer - verticalSpeed: - description: Vertical speed, expressed in km/h and defined in [14]. - Present only if "velocityType" equals 2 or 4 - type: integer - verticalUncertainty: - type: integer - description: Vertical uncertainty, as defined in [14]. Present only - required: - - velocityType - - bearing - - horizontalSpeed - type: object - timestamp: - $ref: '#/components/schemas/TimeStamp' - description: Date and time that location was collected. - required: - - latitude - - longitude - - shape - type: object - x-etsi-ref: 6.5.3 - UserInfo1_: - properties: - accessPointId: - description: The identity of the access point the user is currently on, - see note 1. - 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 - ancillaryInfo: - description: Reserved for future use. - type: string - contextLocationInfo: - description: Contextual information of a user location (e.g. aisle, floor, - room number, etc.). - type: string - locationInfo: - $ref: '#/components/schemas/LocationInfo' - description: The geographical coordinates where the user is, see note 2. - resourceURL: - description: Self-referring URL, see note 1. - type: string - timestamp: - $ref: '#/components/schemas/TimeStamp' - description: Date and time that location was collected. - zoneId: - description: The identity of the zone the user is currently within, see - note 1. - type: string - required: - - address - - accessPointId - - zoneId - - resourceURL - - timestamp - type: object - 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 - CallbackReference: - type: object - required: - - notifyURL - properties: - notifyURL: - description: Notify Callback URL - type: string - 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 - notificationFormat: - $ref: '#/components/schemas/NotificationFormat' - description: Application can specify format of the resource representation in notifications that are related to this subscription. The choice is between {XML, JSON} - UserTrackingSubscription: - description: 'A type containing user tracking subscription.' - type: object - required: - - callbackReference - - address - properties: - clientCorrelator: - type: string - description: 'A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.' - callbackReference: - $ref: '#/components/schemas/CallbackReference' - description: 'Notification callback definition' - userEventCriteria: - type: array - items: - $ref: '#/components/schemas/UserEventType' - 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.' - resourceURL: - description: 'Self referring URL' - type: string - ZonalPresenceNotification: - description: 'A type containing zonal presence notification' - type: object - required: - - zoneId - - address - - userEventType - - currentAccessPointId - - timestamp - properties: - callbackData: - description: 'CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].' - type: string - zoneId: - description: 'Identifier of zone' - type: string - address: - description: 'Address of user (e.g. "sip" URI, "tel" URI, "acr" URI) to monitor' - type: string - interestRealm: - description: 'Interest realm of access point (e.g. geographical area, a type of industry etc.).' - type: string - userEventType: - $ref: '#/components/schemas/UserEventType' - description: 'User Event.' - currentAccessPointId: - description: 'Identifier of access point.' - type: string - previousAccessPointId: - description: 'Identifier of access point.' - type: string - timestamp: - $ref: '#/components/schemas/TimeStamp' - description: 'Indicates the time of the day for zonal presence notification.' - 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' - type: array - items: - $ref: '#/components/schemas/Link' - UserEventType: - type: string - enum: - - Entering - - Leaving - - Transferring - Link: - description: Link to other resources - type: object - required: - - rel - - href - properties: - rel: - description: Describes the relationship between the URI and the resource. - type: string - href: - description: URI - type: string - format: anyURI - ZonalTrafficSubscription: - description: 'A type containing zonal traffic subscription' - type: object - required: - - callbackReference - - zoneId - properties: - 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 - - callbackReference: - $ref: '#/components/schemas/CallbackReference' - description: 'Notification callback definition' - zoneId: - description: 'Identifier of zone' - type: string - interestRealm: - description: 'Interest realm of access point (e.g. geographical area, a type of industry etc.).' - type: array - items: - type: string - userEventCriteria: - $ref: '#/components/schemas/UserEventType' - 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.' - 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 - resourceURL: - type: string - description: 'Self referring URL' OperationStatus: type: string enum: - Serviceable - Unserviceable - Unknown - ZoneStatusSubscription: - description: 'A type containing zone status subscription.' - type: object - required: - - callbackReference - - zoneId - properties: - 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 - callbackReference: - $ref: '#/components/schemas/CallbackReference' - description: 'Notification callback definition' - zoneId: - description: 'Identifier of zone' - type: string - numberOfUsersZoneThreshold: - description: 'Threshold number of users in a zone which if crossed shall cause a notification' - type: integer - numberOfUsersAPThreshold: - description: 'Threshold number of users in an access point which if crossed shall cause a notification' - type: integer - operationStatus: - type: array - items: - $ref: '#/components/schemas/OperationStatus' - description: 'List of operation status values to generate notifications for (these apply to all access points within a zone).' - resourceURL: - description: 'Self referring URL' - type: string PeriodicEventInfo: x-etsi-notes: "NOTE 3:\tAs specified in [17], clause 6.1.6.2.24." LocationEventType: @@ -368,64 +59,12 @@ manual_types: description: Entering area reporting event. - value: LEAVING_AREA_EVENT description: Leaving area reporting event. - Uri: - type: string - format: uri - description: Uniform Resource Identifier (URI) CivicAddress: x-etsi-notes: "NOTE 3:\tAs specified in [17], clause 6.1.6.2.14." NotificationResult: x-etsi-notes: "NOTE 3:\tIf the result is SUCCESS, at least one of locationInfo, civicInfo and relativeLocationInfo shall be present. " OccurrenceInfo: - x-etsi-notes: "NOTE 3:\tAs specified in [17], clause 6.1.6.3.16." - ZoneStatusNotification: - description: 'A type containing zone status notification.' - type: object - required: - - zoneId - - timestamp - properties: - callbackData: - description: 'CallBackData if passed by the application during the associated ZoneStatusSubscription operation. See [REST_NetAPI_Common].' - type: string - zoneId: - description: 'Identifier of zone' - type: string - - accessPointId: - description: 'Identifier of an access point.' - type: string - 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 - 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 - operationStatus: - $ref: '#/components/schemas/OperationStatus' - description: 'This element shall be present when ZoneStatusSubscription includes operationStatus element and the operation status value of an access point meets Serviceable or Unserviceable or Unknown defined in the subscription.' - timestamp: - $ref: '#/components/schemas/TimeStamp' - description: 'Indicates the timeof day for zone status notification.' - 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' - type: array - items: - $ref: '#/components/schemas/Link' - UserList: - description: 'A type containing list of users.' - type: object - required: - - resourceURL - properties: - user: - description: 'Collection of the zone information list.' - type: array - items: - $ref: '#/components/schemas/UserInfo' - resourceURL: - description: 'Self referring URL' - type: string + x-etsi-notes: "NOTE 2:\tAs specified in [17], clause 6.1.6.3.16." AccessPointList: description: 'A type containing list of access points.' type: object @@ -448,16 +87,11 @@ manual_types: description: 'The connection type for the access point' type: string enum: - - Femto - - LTE-femto - - Smallcell - - LTE-smallcell - - Wifi - - Pico - - Micro - - Macro - - Wimax - - Unknown + - LTE + - Wi-Fi® + - WiMAX® + - 5G NR + - UNKNOWN AccessPointInfo: description: 'A type containing access point information.' type: object @@ -477,7 +111,6 @@ manual_types: connectionType: $ref: '#/components/schemas/ConnectionType' description: 'Connection type of access point.' - operationStatus: $ref: '#/components/schemas/OperationStatus' description: 'Operation status of access point.' @@ -547,180 +180,6 @@ manual_types: timestamp: $ref: '#/components/schemas/TimeStamp' description: 'Date and time that location from which distance is calculated was collected.' - CircleNotificationSubscription: - description: 'A type containing data for notifications, when the area is defined as a circle.' - type: object - required: - - callbackReference - - address - - latitude - - longitude - - radius - - trackingAccuracy - - enteringLeavingCriteria - - checkImmediate - - frequency - properties: - 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 - resourceURL: - description: 'Self referring URL' - type: string - link: - description: 'Link to other resources that are in relationship with the resource.' - type: array - items: - $ref: '#/components/schemas/Link' - callbackReference: - $ref: '#/components/schemas/CallbackReference' - description: 'Notification callback definition' - requester: - description: 'Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)' - type: string - address: - description: 'Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)' - type: array - items: - type: string - latitude: - description: 'Latitude of center point.' - type: number - format: float - longitude: - description: 'Longitude of center point.' - type: number - format: float - radius: - description: 'Radius circle around center point in meters.' - type: number - format: float - trackingAccuracy: - description: 'Number of meters of acceptable error in tracking distance.' - type: number - format: float - enteringLeavingCriteria: - $ref: '#/components/schemas/EnteringLeavingCriteria' - description: 'Indicates whether the notification should occur when the terminal enters or leaves the target area.' - checkImmediate: - description: 'Check location immediately after establishing notification.' - type: boolean - frequency: - description: 'Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).' - type: integer - duration: - description: 'Period of time (in seconds) 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.' - type: integer - 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 - PeriodicNotificationSubscription: - description: 'A type containing data for periodic subscription.' - type: object - required: - - callbackReference - - address - - requestedAccuracy - - frequency - properties: - 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 - resourceURL: - description: 'Self referring URL' - type: string - link: - description: 'Link to other resources that are in relationship with the resource.' - type: array - items: - $ref: '#/components/schemas/Link' - callbackReference: - $ref: '#/components/schemas/CallbackReference' - description: 'Notification callback definition' - requester: - description: 'Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)' - type: string - address: - description: 'Address of terminals to monitor (e.g. "sip" URI, "tel" URI, "acr" URI)' - type: array - items: - type: string - requestedAccuracy: - description: 'Accuracy of the provided distance in meters.' - type: integer - frequency: - description: 'Maximum frequency (in seconds) of notifications (can also be considered minimum time between notifications) per subscription.' - type: integer - duration: - description: 'Period of time (in seconds) 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.' - type: integer - DistanceNotificationSubscription: - description: 'A type containing data for distance subscription, with reference to other devices.' - type: object - required: - - callbackReference - - monitoredAddress - - distance - - trackingAccuracy - - criteria - - checkImmediate - - frequency - properties: - 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 - resourceURL: - description: 'Self referring URL' - type: string - link: - description: 'Link to other resources that are in relationship with the resource.' - type: array - items: - $ref: '#/components/schemas/Link' - callbackReference: - $ref: '#/components/schemas/CallbackReference' - description: 'Notification callback definition' - requester: - description: 'Identifies the entity that is requesting the information (e.g. "sip" URI, "tel" URI, "acr" URI)' - type: string - 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) - type: array - items: - type: string - monitoredAddress: - description: Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI) - type: array - items: - type: string - distance: - description: 'Distance between devices that shall be monitored.' - type: number - format: float - trackingAccuracy: - description: 'Number of meters of acceptable error in tracking distance.' - type: number - format: float - criteria: - $ref: '#/components/schemas/DistanceCriteria' - description: 'Indicates whether the notification should occur when the geographical relationship between monitored and referenced devices changes.' - checkImmediate: - description: 'Check location immediately after establishing notification.' - type: boolean - frequency: - description: 'Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).' - type: integer - duration: - description: 'Period of time (in seconds) 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.' - type: integer - 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 - EnteringLeavingCriteria: - type: string - enum: - - Entering = 'Terminal is entering an area' - - Leaving = 'Terminal is leaving an area' DistanceCriteria: type: string enum: @@ -728,59 +187,6 @@ manual_types: - AnyWithinDistance = 'Any of monitored devices gets within the specified distance' - AllBeyondDistance = 'All monitored devices are beyond the specified distance' - AnyBeyondDistance = 'Any of monitored devices gets beyond the specified distance' - NotificationFormat: - type: string - enum: - - XML - - JSON - SubscriptionNotification: - description: 'A type containing the notification subscription.' - type: object - required: - - terminalLocation - properties: - callbackData: - description: 'CallbackData if passed by the application in the receiptRequest element during the associated subscription operation' - type: string - terminalLocation: - description: 'Collection of the terminal locations.' - type: array - items: - $ref: '#/components/schemas/TerminalLocation' - enteringLeavingCriteria: - $ref: '#/components/schemas/EnteringLeavingCriteria' - description: 'Indicates whether the notification was caused by the terminal entering or leaving the target area.' - distanceCriteria: - $ref: '#/components/schemas/DistanceCriteria' - description: 'Indicates which distance criteria that caused the notification.' - isFinalNotification: - description: 'Set to true if it is a final notification about location change.' - type: boolean - link: - description: 'Link to other resources that are in relationship with the resource.' - type: array - items: - $ref: '#/components/schemas/Link' - SubscriptionCancellationNotification: - description: 'A type containing the subscription cancellation notification.' - type: object - required: - - terminalLocation - properties: - callbackData: - description: 'CallbackData if passed by the application in the receiptRequest element during the associated subscription operation' - type: string - address: - description: 'Address of terminal if the error applies to an individual terminal.' - type: string - reason: - $ref: '#/components/schemas/ServiceError' - description: 'Reason notification is being discontinued.' - link: - description: 'Link to other resources that are in relationship with the resource.' - type: array - items: - $ref: '#/components/schemas/Link' TerminalLocation: description: 'A type containing device address, retrieval status and location information.' type: object @@ -800,11 +206,6 @@ manual_types: errorInformation: $ref: '#/components/schemas/ServiceError' description: 'This is the reason for error.' - TerminalLocationList: - description: 'Collection of the terminal locations.' - type: array - items: - $ref: '#/components/schemas/TerminalLocation' RetrievalStatus: type: string enum: @@ -834,7 +235,7 @@ info: contact: url: https://forge.etsi.org/rep/mec/gs013-location-api title: 'ETSI GS MEC 013 Location API' - version: 2.1.1 + version: 3.2.1 description: The ETSI MEC ISG Location API described using OpenAPI. license: name: BSD-3-Clause diff --git a/doc/gs_mec013v030201p.docx b/doc/gs_mec013v030201p.docx new file mode 100644 index 0000000000000000000000000000000000000000..a90499f465644b956f47367c3ad4903bd938a146 Binary files /dev/null and b/doc/gs_mec013v030201p.docx differ