Skip to content
Normal view Permalink
README.md 9.75 KiB
Newer Older
Kevin Di Lallo's avatar
bumped ansible k8s install version to 1.19 + added api documentation
Kevin Di Lallo committed
1 2 3 4 5 
# Documentation for AdvantEDGE Location Service REST API

<a name="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints
Simon Pastor's avatar
merge  
Simon Pastor committed
6 
All URIs are relative to *https://localhost/sandboxname/location/v2*
Kevin Di Lallo's avatar
bumped ansible k8s install version to 1.19 + added api documentation
Kevin Di Lallo committed
7 8 9 10 11 

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*LocationApi* | [**apByIdGET**](Apis/LocationApi.md#apbyidget) | **GET** /queries/zones/{zoneId}/accessPoints/{accessPointId} | Radio Node Location Lookup
*LocationApi* | [**apGET**](Apis/LocationApi.md#apget) | **GET** /queries/zones/{zoneId}/accessPoints | Radio Node Location Lookup
Kevin Di Lallo's avatar
updated API docs  
Kevin Di Lallo committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 
*LocationApi* | [**areaCircleSubDELETE**](Apis/LocationApi.md#areacirclesubdelete) | **DELETE** /subscriptions/area/circle/{subscriptionId} | Cancel a subscription
*LocationApi* | [**areaCircleSubGET**](Apis/LocationApi.md#areacirclesubget) | **GET** /subscriptions/area/circle/{subscriptionId} | Retrieve subscription information
*LocationApi* | [**areaCircleSubListGET**](Apis/LocationApi.md#areacirclesublistget) | **GET** /subscriptions/area/circle | Retrieves all active subscriptions to area change notifications
*LocationApi* | [**areaCircleSubPOST**](Apis/LocationApi.md#areacirclesubpost) | **POST** /subscriptions/area/circle | Creates a subscription for area change notification
*LocationApi* | [**areaCircleSubPUT**](Apis/LocationApi.md#areacirclesubput) | **PUT** /subscriptions/area/circle/{subscriptionId} | Updates a subscription information
*LocationApi* | [**distanceGET**](Apis/LocationApi.md#distanceget) | **GET** /queries/distance | UE Distance Lookup of a specific UE
*LocationApi* | [**distanceSubDELETE**](Apis/LocationApi.md#distancesubdelete) | **DELETE** /subscriptions/distance/{subscriptionId} | Cancel a subscription
*LocationApi* | [**distanceSubGET**](Apis/LocationApi.md#distancesubget) | **GET** /subscriptions/distance/{subscriptionId} | Retrieve subscription information
*LocationApi* | [**distanceSubListGET**](Apis/LocationApi.md#distancesublistget) | **GET** /subscriptions/distance | Retrieves all active subscriptions to distance change notifications
*LocationApi* | [**distanceSubPOST**](Apis/LocationApi.md#distancesubpost) | **POST** /subscriptions/distance | Creates a subscription for distance change notification
*LocationApi* | [**distanceSubPUT**](Apis/LocationApi.md#distancesubput) | **PUT** /subscriptions/distance/{subscriptionId} | Updates a subscription information
*LocationApi* | [**mec011AppTerminationPOST**](Apis/LocationApi.md#mec011appterminationpost) | **POST** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination
*LocationApi* | [**periodicSubDELETE**](Apis/LocationApi.md#periodicsubdelete) | **DELETE** /subscriptions/periodic/{subscriptionId} | Cancel a subscription
*LocationApi* | [**periodicSubGET**](Apis/LocationApi.md#periodicsubget) | **GET** /subscriptions/periodic/{subscriptionId} | Retrieve subscription information
*LocationApi* | [**periodicSubListGET**](Apis/LocationApi.md#periodicsublistget) | **GET** /subscriptions/periodic | Retrieves all active subscriptions to periodic notifications
*LocationApi* | [**periodicSubPOST**](Apis/LocationApi.md#periodicsubpost) | **POST** /subscriptions/periodic | Creates a subscription for periodic notification
*LocationApi* | [**periodicSubPUT**](Apis/LocationApi.md#periodicsubput) | **PUT** /subscriptions/periodic/{subscriptionId} | Updates a subscription information
Kevin Di Lallo's avatar
bumped ansible k8s install version to 1.19 + added api documentation
Kevin Di Lallo committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 
*LocationApi* | [**userTrackingSubDELETE**](Apis/LocationApi.md#usertrackingsubdelete) | **DELETE** /subscriptions/userTracking/{subscriptionId} | Cancel a subscription
*LocationApi* | [**userTrackingSubGET**](Apis/LocationApi.md#usertrackingsubget) | **GET** /subscriptions/userTracking/{subscriptionId} | Retrieve subscription information
*LocationApi* | [**userTrackingSubListGET**](Apis/LocationApi.md#usertrackingsublistget) | **GET** /subscriptions/userTracking | Retrieves all active subscriptions to user tracking notifications
*LocationApi* | [**userTrackingSubPOST**](Apis/LocationApi.md#usertrackingsubpost) | **POST** /subscriptions/userTracking | Creates a subscription for user tracking notification
*LocationApi* | [**userTrackingSubPUT**](Apis/LocationApi.md#usertrackingsubput) | **PUT** /subscriptions/userTracking/{subscriptionId} | Updates a subscription information
*LocationApi* | [**usersGET**](Apis/LocationApi.md#usersget) | **GET** /queries/users | UE Location Lookup of a specific UE or group of UEs
*LocationApi* | [**zonalTrafficSubDELETE**](Apis/LocationApi.md#zonaltrafficsubdelete) | **DELETE** /subscriptions/zonalTraffic/{subscriptionId} | Cancel a subscription
*LocationApi* | [**zonalTrafficSubGET**](Apis/LocationApi.md#zonaltrafficsubget) | **GET** /subscriptions/zonalTraffic/{subscriptionId} | Retrieve subscription information
*LocationApi* | [**zonalTrafficSubListGET**](Apis/LocationApi.md#zonaltrafficsublistget) | **GET** /subscriptions/zonalTraffic | Retrieves all active subscriptions to zonal traffic notifications
*LocationApi* | [**zonalTrafficSubPOST**](Apis/LocationApi.md#zonaltrafficsubpost) | **POST** /subscriptions/zonalTraffic | Creates a subscription for zonal traffic notification
*LocationApi* | [**zonalTrafficSubPUT**](Apis/LocationApi.md#zonaltrafficsubput) | **PUT** /subscriptions/zonalTraffic/{subscriptionId} | Updates a subscription information
*LocationApi* | [**zoneStatusSubDELETE**](Apis/LocationApi.md#zonestatussubdelete) | **DELETE** /subscriptions/zoneStatus/{subscriptionId} | Cancel a subscription
*LocationApi* | [**zoneStatusSubGET**](Apis/LocationApi.md#zonestatussubget) | **GET** /subscriptions/zoneStatus/{subscriptionId} | Retrieve subscription information
*LocationApi* | [**zoneStatusSubListGET**](Apis/LocationApi.md#zonestatussublistget) | **GET** /subscriptions/zoneStatus | Retrieves all active subscriptions to zone status notifications
*LocationApi* | [**zoneStatusSubPOST**](Apis/LocationApi.md#zonestatussubpost) | **POST** /subscriptions/zoneStatus | Creates a subscription for zone status notification
*LocationApi* | [**zoneStatusSubPUT**](Apis/LocationApi.md#zonestatussubput) | **PUT** /subscriptions/zoneStatus/{subscriptionId} | Updates a subscription information
*LocationApi* | [**zonesGET**](Apis/LocationApi.md#zonesget) | **GET** /queries/zones | Zones information Lookup
*LocationApi* | [**zonesGetById**](Apis/LocationApi.md#zonesgetbyid) | **GET** /queries/zones/{zoneId} | Zones information Lookup


<a name="documentation-for-models"></a>
## Documentation for Models

 - [AccessPointInfo](./Models/AccessPointInfo.md)
 - [AccessPointList](./Models/AccessPointList.md)
Kevin Di Lallo's avatar
updated API docs  
Kevin Di Lallo committed
54 55 
 - [AppTerminationNotification](./Models/AppTerminationNotification.md)
 - [AppTerminationNotificationLinks](./Models/AppTerminationNotificationLinks.md)
Kevin Di Lallo's avatar
bumped ansible k8s install version to 1.19 + added api documentation
Kevin Di Lallo committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 
 - [CallbackReference](./Models/CallbackReference.md)
 - [CircleNotificationSubscription](./Models/CircleNotificationSubscription.md)
 - [ConnectionType](./Models/ConnectionType.md)
 - [DistanceCriteria](./Models/DistanceCriteria.md)
 - [DistanceNotificationSubscription](./Models/DistanceNotificationSubscription.md)
 - [EnteringLeavingCriteria](./Models/EnteringLeavingCriteria.md)
 - [InlineAccessPointInfo](./Models/InlineAccessPointInfo.md)
 - [InlineAccessPointList](./Models/InlineAccessPointList.md)
 - [InlineCircleNotificationSubscription](./Models/InlineCircleNotificationSubscription.md)
 - [InlineDistanceNotificationSubscription](./Models/InlineDistanceNotificationSubscription.md)
 - [InlineNotificationSubscriptionList](./Models/InlineNotificationSubscriptionList.md)
 - [InlinePeriodicNotificationSubscription](./Models/InlinePeriodicNotificationSubscription.md)
 - [InlineProblemDetails](./Models/InlineProblemDetails.md)
 - [InlineProblemDetailsRequired](./Models/InlineProblemDetailsRequired.md)
 - [InlineSubscriptionNotification](./Models/InlineSubscriptionNotification.md)
 - [InlineTerminalDistance](./Models/InlineTerminalDistance.md)
 - [InlineUserList](./Models/InlineUserList.md)
 - [InlineUserTrackingSubscription](./Models/InlineUserTrackingSubscription.md)
 - [InlineZonalPresenceNotification](./Models/InlineZonalPresenceNotification.md)
 - [InlineZonalTrafficSubscription](./Models/InlineZonalTrafficSubscription.md)
 - [InlineZoneInfo](./Models/InlineZoneInfo.md)
 - [InlineZoneList](./Models/InlineZoneList.md)
 - [InlineZoneStatusNotification](./Models/InlineZoneStatusNotification.md)
 - [InlineZoneStatusSubscription](./Models/InlineZoneStatusSubscription.md)
 - [Link](./Models/Link.md)
Kevin Di Lallo's avatar
updated API docs  
Kevin Di Lallo committed
81 
 - [LinkType](./Models/LinkType.md)
Kevin Di Lallo's avatar
bumped ansible k8s install version to 1.19 + added api documentation
Kevin Di Lallo committed
82 83 84 85 
 - [LocationInfo](./Models/LocationInfo.md)
 - [LocationInfoVelocity](./Models/LocationInfoVelocity.md)
 - [NotificationFormat](./Models/NotificationFormat.md)
 - [NotificationSubscriptionList](./Models/NotificationSubscriptionList.md)
Kevin Di Lallo's avatar
updated API docs  
Kevin Di Lallo committed
86 
 - [OperationActionType](./Models/OperationActionType.md)
Kevin Di Lallo's avatar
bumped ansible k8s install version to 1.19 + added api documentation
Kevin Di Lallo committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 
 - [OperationStatus](./Models/OperationStatus.md)
 - [PeriodicNotificationSubscription](./Models/PeriodicNotificationSubscription.md)
 - [ProblemDetails](./Models/ProblemDetails.md)
 - [RetrievalStatus](./Models/RetrievalStatus.md)
 - [ServiceError](./Models/ServiceError.md)
 - [SubscriptionNotification](./Models/SubscriptionNotification.md)
 - [TerminalDistance](./Models/TerminalDistance.md)
 - [TerminalLocation](./Models/TerminalLocation.md)
 - [TimeStamp](./Models/TimeStamp.md)
 - [UserEventType](./Models/UserEventType.md)
 - [UserInfo](./Models/UserInfo.md)
 - [UserList](./Models/UserList.md)
 - [UserTrackingSubscription](./Models/UserTrackingSubscription.md)
 - [ZonalPresenceNotification](./Models/ZonalPresenceNotification.md)
 - [ZonalTrafficSubscription](./Models/ZonalTrafficSubscription.md)
 - [ZoneInfo](./Models/ZoneInfo.md)
 - [ZoneList](./Models/ZoneList.md)
 - [ZoneStatusNotification](./Models/ZoneStatusNotification.md)
 - [ZoneStatusSubscription](./Models/ZoneStatusSubscription.md)


<a name="documentation-for-authorization"></a>
## Documentation for Authorization

All endpoints do not require authorization.