From 71ebbd8b8b4165934b2208f5235d1c02e6b596c5 Mon Sep 17 00:00:00 2001 From: Simon Pastor Date: Mon, 4 May 2020 18:00:42 -0400 Subject: [PATCH] loc-serv notifications implementation --- LocationAPIv1-notifications.yaml | 337 +++++++ LocationAPIv1.yaml | 1441 ++++++++++++++++++++++++++++++ 2 files changed, 1778 insertions(+) create mode 100644 LocationAPIv1-notifications.yaml create mode 100644 LocationAPIv1.yaml diff --git a/LocationAPIv1-notifications.yaml b/LocationAPIv1-notifications.yaml new file mode 100644 index 0000000..0185cd3 --- /dev/null +++ b/LocationAPIv1-notifications.yaml @@ -0,0 +1,337 @@ +--- +swagger: "2.0" +info: + version: "1.0.0" + title: "AdvantEDGE Location Service Subscription Notification REST API" + contact: + name: InterDigital AdvantEDGE Support + email: AdvantEDGE@InterDigital.com + description: "This API enables the Location Service to post location events to edge applications +

**Micro-service**
None +

**Type & Usage**
User's Edge Applications subscribing to Location events must implement this API +

**Details**
API details available at _your-AdvantEDGE-ip-address/api_ +

**Note**
This API is not exposed by default on the AdvantEDGE platform" + license: + name: "Apache 2.0" + url: "https://github.com/InterDigitalInc/AdvantEDGE/blob/master/LICENSE" +basePath: "/location-notif/v1" +externalDocs: + description: "Find out more about MEC Location Services" + url: "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_MEC013v010101p.pdf" +tags: +- name: "notifications" +consumes: +- "application/json" +produces: +- "application/json" +paths: + /location_notifications/{subscriptionId}: + post: + tags: + - "notifications" + summary: "This operation is used by the AdvantEDGE Location Service to issue\ + \ a callback notification towards an ME application with a zonal or user tracking\ + \ subscription" + description: "Zonal or User location tracking subscription notification" + operationId: "postTrackingNotification" + parameters: + - name: "subscriptionId" + in: "path" + description: "Identity of a notification subscription (user or zonal)" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + - in: "body" + name: "Notification" + description: "Zonal or User Tracking Notification" + required: true + schema: + $ref: "#/definitions/TrackingNotification" + x-exportParamName: "Notification" + responses: + 204: + description: "No Content" + /zone_status_notifications/{subscriptionId}: + post: + tags: + - "notifications" + summary: "This operation is used by the AdvantEDGE Location Service to issue\ + \ a callback notification towards an ME application with a zone status tracking\ + \ subscription" + description: "Zone status tracking subscription notification" + operationId: "postZoneStatusNotification" + parameters: + - name: "subscriptionId" + in: "path" + description: "Identity of a notification subscription (user or zonal)" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + - in: "body" + name: "Notification" + description: "Zone Status Notification" + required: true + schema: + $ref: "#/definitions/ZoneStatusNotification" + x-exportParamName: "Notification" + responses: + 204: + description: "No Content" +definitions: + Link: + type: "object" + required: + - "href" + - "rel" + properties: + rel: + type: "object" + description: "Describes the relationship between the URI and the resource." + properties: {} + href: + type: "object" + description: "URI" + properties: {} + description: "Link to other resources" + OperationStatus: + type: "string" + description: "The operation status of the access point" + example: "Serviceable" + enum: + - "Serviceable" + - "Unserviceable" + - "Unknown" + SubscriptionId: + type: "string" + description: "Unique Identifier for a notification subscription. Created by the\ + \ MEC Location Service and used to reference an individual subscription" + example: "sub123" + TrackingNotification: + type: "object" + required: + - "callbackData" + properties: + callbackData: + type: "string" + description: "CallBackData if passed by the application during the associated\ + \ ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common]." + example: "1234" + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + address: + type: "string" + format: "uri" + description: "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)." + example: "acr:192.0.2.1" + interestRealm: + type: "string" + description: "Interest realm of access point (e.g. geographical area, a type of\ + \ industry etc.)." + example: "LA" + userEventType: + $ref: "#/definitions/UserEventType" + currentAccessPointId: + type: "string" + description: "Zone ID" + example: "zone01" + previousAccessPointId: + type: "string" + description: "Zone ID" + example: "zone02" + timestamp: + type: "string" + format: "date-time" + description: "Indicates the time of day for zonal presence notification." + example: "2017-01-01T02:51:43Z" + description: "Zonal or User tracking notification - callback generated toward\ + \ an ME app with a zonal or user tracking subscription" + example: + address: "acr:10.1.34.67" + userEventType: {} + callbackData: "1234" + previousAccessPointId: "001010000000000000000000000000001 or poa001" + zoneId: "zone001" + interestRealma: "NY" + currentAccessPointId: "001010000000000000000000000000001 or poa001" + timestamp: "2017-01-01T02:51:43Z" + UserInfo: + type: "object" + required: + - "accessPointId" + - "address" + - "resourceURL" + - "zoneId" + properties: + userId: + type: "string" + description: "Unique identifier of a user or client node" + example: "client001" + address: + type: "string" + format: "uri" + description: "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)." + example: "acr:192.0.2.1" + accessPointId: + type: "string" + description: "Identifier of access point, (reference\ + \ ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity\ + \ (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit\ + \ MNC. The Cell Portion is an optional element" + example: "001010000000000000000000000000001" + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + resourceURL: + type: "string" + format: "url" + description: "URL where the UE may be contacted for some service (application\ + \ specific)" + example: "http://localhost:8291/myService/123456" + UserList: + type: "object" + required: + - "userList" + properties: + userList: + type: "array" + items: + $ref: "#/definitions/UserInfo" + UserEventType: + type: "string" + enum: + - "Entering" + - "Transferring" + - "Leaving" + UserTrackingNotification: + type: "object" + required: + - "callbackData" + - "timeStamp" + - "userInfo" + properties: + callbackData: + type: "string" + description: "CallBackData if passed by the application during the associated\ + \ ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common]." + example: "1234" + userInfo: + $ref: "#/definitions/UserInfo" + timeStamp: + type: "string" + format: "date-time" + description: "Indicates the time of day for zonal presence notification." + example: "2017-01-01T02:51:43Z" + userEventType: + $ref: "#/definitions/UserEventType" + description: "User tracking notification - callback generated toward an ME app\ + \ with a user tracking subscription" + ZoneInfo: + type: "object" + required: + - "numberOfAccessPoints" + - "numberOfUsers" + - "zoneId" + properties: + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + numberOfAccessPoints: + type: "integer" + format: "uint32" + description: "Number of access points or points of access within a Location Zone" + example: "10" + numberOfUsers: + type: "integer" + format: "uint32" + description: "The number of users currently on the access point" + example: "7" + description: "A type containing zone information." + ZoneStatusNotification: + type: "object" + required: + - "timestamp" + - "zoneId" + properties: + callbackData: + type: "string" + description: "CallBackData if passed by the application during the associated\ + \ ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common]." + example: "1234" + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + accessPointId: + type: "string" + description: "Identifier of access point, (reference\ + \ ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity\ + \ (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit\ + \ MNC. The Cell Portion is an optional element" + example: "001010000000000000000000000000001" + numberOfUsersInZone: + type: "integer" + format: "uint32" + 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." + example: "20" + numberOfUsersInAP: + type: "integer" + format: "uint32" + 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." + example: "12" + operationStatus: + $ref: "#/definitions/OperationStatus" + timestamp: + type: "string" + format: "date-time" + description: "Indicates the time of day for zonal presence notification." + example: "2017-01-01T02:51:43Z" + link: + type: "array" + example: "rel=\"ZonalStatusSubscription\" href=\"http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123\"" + description: "Link to other resources that are in relationship with this notification.\ + \ The server SHOULD include a link to the related subscription. No other\ + \ links are required or suggested by this specification." + items: + $ref: "#/definitions/Link" + description: "A type containing zone status notification." + example: + operationStatus: "Serviceable" + callbackData: "1234" + accessPointId: "001010000000000000000000000000001 or poa001" + link: "rel=\"ZonalStatusSubscription\" href=\"http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123\"" + zoneId: "zone001" + numberOfUsersInZone: "20" + numberOfUsersInAP: "12" + timestamp: "2017-01-01T02:51:43Z" +parameters: + Path.SubscriptionId: + name: "subscriptionId" + in: "path" + description: "Identity of a notification subscription (user or zonal)" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + Body.TrackingNotification: + in: "body" + name: "Notification" + description: "Zonal or User Tracking Notification" + required: true + schema: + $ref: "#/definitions/TrackingNotification" + x-exportParamName: "Notification" + Body.ZoneStatusNotification: + in: "body" + name: "Notification" + description: "Zone Status Notification" + required: true + schema: + $ref: "#/definitions/ZoneStatusNotification" + x-exportParamName: "Notification" diff --git a/LocationAPIv1.yaml b/LocationAPIv1.yaml new file mode 100644 index 0000000..6992e58 --- /dev/null +++ b/LocationAPIv1.yaml @@ -0,0 +1,1441 @@ +--- +swagger: "2.0" +info: + version: "1.1.1" + title: "AdvantEDGE Location Service REST API" + contact: + name: InterDigital AdvantEDGE Support + email: AdvantEDGE@InterDigital.com + description: "Location Service is AdvantEDGE's implementation of + [ETSI MEC ISG MEC013 Location API](http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf) +

The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence +

[Copyright (c) ETSI 2017](https://forge.etsi.org/etsi-forge-copyright-notice.txt) +

**Micro-service**
[meep-loc-serv](https://github.com/InterDigitalInc/AdvantEDGE/tree/master/go-apps/meep-loc-serv) +

**Type & Usage**
Edge Service used by edge applications that want to get information about Users (UE) and Zone locations +

**Details**
API details available at _your-AdvantEDGE-ip-address/api_" + license: + name: "Apache 2.0" + url: "https://github.com/InterDigitalInc/AdvantEDGE/blob/master/LICENSE" +basePath: "/location/v1" +externalDocs: + description: "ETSI MEC013 V1.1.1 Location Service API" + url: "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf" +tags: +- name: "zones" +- name: "users" +- name: "subscriptions" +consumes: +- "application/json" +produces: +- "application/json" +paths: + /zones: + get: + tags: + - "zones" + description: "Used to get a list of identifiers for zones authorized for use\ + \ by the application." + operationId: "zonesGet" + produces: + - "application/json" + parameters: [] + responses: + 200: + description: "Successful response to a query regarding the status of a zone" + examples: + application/json: + zoneList: + zone: + - zoneId: "zone01" + numberOfAccessPoints: "3" + numberOfUnserviceableAccessPoints: "1" + numberOfUsers: "10" + resourceURL: "http://example.com/etsi-013/location/v1/zones/zone01" + - zoneId: "zone02" + numberOfAccessPoints: "12" + numberOfUnserviceableAccessPoints: "0" + numberOfUsers: "36" + resourceURL: "http://example.com/etsi-013/location/v1/zones/zone02" + resourceURL: "http://example.com/etsi-013/location/v1/zones" + schema: + $ref: "#/definitions/ResponseZoneList" + /zones/{zoneId}: + get: + tags: + - "zones" + description: "Used to get the status of a zone." + operationId: "zonesGetById" + produces: + - "application/json" + parameters: + - name: "zoneId" + in: "path" + description: "Zone ID" + required: true + type: "string" + x-exportParamName: "ZoneId" + responses: + 200: + description: "Successful response to a query regarding the status of a zone" + examples: + application/json: + zoneInfo: + zoneId: "zone01" + numberOfAccessPoints: "3" + numberOfUnserviceableAccessPoints: "1" + numberOfUsers: "10" + resourceURL: "http://example.com/etsi-013/location/v1/zones/zone01" + schema: + $ref: "#/definitions/ResponseZoneInfo" + /zones/{zoneId}/accessPoints: + get: + tags: + - "zones" + description: "Access point status can be retrieved for sets of access points\ + \ matching attribute in the request." + operationId: "zonesByIdGetAps" + produces: + - "application/json" + parameters: + - name: "zoneId" + in: "path" + description: "Zone ID" + required: true + type: "string" + x-exportParamName: "ZoneId" + - name: "interestRealm" + in: "query" + description: "Interest realm of access point (e.g. geographical area, a type\ + \ of industry etc.)." + required: false + type: "string" + x-exportParamName: "InterestRealm" + x-optionalDataType: "String" + responses: + 200: + description: "Successful response to a query a named set of access point\ + \ status request" + examples: + application/json: + accessPointList: + zoneId: "zone01" + accessPoint: + - accessPointId: "001010000000000000000000000000001" + locationInfo: + latitude: "90.123" + longitude: "80.123" + altitude: "10.0" + accuracy: "0" + connectionType: "Macro" + operationStatus: "Serviceable" + numberOfUsers: "5" + interestRealm: "LA" + resourceURL: "http://example.com/etsi-013/location/v1/zones/zone01/accessPoints/ap001" + - accessPointId: "001010000000000000000000000000010" + locationInfo: + latitude: "91.123" + longitude: "81.123" + altitude: "12.0" + accuracy: "1" + connectionType: "Macro" + operationStatus: "Unserviceable" + numberOfUsers: "0" + interestRealm: "DC" + resourceURL: "http://example.com/etsi-013/location/v1/zones/zone01/accessPoints/ap002" + - accessPointId: "001010000000000000000000000000011" + locationInfo: + latitude: "93.123" + longitude: "83.123" + altitude: "16.0" + accuracy: "3" + connectionType: "Macro" + operationStatus: "Serviceable" + numberOfUsers: "5" + interestRealm: "NJ" + resourceURL: "http://example.com/etsi-013/location/v1/zones/zone01/accessPoints/ap003" + resourceURL: "http://example.com/etsi-013/location/v1/zones/zone01/accessPoints" + schema: + $ref: "#/definitions/ResponseAccessPointList" + /zones/{zoneId}/accessPoints/{accessPointId}: + get: + tags: + - "zones" + description: "Access point status can be retrieved for sets of access points\ + \ matching attribute in the request." + operationId: "zonesByIdGetApsById" + produces: + - "application/json" + parameters: + - name: "zoneId" + in: "path" + description: "Zone ID" + required: true + type: "string" + x-exportParamName: "ZoneId" + - name: "accessPointId" + in: "path" + description: "Access Point ID" + required: true + type: "string" + x-exportParamName: "AccessPointId" + responses: + 200: + description: "Successful response to a query a named set of access point\ + \ status request" + examples: + application/json: + accessPointInfo: + accessPointId: "001010000000000000000000000000001" + locationInfo: + latitude: "90.123" + longitude: "80.123" + altitude: "10.0" + accuracy: "0" + connectionType: "Macro" + operationStatus: "Serviceable" + numberOfUsers: "5" + interestRealm: "LA" + resourceURL: "http://example.com/etsi-013/location/v1/zones/zone001/accessPoints/ap001" + schema: + $ref: "#/definitions/ResponseAccessPointInfo" + /users: + get: + tags: + - "users" + description: "Users currently using a zone may be retrieved for sets of access\ + \ points matching attribute in the request" + operationId: "usersGet" + produces: + - "application/json" + parameters: + - name: "zoneId" + in: "query" + description: "Zone ID" + required: true + type: "string" + x-exportParamName: "ZoneId" + - name: "accessPointId" + in: "query" + description: "Identifier of access point, reference \"definitions\" for string\ + \ format" + required: false + type: "string" + x-exportParamName: "AccessPointId" + x-optionalDataType: "String" + responses: + 200: + description: "Successful response to a query users within a zone request" + examples: + application/json: + userList: + user: + - address: "acr:192.0.2.1" + accessPointId: "001010000000000000000000000000001" + zoneId: "zone01" + resourceURL: "http://example.com/etsi-013/location/v1/users/acr%3A192.0.2.1" + - address: "acr:192.0.2.2" + accessPointId: "001010000000000000000000000000001" + zoneId: "zone01" + resourceURL: "http://example.com/etsi-013/location/v1/users/acr%3A192.0.2.2" + - address: "acr:192.0.2.3" + accessPointId: "001010000000000000000000000000010" + zoneId: "zone01" + resourceURL: "http://example.com/etsi-013/location/v1/users/acr%3A192.0.2.3" + - address: "acr:192.0.2.4" + accessPointId: "001010000000000000000000000000001" + zoneId: "zone02" + resourceURL: "http://example.com/etsi-013/location/v1/users/acr%3A192.0.2.4" + - address: "acr:192.0.2.5" + accessPointId: "001010000000000000000000000000010" + zoneId: "zone02" + resourceURL: "http://example.com/etsi-013/location/v1/users/acr%3A192.0.2.5" + resourceURL: "http://example.com/etsi-013/location/v1/users" + schema: + $ref: "#/definitions/ResponseUserList" + /users/{userId}: + get: + tags: + - "users" + description: "Users currently using a zone may be retrieved for sets of access\ + \ points matching attribute in the request" + operationId: "usersGetById" + produces: + - "application/json" + parameters: + - name: "userId" + in: "path" + description: "User ID" + required: true + type: "string" + x-exportParamName: "UserId" + responses: + 200: + description: "Successful response to a query users within a zone request" + examples: + application/json: + userInfo: + address: "acr:192.0.2.1" + accessPointId: "001010000000000000000000000000001" + zoneId: "zone01" + resourceURL: "http://example.com/etsi-013/location/v1/users/acr%3A192.0.2.1" + locationInfo: + latitude: "90.123" + longitude: "80.123" + altitude: "10.0" + accuracy: "0" + contextLocationInfo: "GroundFloor" + schema: + $ref: "#/definitions/ResponseUserInfo" + /subscriptions/zonalTraffic: + get: + tags: + - "subscriptions" + description: "This operation is used for retrieving all active subscriptions\ + \ to zonal traffic change notifications." + operationId: "zonalTrafficSubGet" + produces: + - "application/json" + parameters: [] + responses: + 200: + description: "Response to retrieve zonal traffic subscriptions" + examples: + application/json: + notificationSubscriptionList: + zonalTrafficSubscription: + - clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zonalTraffic/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: "zone01" + interestRealm: "LA" + userEventCriteria: "Transferring" + - clientCorrelator: "0124" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zonalTraffic/subscription124" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123457" + zoneId: "zone02" + interestRealm: "LA" + userEventCriteria: "Transferring" + resourceURL: "http://example.com/etsi-013/location/v1/zonalTraffic" + schema: + $ref: "#/definitions/ResponseZonalTrafficNotificationSubscriptionList" + post: + tags: + - "subscriptions" + description: "This operation is used for creating a new subscription to zonal\ + \ traffic change notification." + operationId: "zonalTrafficSubPost" + produces: + - "application/json" + parameters: + - in: "body" + name: "zonalTrafficSubscription" + description: "Zonal Traffic Subscription" + required: true + schema: + $ref: "#/definitions/ZonalTrafficSubscription" + x-exportParamName: "ZonalTrafficSubscription" + responses: + 201: + description: "Response to create new zonal traffic subscription" + examples: + application/json: + zonalTrafficSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zonalTraffic/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: "zone01" + interestRealm: "LA" + userEventCriteria: "Transferring" + schema: + $ref: "#/definitions/ResponseZonalTrafficSubscription" + /subscriptions/zonalTraffic/{subscriptionId}: + get: + tags: + - "subscriptions" + description: "This operation is used for updating an individual subscription\ + \ to zonal traffic change notification." + operationId: "zonalTrafficSubGetById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + responses: + 200: + description: "Response to retrieve individual zonal traffic subscription" + examples: + application/json: + zonalTrafficSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zonalTraffic/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: "zone01" + interestRealm: "LA" + userEventCriteria: "Transferring" + schema: + $ref: "#/definitions/ResponseZonalTrafficSubscription" + put: + tags: + - "subscriptions" + description: "This operation is used for updating an individual subscription\ + \ to zonal traffic change notification." + operationId: "zonalTrafficSubPutById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + - in: "body" + name: "zonalTrafficSubscription" + description: "Zonal Traffic Subscription" + required: true + schema: + $ref: "#/definitions/ZonalTrafficSubscription" + x-exportParamName: "ZonalTrafficSubscription" + responses: + 200: + description: "Response to update individual zonal traffic subscription" + examples: + application/json: + zonalTrafficSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zonalTraffic/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: "zone01" + interestRealm: "LA" + userEventCriteria: "Transferring" + schema: + $ref: "#/definitions/ResponseZonalTrafficSubscription" + delete: + tags: + - "subscriptions" + description: "This operation is used for cancelling a subscription and stopping\ + \ corresponding notifications." + operationId: "zonalTrafficSubDelById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + responses: + 204: + description: "No content" + /subscriptions/userTracking: + get: + tags: + - "subscriptions" + description: "This operation is used for retrieving all active subscriptions\ + \ to user tracking change notifications." + operationId: "userTrackingSubGet" + produces: + - "application/json" + parameters: [] + responses: + 200: + description: "Response to retrieve user tracking subscriptions" + examples: + application/json: + notificationSubscriptionList: + userTrackingSubscription: + - clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + address: "acr:192.0.2.1" + userEventCriteria: "Transferring" + - clientCorrelator: "0124" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription124" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + address: "acr:192.0.2.2" + userEventCriteria: "Transferring" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking" + schema: + $ref: "#/definitions/ResponseUserTrackingNotificationSubscriptionList" + post: + tags: + - "subscriptions" + description: "This operation is used for creating a new subscription to user\ + \ tracking change notification" + operationId: "userTrackingSubPost" + produces: + - "application/json" + parameters: + - in: "body" + name: "userTrackingSubscription" + description: "User Tracking Subscription" + required: true + schema: + $ref: "#/definitions/UserTrackingSubscription" + x-exportParamName: "UserTrackingSubscription" + responses: + 201: + description: "Response to create new user tracking subscription" + examples: + application/json: + userTrackingSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + address: "acr:192.0.2.1" + userEventCriteria: "Transferring" + schema: + $ref: "#/definitions/ResponseUserTrackingSubscription" + /subscriptions/userTracking/{subscriptionId}: + get: + tags: + - "subscriptions" + description: "This operation is used for retrieving an individual subscription\ + \ to user tracking change notification." + operationId: "userTrackingSubGetById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + responses: + 200: + description: "Response to retrieve individual user tracking subscription" + examples: + application/json: + userTrackingSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + address: "acr:192.0.2.1" + userEventCriteria: "Transferring" + schema: + $ref: "#/definitions/ResponseUserTrackingSubscription" + put: + tags: + - "subscriptions" + description: "This operation is used for updating an individual subscription\ + \ to user tracking change notification." + operationId: "userTrackingSubPutById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + - in: "body" + name: "userTrackingSubscription" + description: "User Tracking Subscription" + required: true + schema: + $ref: "#/definitions/UserTrackingSubscription" + x-exportParamName: "UserTrackingSubscription" + responses: + 200: + description: "Response to update individual user tracking subscription" + examples: + application/json: + userTrackingSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + address: "acr:192.0.2.1" + userEventCriteria: "Transferring" + schema: + $ref: "#/definitions/ResponseUserTrackingSubscription" + delete: + tags: + - "subscriptions" + description: "This operation is used for retrieving an individual subscription\ + \ to user tracking change notification." + operationId: "userTrackingSubDelById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + responses: + 204: + description: "No Content" + /subscriptions/zonalStatus: + get: + tags: + - "subscriptions" + description: "This operation is used for creating a new subscription to zone\ + \ status change notification." + operationId: "zoneStatusGet" + produces: + - "application/json" + parameters: [] + responses: + 200: + description: "Response to retrieve zone status subscriptions" + examples: + application/json: + notificationSubscriptionList: + zoneStatusSubscription: + - clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zoneStatus/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: "zone01" + numberOfUsersZoneThreshold: "500" + operationStatus: "Serviceable" + - clientCorrelator: "0124" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zoneStatus/subscription124" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123457" + zoneId: "zone02" + numberOfUsersAPThreshold: "50" + operationStatus: "Serviceable" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zoneStatus" + schema: + $ref: "#/definitions/ResponseZoneStatusNotificationSubscriptionList" + post: + tags: + - "subscriptions" + description: "This operation is used for creating a new subscription to zone\ + \ status change notification." + operationId: "zoneStatusPost" + produces: + - "application/json" + parameters: + - in: "body" + name: "zoneStatusSubscription" + description: "Zone Status Subscription" + required: true + schema: + $ref: "#/definitions/ZoneStatusSubscription" + x-exportParamName: "ZoneStatusSubscription" + responses: + 201: + description: "Response to create new zone status subscription" + examples: + application/json: + zoneStatusSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zoneStatus/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: "zone01" + numberOfUsersZoneThreshold: "500" + operationStatus: "Serviceable" + schema: + $ref: "#/definitions/ResponseZoneStatusSubscription" + /subscriptions/zoneStatus/{subscriptionId}: + get: + tags: + - "subscriptions" + description: "This operation is used for retrieving an individual subscription\ + \ to zone status change notification." + operationId: "zoneStatusGetById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + responses: + 200: + description: "Response to retrieve individual zone status subscription" + examples: + application/json: + zoneStatusSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zoneStatus/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: "zone01" + numberOfUsersZoneThreshold: "500" + operationStatus: "Serviceable" + schema: + $ref: "#/definitions/ResponseZoneStatusSubscription2" + put: + tags: + - "subscriptions" + description: "This operation is used for updating an individual subscription\ + \ to zone status change notification." + operationId: "zoneStatusPutById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + - in: "body" + name: "zoneStatusSubscription" + description: "Zone Status Subscription" + required: true + schema: + $ref: "#/definitions/ZoneStatusSubscription" + x-exportParamName: "ZoneStatusSubscription" + responses: + 200: + description: "Response to update individual zone status subscription" + examples: + application/json: + zoneStatusSubscription: + clientCorrelator: "0123" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/zoneStatus/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: "zone01" + numberOfUsersZoneThreshold: "500" + operationStatus: "Serviceable" + schema: + $ref: "#/definitions/ResponseZoneStatusSubscription2" + delete: + tags: + - "subscriptions" + description: "This operation is used for cancelling a subscription and stopping\ + \ corresponding notifications." + operationId: "zoneStatusDelById" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + responses: + 204: + description: "No content" +definitions: + AccessPointInfo: + type: "object" + required: + - "accessPointId" + - "connectionType" + - "numberOfUsers" + - "operationStatus" + - "resourceURL" + properties: + accessPointId: + type: "string" + description: "Identifier of access point, (reference\ + \ ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity\ + \ (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit\ + \ MNC. The Cell Portion is an optional element" + example: "001010000000000000000000000000001" + locationInfo: + $ref: "#/definitions/LocationInfo" + connectionType: + $ref: "#/definitions/ConnectionType" + operationStatus: + $ref: "#/definitions/OperationStatus" + numberOfUsers: + type: "integer" + format: "uint32" + description: "The number of users currently on the access point." + example: "7" + timezone: + type: "string" + format: "date-time" + description: "Time zone of access point" + example: "2017-01-01T02:51:43Z" + interestRealm: + type: "string" + description: "Interest realm of access point (e.g. geographical area, a type of\ + \ industry etc.)." + example: "LA" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + description: "A type containing access point information." + AccessPointList: + type: "object" + required: + - "resourceURL" + - "zoneId" + properties: + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + accessPoint: + type: "array" + description: "Collection of the access point information list." + items: + $ref: "#/definitions/AccessPointInfo" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + description: "A type containing list of access points." + ConnectionType: + type: "string" + description: "The connection type for the access point" + example: "Macro" + enum: + - "Femto" + - "LTE-femto" + - "Smallcell" + - "LTE-smallcell" + - "Wifi" + - "Pico" + - "Micro" + - "Macro" + - "Wimax" + - "Unknown" + Link: + type: "object" + required: + - "href" + - "rel" + properties: + rel: + type: "object" + description: "Describes the relationship between the URI and the resource." + properties: {} + href: + type: "object" + description: "URI" + properties: {} + description: "Link to other resources" + LocationInfo: + type: "object" + required: + - "accuracy" + - "latitude" + - "longitude" + properties: + latitude: + type: "number" + format: "float" + example: 80.123 + longitude: + type: "number" + format: "float" + example: 70.123 + altitude: + type: "number" + format: "float" + example: 10.0 + accuracy: + type: "integer" + format: "int32" + example: 10 + description: "A type containing location information with latitude, longitude\ + \ and altitude, in addition the accuracy of the information are provided." + OperationStatus: + type: "string" + description: "The operation status of the access point" + example: "Serviceable" + enum: + - "Serviceable" + - "Unserviceable" + - "Unknown" + UserEventType: + type: "string" + description: "User event" + example: "Entering" + enum: + - "Entering" + - "Leaving" + - "Transferring" + UserInfo: + type: "object" + required: + - "accessPointId" + - "address" + - "resourceURL" + - "zoneId" + properties: + address: + type: "string" + format: "uri" + description: "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)." + example: "acr:192.0.2.1" + accessPointId: + type: "string" + description: "Identifier of access point, (reference\ + \ ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity\ + \ (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit\ + \ MNC. The Cell Portion is an optional element" + example: "001010000000000000000000000000001" + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + locationInfo: + $ref: "#/definitions/LocationInfo" + contextLocationInfo: + type: "string" + description: "Contextual information of a user location (e.g., aisle, floor, room\ + \ number, etc.)" + example: "GroundFloor" + ancillaryInfo: + type: "string" + description: "Reserved for future use." + description: "A type containing user information." + UserList: + type: "object" + required: + - "resourceURL" + properties: + user: + type: "array" + description: "Collection of the zone information list." + items: + $ref: "#/definitions/UserInfo" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + description: "A type containing list of users." + UserTrackingSubscription: + type: "object" + required: + - "address" + - "callbackReference" + properties: + clientCorrelator: + type: "string" + description: "Uniquely identifies this create subscription request. If there is\ + \ a communication failure during the request, using the same clientCorrelator\ + \ when retrying the request allows the operator to avoid creating a duplicate\ + \ subscription." + example: "0123" + callbackReference: + type: "object" + required: + - "notifyURL" + properties: + notifyURL: + type: "string" + format: "url" + description: "The URL of your own listener application." + example: "http://clientApp.example.com/location_notifications/123456" + description: "Notification callback definition." + example: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + address: + type: "string" + format: "uri" + description: "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)." + example: "acr:192.0.2.1" + userEventCriteria: + type: "array" + description: "List of user event values to generate notifications for (these apply\ + \ to address specified). If this element is missing, a notification is requested\ + \ to be generated for any change in user event." + items: + $ref: "#/definitions/UserEventType" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + description: "A type containing user tracking subscription." + example: + address: "acr:192.0.2.1" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + clientCorrelator: "0123" + userEventCriteria: "" + ZonalPresenceNotification: + type: "object" + required: + - "address" + - "currentAccessPointId" + - "timestamp" + - "userEventType" + - "zoneId" + properties: + callbackData: + type: "string" + description: "CallBackData if passed by the application during the associated\ + \ ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common]." + example: "1234" + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + address: + type: "string" + format: "uri" + description: "Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)." + example: "acr:192.0.2.1" + interestRealm: + type: "string" + description: "Interest realm of access point (e.g. geographical area, a type of\ + \ industry etc.)." + example: "LA" + userEventType: + $ref: "#/definitions/UserEventType" + currentAccessPointId: + type: "string" + description: "Zone ID" + example: "zone01" + previousAccessPointId: + type: "string" + description: "Zone ID" + example: "zone02" + timestamp: + type: "string" + format: "date-time" + description: "Indicates the time of day for zonal presence notification." + example: "2017-01-01T02:51:43Z" + link: + type: "array" + example: "rel=\"ZonalTrafficSubscription\" href=\"http://example.com/etsi-013/location/v1/subscriptions/zonalTraffic/sub123\"\ + /" + description: "Link to other resources that are in relationship with this notification.\ + \ The server SHOULD include a link to the related subscription. No other\ + \ links are required or suggested by this specification." + items: + $ref: "#/definitions/Link" + description: "A type containing zonal presence notification" + ZonalTrafficSubscription: + type: "object" + required: + - "callbackReference" + - "zoneId" + properties: + clientCorrelator: + type: "string" + description: "Uniquely identifies this create subscription request. If there is\ + \ a communication failure during the request, using the same clientCorrelator\ + \ when retrying the request allows the operator to avoid creating a duplicate\ + \ subscription." + example: "0123" + callbackReference: + type: "object" + required: + - "notifyURL" + properties: + notifyURL: + type: "string" + format: "url" + description: "The URL of your own listener application." + example: "http://clientApp.example.com/location_notifications/123456" + description: "Notification callback definition." + example: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + interestRealm: + type: "array" + description: "Interest realms of access points within a zone (e.g. geographical\ + \ area, a type of industry etc.)." + items: + type: "string" + description: "Interest realm of access point (e.g. geographical area, a type of\ + \ industry etc.)." + example: "LA" + userEventCriteria: + type: "array" + description: "List of user event values to generate notifications for (these\ + \ apply to zone identifier or all interest realms within zone identifier\ + \ specified). If this element is missing, a notification is requested to\ + \ be generated for any change in user event." + items: + $ref: "#/definitions/UserEventType" + duration: + type: "string" + 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." + example: "0" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + description: "A type containing zonal traffic subscription" + example: + duration: "0" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + clientCorrelator: "0123" + zoneId: "zone01" + interestRealm: + - "LA" + userEventCriteria: + - "Entering" + ZoneInfo: + type: "object" + required: + - "numberOfAccessPoints" + - "numberOfUnservicableAccessPoints" + - "numberOfUsers" + - "resourceURL" + - "zoneId" + properties: + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + numberOfAccessPoints: + type: "integer" + format: "uint32" + description: "The number of access points within the zone" + example: "10" + numberOfUnservicableAccessPoints: + type: "integer" + format: "uint32" + description: "Number of inoperable access points within the zone." + example: "9" + numberOfUsers: + type: "integer" + format: "uint32" + description: "The number of users currently on the access point." + example: "7" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + description: "A type containing zone information." + ZoneList: + type: "object" + required: + - "resourceURL" + properties: + zone: + type: "array" + description: "Collection of the zone information list." + items: + $ref: "#/definitions/ZoneInfo" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + description: "Collection of the zone information list." + ZoneStatusNotification: + type: "object" + required: + - "timestamp" + - "zoneId" + properties: + callbackData: + type: "string" + description: "CallBackData if passed by the application during the associated\ + \ ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common]." + example: "1234" + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + accessPointId: + type: "string" + description: "Identifier of access point, (reference\ + \ ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity\ + \ (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit\ + \ MNC. The Cell Portion is an optional element" + example: "001010000000000000000000000000001" + numberOfUsersInZone: + type: "integer" + format: "uint32" + 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." + example: "20" + numberOfUsersInAP: + type: "integer" + format: "uint32" + 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." + example: "12" + operationStatus: + $ref: "#/definitions/OperationStatus" + timestamp: + type: "string" + format: "date-time" + description: "Indicates the time of day for zonal presence notification." + example: "2017-01-01T02:51:43Z" + link: + type: "array" + example: "rel=\"ZonalStatusSubscription\" href=\"http://example.com/etsi-013/location/v1/subscriptions/zonalStatus/sub123\"" + description: "Link to other resources that are in relationship with this notification.\ + \ The server SHOULD include a link to the related subscription. No other\ + \ links are required or suggested by this specification." + items: + $ref: "#/definitions/Link" + description: "A type containing zone status notification." + ZoneStatusSubscription: + type: "object" + required: + - "callbackReference" + - "zoneId" + properties: + clientCorrelator: + type: "string" + description: "Uniquely identifies this create subscription request. If there is\ + \ a communication failure during the request, using the same clientCorrelator\ + \ when retrying the request allows the operator to avoid creating a duplicate\ + \ subscription." + example: "0123" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + callbackReference: + type: "object" + required: + - "notifyURL" + properties: + notifyURL: + type: "string" + format: "url" + description: "The URL of your own listener application." + example: "http://clientApp.example.com/location_notifications/123456" + description: "Notification callback definition." + example: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + zoneId: + type: "string" + description: "Identifier of zone" + example: "zone01" + numberOfUsersZoneThreshold: + type: "integer" + format: "uint32" + description: "Threshold number of users in a zone which if crossed shall cause\ + \ a notification." + example: "40" + numberOfUsersAPThreshold: + type: "integer" + format: "uint32" + description: "Threshold number of users in an access point which if crossed shall\ + \ cause a notification." + example: "20" + operationStatus: + type: "array" + description: "List of operation status values to generate notifications for\ + \ (these apply to all access points within a zone)." + items: + $ref: "#/definitions/OperationStatus" + description: "A type containing zone status subscription." + example: + operationStatus: + - "Serviceable" + - "Serviceable" + resourceURL: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + numberOfUsersAPThreshold: "20" + callbackReference: + notifyURL: "http://clientApp.example.com/location_notifications/123456" + clientCorrelator: "0123" + zoneId: "zone01" + numberOfUsersZoneThreshold: "40" + UserTrackingNotificationSubscriptionList: + properties: + userTrackingSubscription: + type: "array" + items: + $ref: "#/definitions/UserTrackingSubscription" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + ZonalTrafficNotificationSubscriptionList: + properties: + zonalTrafficSubscription: + type: "array" + items: + $ref: "#/definitions/ZonalTrafficSubscription" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + ZoneStatusNotificationSubscriptionList: + properties: + zoneStatusSubscription: + type: "array" + items: + $ref: "#/definitions/ZoneStatusSubscription" + resourceURL: + type: "string" + format: "uri" + description: "Self referring URL." + example: "http://example.com/etsi-013/location/v1/subscriptions/userTracking/subscription123" + ResponseAccessPointInfo: + properties: + accessPointInfo: + $ref: "#/definitions/AccessPointInfo" + ResponseAccessPointList: + properties: + accessPointList: + $ref: "#/definitions/AccessPointList" + ResponseUserInfo: + properties: + userInfo: + $ref: "#/definitions/UserInfo" + ResponseUserList: + properties: + userList: + $ref: "#/definitions/UserList" + ResponseUserTrackingNotificationSubscriptionList: + type: "object" + properties: + notificationSubscriptionList: + $ref: "#/definitions/UserTrackingNotificationSubscriptionList" + ResponseUserTrackingSubscription: + properties: + userTrackingSubscription: + $ref: "#/definitions/UserTrackingSubscription" + ResponseZonalTrafficNotificationSubscriptionList: + type: "object" + properties: + notificationSubscriptionList: + $ref: "#/definitions/ZonalTrafficNotificationSubscriptionList" + ResponseZonalTrafficSubscription: + properties: + zonalTrafficSubscription: + $ref: "#/definitions/ZonalTrafficSubscription" + ResponseZoneInfo: + properties: + zoneInfo: + $ref: "#/definitions/ZoneInfo" + ResponseZoneList: + properties: + zoneList: + $ref: "#/definitions/ZoneList" + ResponseZoneStatusNotificationSubscriptionList: + type: "object" + properties: + notificationSubscriptionList: + $ref: "#/definitions/ZoneStatusNotificationSubscriptionList" + ResponseZoneStatusSubscription: + properties: + zonalTrafficSubscription: + $ref: "#/definitions/ZoneStatusSubscription" + ResponseZoneStatusSubscription2: + properties: + zoneStatusSubscription: + $ref: "#/definitions/ZoneStatusSubscription" +parameters: + Body.UserTrackingSubscription: + in: "body" + name: "userTrackingSubscription" + description: "User Tracking Subscription" + required: true + schema: + $ref: "#/definitions/UserTrackingSubscription" + x-exportParamName: "UserTrackingSubscription" + Body.ZonalTrafficSubscription: + in: "body" + name: "zonalTrafficSubscription" + description: "Zonal Traffic Subscription" + required: true + schema: + $ref: "#/definitions/ZonalTrafficSubscription" + x-exportParamName: "ZonalTrafficSubscription" + Body.ZoneStatusSubscription: + in: "body" + name: "zoneStatusSubscription" + description: "Zone Status Subscription" + required: true + schema: + $ref: "#/definitions/ZoneStatusSubscription" + x-exportParamName: "ZoneStatusSubscription" + Path.AccessPointId: + name: "accessPointId" + in: "path" + description: "Access Point ID" + required: true + type: "string" + x-exportParamName: "AccessPointId" + Path.SubscriptionId: + name: "subscriptionId" + in: "path" + description: "Subscription ID" + required: true + type: "string" + x-exportParamName: "SubscriptionId" + Path.UserId: + name: "userId" + in: "path" + description: "User ID" + required: true + type: "string" + x-exportParamName: "UserId" + Path.ZoneId: + name: "zoneId" + in: "path" + description: "Zone ID" + required: true + type: "string" + x-exportParamName: "ZoneId" + Query.AccessPointId: + name: "accessPointId" + in: "query" + description: "Identifier of access point, reference \"definitions\" for string\ + \ format" + required: false + type: "string" + x-exportParamName: "AccessPointId" + x-optionalDataType: "String" + Query.InterestRealm: + name: "interestRealm" + in: "query" + description: "Interest realm of access point (e.g. geographical area, a type of\ + \ industry etc.)." + required: false + type: "string" + x-exportParamName: "InterestRealm" + x-optionalDataType: "String" + Query.ZoneId: + name: "zoneId" + in: "query" + description: "Zone ID" + required: true + type: "string" + x-exportParamName: "ZoneId" -- GitLab