Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
}
}
},
"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": {
"summary": "Updates a user distance subscription information",
"description": "The PUT method is used to update the existing user distance subscription.",
"operationId": "distanceSubPUT",
"requestBody": {
"description": "Subscription to be modified",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userDistanceSubscription": {
"$ref": "#/components/schemas/UserDistanceSubscription"
"userDistanceSubscription": {
"subscriptionType": "UserDistanceSubscription",
"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.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userDistanceSubscription": {
"$ref": "#/components/schemas/UserDistanceSubscription"
"userDistanceSubscription": {
"subscriptionType": "UserDistanceSubscription",
"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
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
}
}
}
},
"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": {
"description": "The DELETE method is used to cancel the existing subscription.",
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
"operationId": "distanceSubDELETE",
"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/users": {
"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",
"parameters": [
{
"$ref": "#/components/parameters/Query.Subscription_type_2"
},
{
"$ref": "#/components/parameters/Query.Address_2"
}
],
"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/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": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
"summary": "Create subscription to UE location notifications.",
"description": "The POST method is used to create a new subscription to UE location notifications.",
"operationId": "userSubPOST",
"requestBody": {
"description": "Subscription to be created",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userLocationEventSubscription": {
"$ref": "#/components/schemas/UserLocationEventSubscription"
},
"userLocationPeriodicSubscription": {
"$ref": "#/components/schemas/UserLocationPeriodicSubscription"
"userLocationEventSubscription": {
"subscriptionType": "UserLocationEventSubscription",
"callbackReference": "http://my.callback.com/user-location-notification/some-id",
"locationEventCriteria": ["ENTERING_AREA_EVENT"]
}
}
}
},
"responses": {
"201": {
"description": "Indicates successful subscription creation.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userLocationEventSubscription": {
"$ref": "#/components/schemas/UserLocationEventSubscription"
},
"userLocationPeriodicSubscription": {
"$ref": "#/components/schemas/UserLocationPeriodicSubscription"
"userLocationEventSubscription": {
"subscriptionType": "UserLocationEventSubscription",
"callbackReference": "http://my.callback.com/user-location-notification/some-id",
"locationEventCriteria": ["ENTERING_AREA_EVENT"]
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
}
}
}
},
"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}": {
"summary": "Callback POST used to send a notification",
"description": "Notification from Location service, content based on subscription type",
"operationId": "userNotificationPOST",
"description": "User LocationEvent Notification",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userLocationEventNotification": {
"$ref": "#/components/schemas/UserLocationEventNotification"
},
"userLocationPeriodicNotification": {
"$ref": "#/components/schemas/UserLocationPeriodicNotification"
"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}": {
"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"],
"userLocationEventSubscription": {
"$ref": "#/components/schemas/UserLocationEventSubscription"
},
"userLocationPeriodicSubscription": {
"$ref": "#/components/schemas/UserLocationPeriodicSubscription"
"userLocationEventSubscription": {
"subscriptionType": "UserLocationEventSubscription",
"callbackReference": "http://my.callback.com/user-location-notification/some-id",
"locationEventCriteria": ["ENTERING_AREA_EVENT"]
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
}
}
}
},
"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": {
"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"
"userLocationEventSubscription": {
"subscriptionType": "UserLocationEventSubscription",
"callbackReference": "http://my.callback.com/user-location-notification/some-id",
"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"
"userLocationEventSubscription": {
"subscriptionType": "UserLocationEventSubscription",
"callbackReference": "http://my.callback.com/user-location-notification/some-id",
"locationEventCriteria": ["ENTERING_AREA_EVENT"]
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
}
}
}
},
"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": {
"description": "The DELETE method is used to cancel the existing subscription.",
"operationId": "userSubDELETE",
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
"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": {
"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"
}
],
"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": {
"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": {
"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"
"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",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"zoneLocationEventSubscription": {
"$ref": "#/components/schemas/ZoneLocationEventSubscription"
},
"zoneStatusSubscription": {
"$ref": "#/components/schemas/ZoneStatusSubscription"
"zoneLocationEventSubscription": {
"subscriptionType": "ZoneLocationEventSubscription",
"callbackReference": "http://my.callback.com/zone-notification/some-id",
"zoneId": "zone01",
"locationEventCriteria": ["ENTERING_AREA_EVENT"],
"expiryDeadline\"": {
"seconds": 1977836800,
"nanoseconds\"": 0
}
}
}
}
},
"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#/zoneLocationEventSubscription.callbackReference}": {
"summary": "Callback POST used to send a notification",
"description": "Notification from Location service, content based on subscription type",
"operationId": "zoneNotificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"zoneLocationEventNotification": {
"$ref": "#/components/schemas/ZoneLocationEventNotification"
},
"zoneStatusNotification": {
"$ref": "#/components/schemas/ZoneStatusNotification"
"zoneLocationEventNotification": {
"notificationType": "ZoneLocationEventNotification",
"address": "acr:10.0.0.1",
"zoneId": "zone01",
"_links": {
"subscription": {
"href": "http://meAppServer.example.com/location/v3/subscriptions/zone/subscription123"
}
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
}
}
}
}
}
},
"x-swagger-router-controller": "subscriptions"
}
},
"/subscriptions/zones/{subscriptionId}": {
"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"
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing data type describing the specific zone subscription is returned.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"zoneLocationEventSubscription",
"zoneStatusSubscription"
],
"zoneLocationEventSubscription": {
"$ref": "#/components/schemas/ZoneLocationEventSubscription"
},
"zoneStatusSubscription": {
"$ref": "#/components/schemas/ZoneStatusSubscription"
"zoneLocationEventSubscription": {
"subscriptionType": "ZoneLocationEventSubscription",
"callbackReference": "http://my.callback.com/zone-notification/some-id",
"zoneId": "zone01",
"locationEventCriteria": ["ENTERING_AREA_EVENT"],
"expiryDeadline\"": {
"seconds": 1977836800,
"nanoseconds\"": 0
}
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
}
}
}
},
"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": {
"summary": "Updates a zone subscription information",
"description": "The PUT method is used to update the existing zone subscription.",
"operationId": "zoneSubPUT",
"requestBody": {
"description": "Subscription to be modified",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"zoneLocationEventSubscription": {
"$ref": "#/components/schemas/ZoneLocationEventSubscription"
},
"zoneStatusSubscription": {
"$ref": "#/components/schemas/ZoneStatusSubscription"
"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"
}
],
"responses": {
"200": {
"description": "Upon success, a response body containing data type describing the updated subscription is returned.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"zoneLocationEventSubscription": {
"$ref": "#/components/schemas/ZoneLocationEventSubscription"
},
"zoneStatusSubscription": {
"$ref": "#/components/schemas/ZoneStatusSubscription"
"zoneLocationEventSubscription": {
"subscriptionType": "ZoneLocationEventSubscription",
"callbackReference": "http://my.callback.com/zone-notification/some-id",
"zoneId": "zone01",
"locationEventCriteria": ["ENTERING_AREA_EVENT"],
"expiryDeadline\"": {
"seconds": 1977836800,
"nanoseconds\"": 0
}
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
}
}
}
},
"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": {
"summary": "Cancel a zone subscription",
"description": "The DELETE method is used to cancel the existing zone subscription.",
"operationId": "zoneSubDELETE",
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
"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"
}
}
},
"components": {
"responses": {
"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": {
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {