Commit 99adc191 authored by Michel Roy's avatar Michel Roy Committed by Kevin Di Lallo
Browse files

loc-serv client swagger update

parent 234065aa
Loading
Loading
Loading
Loading
+0 −68
Original line number Diff line number Diff line
# \NotificationsApi

All URIs are relative to *http://172.0.0.1:8081/location/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**PostTrackingNotification**](NotificationsApi.md#PostTrackingNotification) | **Post** /location_notifications/{subscriptionId} | 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
[**PostZoneStatusNotification**](NotificationsApi.md#PostZoneStatusNotification) | **Post** /zone_status_notifications/{subscriptionId} | This operation is used by the AdvantEDGE Location Service to issue a callback notification towards an ME application with a zone status tracking subscription


# **PostTrackingNotification**
> PostTrackingNotification(ctx, subscriptionId, notification)
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

Zonal or User location tracking subscription notification

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **subscriptionId** | **string**| Identity of a notification subscription (user or zonal) | 
  **notification** | [**TrackingNotification**](TrackingNotification.md)| Zonal or User Tracking Notification | 

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **PostZoneStatusNotification**
> PostZoneStatusNotification(ctx, subscriptionId, notification)
This operation is used by the AdvantEDGE Location Service to issue a callback notification towards an ME application with a zone status tracking subscription

Zone status tracking subscription notification

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **subscriptionId** | **string**| Identity of a notification subscription (user or zonal) | 
  **notification** | [**ZoneStatusNotification**](ZoneStatusNotification.md)| Zone Status Notification | 

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+0 −9
Original line number Diff line number Diff line
# SubscriptionId

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

+0 −17
Original line number Diff line number Diff line
# TrackingNotification

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CallbackData** | **string** | CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common]. | [default to null]
**ZoneId** | **string** | Identifier of zone | [optional] [default to null]
**Address** | **string** | Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI). | [optional] [default to null]
**InterestRealm** | **string** | Interest realm of access point (e.g. geographical area, a type of industry etc.). | [optional] [default to null]
**UserEventType** | [***UserEventType**](UserEventType.md) |  | [optional] [default to null]
**CurrentAccessPointId** | **string** | Zone ID | [optional] [default to null]
**PreviousAccessPointId** | **string** | Zone ID | [optional] [default to null]
**Timestamp** | [**time.Time**](time.Time.md) | Indicates the time of day for zonal presence notification. | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

+0 −13
Original line number Diff line number Diff line
# UserTrackingNotification

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CallbackData** | **string** | CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common]. | [default to null]
**UserInfo** | [***UserInfo**](UserInfo.md) |  | [default to null]
**TimeStamp** | [**time.Time**](time.Time.md) | Indicates the time of day for zonal presence notification. | [default to null]
**UserEventType** | [***UserEventType**](UserEventType.md) |  | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)