client

package module
v0.0.0-...-8f6edbe Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 30, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

README

Go API client for client

Location Service is AdvantEDGE's implementation of ETSI MEC ISG MEC013 Location API

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

Copyright (c) ETSI 2017

Micro-service
meep-loc-serv

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

Note
AdvantEDGE supports all of Location API endpoints (see below).

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.2.1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./client"

Documentation for API Endpoints

All URIs are relative to https://localhost/sandboxname/location/v2

Class Method HTTP request Description
LocationApi ApByIdGET Get /queries/zones/{zoneId}/accessPoints/{accessPointId} Radio Node Location Lookup
LocationApi ApGET Get /queries/zones/{zoneId}/accessPoints Radio Node Location Lookup
LocationApi AreaCircleSubDELETE Delete /subscriptions/area/circle/{subscriptionId} Cancel a subscription
LocationApi AreaCircleSubGET Get /subscriptions/area/circle/{subscriptionId} Retrieve subscription information
LocationApi AreaCircleSubListGET Get /subscriptions/area/circle Retrieves all active subscriptions to area change notifications
LocationApi AreaCircleSubPOST Post /subscriptions/area/circle Creates a subscription for area change notification
LocationApi AreaCircleSubPUT Put /subscriptions/area/circle/{subscriptionId} Updates a subscription information
LocationApi DistanceGET Get /queries/distance UE Distance Lookup of a specific UE
LocationApi DistanceSubDELETE Delete /subscriptions/distance/{subscriptionId} Cancel a subscription
LocationApi DistanceSubGET Get /subscriptions/distance/{subscriptionId} Retrieve subscription information
LocationApi DistanceSubListGET Get /subscriptions/distance Retrieves all active subscriptions to distance change notifications
LocationApi DistanceSubPOST Post /subscriptions/distance Creates a subscription for distance change notification
LocationApi DistanceSubPUT Put /subscriptions/distance/{subscriptionId} Updates a subscription information
LocationApi Mec011AppTerminationPOST Post /notifications/mec011/appTermination MEC011 Application Termination notification for self termination
LocationApi PeriodicSubDELETE Delete /subscriptions/periodic/{subscriptionId} Cancel a subscription
LocationApi PeriodicSubGET Get /subscriptions/periodic/{subscriptionId} Retrieve subscription information
LocationApi PeriodicSubListGET Get /subscriptions/periodic Retrieves all active subscriptions to periodic notifications
LocationApi PeriodicSubPOST Post /subscriptions/periodic Creates a subscription for periodic notification
LocationApi PeriodicSubPUT Put /subscriptions/periodic/{subscriptionId} Updates a subscription information
LocationApi UserTrackingSubDELETE Delete /subscriptions/userTracking/{subscriptionId} Cancel a subscription
LocationApi UserTrackingSubGET Get /subscriptions/userTracking/{subscriptionId} Retrieve subscription information
LocationApi UserTrackingSubListGET Get /subscriptions/userTracking Retrieves all active subscriptions to user tracking notifications
LocationApi UserTrackingSubPOST Post /subscriptions/userTracking Creates a subscription for user tracking notification
LocationApi UserTrackingSubPUT Put /subscriptions/userTracking/{subscriptionId} Updates a subscription information
LocationApi UsersGET Get /queries/users UE Location Lookup of a specific UE or group of UEs
LocationApi ZonalTrafficSubDELETE Delete /subscriptions/zonalTraffic/{subscriptionId} Cancel a subscription
LocationApi ZonalTrafficSubGET Get /subscriptions/zonalTraffic/{subscriptionId} Retrieve subscription information
LocationApi ZonalTrafficSubListGET Get /subscriptions/zonalTraffic Retrieves all active subscriptions to zonal traffic notifications
LocationApi ZonalTrafficSubPOST Post /subscriptions/zonalTraffic Creates a subscription for zonal traffic notification
LocationApi ZonalTrafficSubPUT Put /subscriptions/zonalTraffic/{subscriptionId} Updates a subscription information
LocationApi ZoneStatusSubDELETE Delete /subscriptions/zoneStatus/{subscriptionId} Cancel a subscription
LocationApi ZoneStatusSubGET Get /subscriptions/zoneStatus/{subscriptionId} Retrieve subscription information
LocationApi ZoneStatusSubListGET Get /subscriptions/zoneStatus Retrieves all active subscriptions to zone status notifications
LocationApi ZoneStatusSubPOST Post /subscriptions/zoneStatus Creates a subscription for zone status notification
LocationApi ZoneStatusSubPUT Put /subscriptions/zoneStatus/{subscriptionId} Updates a subscription information
LocationApi ZonesGET Get /queries/zones Zones information Lookup
LocationApi ZonesGetById Get /queries/zones/{zoneId} Zones information Lookup

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

AdvantEDGE@InterDigital.com

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	LocationApi *LocationApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the AdvantEDGE Location API API v2.2.1 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AccessPointInfo

type AccessPointInfo struct {
	// Identifier of access point.
	AccessPointId  string          `json:"accessPointId"`
	ConnectionType *ConnectionType `json:"connectionType"`
	// Interest realm of access point.
	InterestRealm string        `json:"interestRealm,omitempty"`
	LocationInfo  *LocationInfo `json:"locationInfo,omitempty"`
	// Number of users currently on the access point.
	NumberOfUsers   int32            `json:"numberOfUsers"`
	OperationStatus *OperationStatus `json:"operationStatus"`
	// Self referring URL
	ResourceURL string `json:"resourceURL"`
	// Time zone of access point.
	Timezone string `json:"timezone,omitempty"`
}

A type containing access point information.

type AccessPointList

type AccessPointList struct {
	// Collection of the access point information list.
	AccessPoint []AccessPointInfo `json:"accessPoint,omitempty"`
	// Self referring URL
	ResourceURL string `json:"resourceURL"`
	// Identifier of zone
	ZoneId string `json:"zoneId"`
}

A type containing list of access points.

type ApGETOpts

type ApGETOpts struct {
	InterestRealm optional.String
}

type AppTerminationNotification

type AppTerminationNotification struct {
	// Shall be set to AppTerminationNotification.
	NotificationType string               `json:"notificationType"`
	OperationAction  *OperationActionType `json:"operationAction"`
	// Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.
	MaxGracefulTimeout int32                            `json:"maxGracefulTimeout"`
	Links              *AppTerminationNotificationLinks `json:"_links"`
}

This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.

type AppTerminationNotificationLinks struct {
	Subscription       *LinkType `json:"subscription"`
	ConfirmTermination *LinkType `json:"confirmTermination,omitempty"`
}

Object containing hyperlinks related to the resource.

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CallbackReference

type CallbackReference struct {
	// Data the application can register with the server when subscribing to notifications, and that are passed back unchanged in each of the related notifications. These data can be used by the application in the processing of the notification, e.g. for correlation purposes.
	CallbackData       string              `json:"callbackData,omitempty"`
	NotificationFormat *NotificationFormat `json:"notificationFormat,omitempty"`
	// Notify Callback URL
	NotifyURL string `json:"notifyURL"`
}

type CircleNotificationSubscription

type CircleNotificationSubscription struct {
	// Address of terminals to monitor (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
	Address           []string           `json:"address"`
	CallbackReference *CallbackReference `json:"callbackReference"`
	// Check location immediately after establishing notification.
	CheckImmediate bool `json:"checkImmediate"`
	// A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
	ClientCorrelator string `json:"clientCorrelator,omitempty"`
	// Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
	Count int32 `json:"count,omitempty"`
	// Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications.
	Duration                int32                    `json:"duration,omitempty"`
	EnteringLeavingCriteria *EnteringLeavingCriteria `json:"enteringLeavingCriteria"`
	// Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
	Frequency int32 `json:"frequency"`
	// Latitude of center point.
	Latitude float32 `json:"latitude"`
	// Link to other resources that are in relationship with the resource.
	Link []Link `json:"link,omitempty"`
	// Longitude of center point.
	Longitude float32 `json:"longitude"`
	// Radius circle around center point in meters.
	Radius float32 `json:"radius"`
	// Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
	Requester string `json:"requester,omitempty"`
	// Self referring URL
	ResourceURL string `json:"resourceURL,omitempty"`
	// Number of meters of acceptable error in tracking distance.
	TrackingAccuracy float32 `json:"trackingAccuracy"`
}

A type containing data for notifications, when the area is defined as a circle.

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConnectionType

type ConnectionType string

ConnectionType : The connection type for the access point

const (
	FEMTO_ConnectionType         ConnectionType = "Femto"
	LTE_FEMTO_ConnectionType     ConnectionType = "LTE-femto"
	SMALLCELL_ConnectionType     ConnectionType = "Smallcell"
	LTE_SMALLCELL_ConnectionType ConnectionType = "LTE-smallcell"
	WIFI_ConnectionType          ConnectionType = "Wifi"
	PICO_ConnectionType          ConnectionType = "Pico"
	MICRO_ConnectionType         ConnectionType = "Micro"
	MACRO_ConnectionType         ConnectionType = "Macro"
	WIMAX_ConnectionType         ConnectionType = "Wimax"
	UNKNOWN_ConnectionType       ConnectionType = "Unknown"
)

List of ConnectionType

type DistanceCriteria

type DistanceCriteria string
const (
	ALL_WITHIN_DISTANCE_DistanceCriteria DistanceCriteria = "AllWithinDistance"
	ANY_WITHIN_DISTANCE_DistanceCriteria DistanceCriteria = "AnyWithinDistance"
	ALL_BEYOND_DISTANCE_DistanceCriteria DistanceCriteria = "AllBeyondDistance"
	ANY_BEYOND_DISTANCE_DistanceCriteria DistanceCriteria = "AnyBeyondDistance"
)

List of DistanceCriteria

type DistanceGETOpts

type DistanceGETOpts struct {
	Requester optional.String
	Latitude  optional.Float32
	Longitude optional.Float32
}

type DistanceNotificationSubscription

type DistanceNotificationSubscription struct {
	CallbackReference *CallbackReference `json:"callbackReference"`
	// Check location immediately after establishing notification.
	CheckImmediate bool `json:"checkImmediate"`
	// A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
	ClientCorrelator string `json:"clientCorrelator,omitempty"`
	// Maximum number of notifications per individual address. For no maximum, either do not include this element or specify a value of zero. Default value is 0.
	Count    int32             `json:"count,omitempty"`
	Criteria *DistanceCriteria `json:"criteria"`
	// Distance between devices that shall be monitored.
	Distance float32 `json:"distance"`
	// Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications.
	Duration int32 `json:"duration,omitempty"`
	// Maximum frequency (in seconds) of notifications per subscription (can also be considered minimum time between notifications).
	Frequency int32 `json:"frequency"`
	// Link to other resources that are in relationship with the resource.
	Link []Link `json:"link,omitempty"`
	// Contains addresses of devices to monitor (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
	MonitoredAddress []string `json:"monitoredAddress"`
	// Indicates address of each device that will be used as reference devices from which the distances towards monitored devices indicated in the Addresses will be monitored (e.g., 'sip' URI, 'tel' URI, 'acr' URI)
	ReferenceAddress []string `json:"referenceAddress,omitempty"`
	// Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
	Requester string `json:"requester,omitempty"`
	// Self referring URL
	ResourceURL string `json:"resourceURL,omitempty"`
	// Number of meters of acceptable error in tracking distance.
	TrackingAccuracy float32 `json:"trackingAccuracy"`
}

A type containing data for distance subscription, with reference to other devices.

type EnteringLeavingCriteria

type EnteringLeavingCriteria string
const (
	ENTERING_EnteringLeavingCriteria EnteringLeavingCriteria = "Entering"
	LEAVING_EnteringLeavingCriteria  EnteringLeavingCriteria = "Leaving"
)

List of EnteringLeavingCriteria

type GenericSwaggerError

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type InlineAccessPointInfo

type InlineAccessPointInfo struct {
	AccessPointInfo *AccessPointInfo `json:"accessPointInfo,omitempty"`
}

type InlineAccessPointList

type InlineAccessPointList struct {
	AccessPointList *AccessPointList `json:"accessPointList,omitempty"`
}

type InlineCircleNotificationSubscription

type InlineCircleNotificationSubscription struct {
	CircleNotificationSubscription *CircleNotificationSubscription `json:"circleNotificationSubscription,omitempty"`
}

type InlineDistanceNotificationSubscription

type InlineDistanceNotificationSubscription struct {
	DistanceNotificationSubscription *DistanceNotificationSubscription `json:"distanceNotificationSubscription,omitempty"`
}

type InlineNotificationSubscriptionList

type InlineNotificationSubscriptionList struct {
	NotificationSubscriptionList *NotificationSubscriptionList `json:"notificationSubscriptionList"`
}

type InlinePeriodicNotificationSubscription

type InlinePeriodicNotificationSubscription struct {
	PeriodicNotificationSubscription *PeriodicNotificationSubscription `json:"periodicNotificationSubscription,omitempty"`
}

type InlineProblemDetails

type InlineProblemDetails struct {
	ProblemDetails *ProblemDetails `json:"problemDetails,omitempty"`
}

type InlineProblemDetailsRequired

type InlineProblemDetailsRequired struct {
	ProblemDetails *ProblemDetails `json:"problemDetails"`
}

type InlineSubscriptionNotification

type InlineSubscriptionNotification struct {
	SubscriptionNotification *SubscriptionNotification `json:"subscriptionNotification,omitempty"`
}

type InlineTerminalDistance

type InlineTerminalDistance struct {
	TerminalDistance *TerminalDistance `json:"terminalDistance,omitempty"`
}

type InlineUserList

type InlineUserList struct {
	UserList *UserList `json:"userList,omitempty"`
}

type InlineUserTrackingSubscription

type InlineUserTrackingSubscription struct {
	UserTrackingSubscription *UserTrackingSubscription `json:"userTrackingSubscription,omitempty"`
}

type InlineZonalPresenceNotification

type InlineZonalPresenceNotification struct {
	ZonalPresenceNotification *ZonalPresenceNotification `json:"zonalPresenceNotification,omitempty"`
}

type InlineZonalTrafficSubscription

type InlineZonalTrafficSubscription struct {
	ZonalTrafficSubscription *ZonalTrafficSubscription `json:"zonalTrafficSubscription,omitempty"`
}

type InlineZoneInfo

type InlineZoneInfo struct {
	ZoneInfo *ZoneInfo `json:"zoneInfo,omitempty"`
}

type InlineZoneList

type InlineZoneList struct {
	ZoneList *ZoneList `json:"zoneList,omitempty"`
}

type InlineZoneStatusNotification

type InlineZoneStatusNotification struct {
	ZoneStatusNotification *ZoneStatusNotification `json:"zoneStatusNotification,omitempty"`
}

type InlineZoneStatusSubscription

type InlineZoneStatusSubscription struct {
	ZoneStatusSubscription *ZoneStatusSubscription `json:"zoneStatusSubscription,omitempty"`
}
type Link struct {
	// URI
	Href string `json:"href"`
	// Describes the relationship between the URI and the resource.
	Rel string `json:"rel"`
}

Link to other resources

type LinkType

type LinkType struct {
	// URI referring to a resource
	Href string `json:"href"`
}

type LocationApiService

type LocationApiService service

func (*LocationApiService) ApByIdGET

func (a *LocationApiService) ApByIdGET(ctx context.Context, zoneId string, accessPointId string) (InlineAccessPointInfo, *http.Response, error)

LocationApiService Radio Node Location Lookup Radio Node Location Lookup to retrieve a radio node associated to a zone.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param zoneId Indentifier of zone
  • @param accessPointId Identifier of access Point

@return InlineAccessPointInfo

func (*LocationApiService) ApGET

func (a *LocationApiService) ApGET(ctx context.Context, zoneId string, localVarOptionals *ApGETOpts) (InlineAccessPointList, *http.Response, error)

func (*LocationApiService) AreaCircleSubDELETE

func (a *LocationApiService) AreaCircleSubDELETE(ctx context.Context, subscriptionId string) (*http.Response, error)

LocationApiService Cancel a subscription Method to delete a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

func (*LocationApiService) AreaCircleSubGET

func (a *LocationApiService) AreaCircleSubGET(ctx context.Context, subscriptionId string) (InlineCircleNotificationSubscription, *http.Response, error)

LocationApiService Retrieve subscription information Get subscription information.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineCircleNotificationSubscription

func (*LocationApiService) AreaCircleSubListGET

LocationApiService Retrieves all active subscriptions to area change notifications This operation is used for retrieving all active subscriptions to area change notifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineNotificationSubscriptionList

func (*LocationApiService) AreaCircleSubPOST

LocationApiService Creates a subscription for area change notification Creates a subscription to the Location Service for an area change notification.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be created

@return InlineCircleNotificationSubscription

func (*LocationApiService) AreaCircleSubPUT

LocationApiService Updates a subscription information Updates a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be modified
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineCircleNotificationSubscription

func (*LocationApiService) DistanceGET

func (a *LocationApiService) DistanceGET(ctx context.Context, address []string, localVarOptionals *DistanceGETOpts) (InlineTerminalDistance, *http.Response, error)

func (*LocationApiService) DistanceSubDELETE

func (a *LocationApiService) DistanceSubDELETE(ctx context.Context, subscriptionId string) (*http.Response, error)

LocationApiService Cancel a subscription Method to delete a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

func (*LocationApiService) DistanceSubGET

LocationApiService Retrieve subscription information Get subscription information.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineDistanceNotificationSubscription

func (*LocationApiService) DistanceSubListGET

LocationApiService Retrieves all active subscriptions to distance change notifications This operation is used for retrieving all active subscriptions to a distance change notifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineNotificationSubscriptionList

func (*LocationApiService) DistanceSubPOST

LocationApiService Creates a subscription for distance change notification Creates a subscription to the Location Service for a distance change notification.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be created

@return InlineDistanceNotificationSubscription

func (*LocationApiService) DistanceSubPUT

LocationApiService Updates a subscription information Updates a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be modified
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineDistanceNotificationSubscription

func (*LocationApiService) Mec011AppTerminationPOST

func (a *LocationApiService) Mec011AppTerminationPOST(ctx context.Context, body AppTerminationNotification) (*http.Response, error)

LocationApiService MEC011 Application Termination notification for self termination Terminates itself.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Termination notification details

func (*LocationApiService) PeriodicSubDELETE

func (a *LocationApiService) PeriodicSubDELETE(ctx context.Context, subscriptionId string) (*http.Response, error)

LocationApiService Cancel a subscription Method to delete a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

func (*LocationApiService) PeriodicSubGET

LocationApiService Retrieve subscription information Get subscription information.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlinePeriodicNotificationSubscription

func (*LocationApiService) PeriodicSubListGET

LocationApiService Retrieves all active subscriptions to periodic notifications This operation is used for retrieving all active subscriptions to periodic notifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineNotificationSubscriptionList

func (*LocationApiService) PeriodicSubPOST

LocationApiService Creates a subscription for periodic notification Creates a subscription to the Location Service for a periodic notification.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be created

@return InlinePeriodicNotificationSubscription

func (*LocationApiService) PeriodicSubPUT

LocationApiService Updates a subscription information Updates a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be modified
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlinePeriodicNotificationSubscription

func (*LocationApiService) UserTrackingSubDELETE

func (a *LocationApiService) UserTrackingSubDELETE(ctx context.Context, subscriptionId string) (*http.Response, error)

LocationApiService Cancel a subscription Method to delete a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

func (*LocationApiService) UserTrackingSubGET

func (a *LocationApiService) UserTrackingSubGET(ctx context.Context, subscriptionId string) (InlineUserTrackingSubscription, *http.Response, error)

LocationApiService Retrieve subscription information Get subscription information.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineUserTrackingSubscription

func (*LocationApiService) UserTrackingSubListGET

LocationApiService Retrieves all active subscriptions to user tracking notifications This operation is used for retrieving all active subscriptions to user tracking notifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineNotificationSubscriptionList

func (*LocationApiService) UserTrackingSubPOST

LocationApiService Creates a subscription for user tracking notification Creates a subscription to the Location Service for user tracking change notification.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be created

@return InlineUserTrackingSubscription

func (*LocationApiService) UserTrackingSubPUT

LocationApiService Updates a subscription information Updates a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be modified
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineUserTrackingSubscription

func (*LocationApiService) UsersGET

func (a *LocationApiService) UsersGET(ctx context.Context, localVarOptionals *UsersGETOpts) (InlineUserList, *http.Response, error)

func (*LocationApiService) ZonalTrafficSubDELETE

func (a *LocationApiService) ZonalTrafficSubDELETE(ctx context.Context, subscriptionId string) (*http.Response, error)

LocationApiService Cancel a subscription Method to delete a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

func (*LocationApiService) ZonalTrafficSubGET

func (a *LocationApiService) ZonalTrafficSubGET(ctx context.Context, subscriptionId string) (InlineZonalTrafficSubscription, *http.Response, error)

LocationApiService Retrieve subscription information Get subscription information.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineZonalTrafficSubscription

func (*LocationApiService) ZonalTrafficSubListGET

LocationApiService Retrieves all active subscriptions to zonal traffic notifications This operation is used for retrieving all active subscriptions to zonal traffic change notifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineNotificationSubscriptionList

func (*LocationApiService) ZonalTrafficSubPOST

LocationApiService Creates a subscription for zonal traffic notification Creates a subscription to the Location Service for zonal traffic change notification.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be created

@return InlineZonalTrafficSubscription

func (*LocationApiService) ZonalTrafficSubPUT

LocationApiService Updates a subscription information Updates a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be modified
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineZonalTrafficSubscription

func (*LocationApiService) ZoneStatusSubDELETE

func (a *LocationApiService) ZoneStatusSubDELETE(ctx context.Context, subscriptionId string) (*http.Response, error)

LocationApiService Cancel a subscription Method to delete a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

func (*LocationApiService) ZoneStatusSubGET

func (a *LocationApiService) ZoneStatusSubGET(ctx context.Context, subscriptionId string) (InlineZoneStatusSubscription, *http.Response, error)

LocationApiService Retrieve subscription information Get subscription information.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineZoneStatusSubscription

func (*LocationApiService) ZoneStatusSubListGET

LocationApiService Retrieves all active subscriptions to zone status notifications This operation is used for retrieving all active subscriptions to zone status change notifications.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineNotificationSubscriptionList

func (*LocationApiService) ZoneStatusSubPOST

LocationApiService Creates a subscription for zone status notification Creates a subscription to the Location Service for zone status change notification.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be created

@return InlineZoneStatusSubscription

func (*LocationApiService) ZoneStatusSubPUT

LocationApiService Updates a subscription information Updates a subscription.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body Subscription to be modified
  • @param subscriptionId Subscription Identifier, specifically the \"self\" returned in the subscription request

@return InlineZoneStatusSubscription

func (*LocationApiService) ZonesGET

LocationApiService Zones information Lookup Used to get a list of identifiers for zones authorized for use by the application.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InlineZoneList

func (*LocationApiService) ZonesGetById

func (a *LocationApiService) ZonesGetById(ctx context.Context, zoneId string) (InlineZoneInfo, *http.Response, error)

LocationApiService Zones information Lookup Used to get the information for an authorized zone for use by the application.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param zoneId Indentifier of zone

@return InlineZoneInfo

type LocationInfo

type LocationInfo struct {
	// Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if \"shape\" equals 4, 5 or 6
	Accuracy int32 `json:"accuracy,omitempty"`
	// Altitude accuracy / uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if \"shape\" equals 3 or 4
	AccuracyAltitude int32 `json:"accuracyAltitude,omitempty"`
	// Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if \"shape\" equals 4, 5 or 6
	AccuracySemiMinor int32 `json:"accuracySemiMinor,omitempty"`
	// Location altitude relative to the WGS84 ellipsoid surface.
	Altitude float32 `json:"altitude,omitempty"`
	// Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in ETSI TS 123 032 [14]. Present only if \"shape\" equals 1, 4 or 6
	Confidence int32 `json:"confidence,omitempty"`
	// Present only if \"shape\" equals 6
	IncludedAngle int32 `json:"includedAngle,omitempty"`
	// Present only if \"shape\" equals 6
	InnerRadius int32 `json:"innerRadius,omitempty"`
	// Location latitude, expressed in the range -90° to +90°. Cardinality greater than one only if \"shape\" equals 7.
	Latitude []float32 `json:"latitude"`
	// Location longitude, expressed in the range -180° to +180°. Cardinality greater than one only if \"shape\" equals 7.
	Longitude []float32 `json:"longitude"`
	// Present only if \"shape\" equals 6
	OffsetAngle int32 `json:"offsetAngle,omitempty"`
	// Angle of orientation of the major axis, expressed in the range 0° to 180°, as defined in ETSI TS 123 032 [14]. Present only if \"shape\" equals 4 or 6
	OrientationMajorAxis int32 `json:"orientationMajorAxis,omitempty"`
	// Shape information, as detailed in ETSI TS 123 032 [14], associated with the reported location coordinate: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON
	Shape     int32      `json:"shape"`
	Timestamp *TimeStamp `json:"timestamp,omitempty"`
	// Present only if \"shape\" equals 6
	UncertaintyRadius int32                 `json:"uncertaintyRadius,omitempty"`
	Velocity          *LocationInfoVelocity `json:"velocity,omitempty"`
}

type LocationInfoVelocity

type LocationInfoVelocity struct {
	// Bearing, expressed in the range 0° to 360°, as defined in ETSI TS 123 032 [14].
	Bearing int32 `json:"bearing"`
	// Horizontal speed, expressed in km/h and defined in ETSI TS 123 032 [14].
	HorizontalSpeed int32 `json:"horizontalSpeed"`
	// Horizontal uncertainty, as defined in ETSI TS 123 032 [14]. Present only if \"velocityType\" equals 3 or 4
	Uncertainty int32 `json:"uncertainty,omitempty"`
	// Velocity information, as detailed in ETSI TS 123 032 [14], associated with the reported location coordinate: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT
	VelocityType int32 `json:"velocityType"`
	// Vertical speed, expressed in km/h and defined in ETSI TS 123 032 [14]. Present only if \"velocityType\" equals 2 or 4
	VerticalSpeed int32 `json:"verticalSpeed,omitempty"`
	// Vertical uncertainty, as defined in ETSI TS 123 032 [14]. Present only if \"velocityType\" equals 4
	VerticalUncertainty int32 `json:"verticalUncertainty,omitempty"`
}

Structure with attributes relating to the target entity’s velocity, as defined in ETSI TS 123 032 [14].

type NotificationFormat

type NotificationFormat string
const (
	XML_NotificationFormat  NotificationFormat = "XML"
	JSON_NotificationFormat NotificationFormat = "JSON"
)

List of NotificationFormat

type NotificationSubscriptionList

type NotificationSubscriptionList struct {
	// Collection of CircleNotificationSubscription elements, see note 2.
	CircleNotificationSubscription []CircleNotificationSubscription `json:"circleNotificationSubscription,omitempty"`
	// Collection of DistanceNotificationSubscription elements, see note 2.
	DistanceNotificationSubscription []DistanceNotificationSubscription `json:"distanceNotificationSubscription,omitempty"`
	// Collection of PeriodicNotificationSubscription elements, see note 2.
	PeriodicNotificationSubscription []PeriodicNotificationSubscription `json:"periodicNotificationSubscription,omitempty"`
	// Self-referring URL, see note 1.
	ResourceURL string `json:"resourceURL"`
	// Collection of UserTrackingSubscription elements, see note 1.
	UserTrackingSubscription []UserTrackingSubscription `json:"userTrackingSubscription,omitempty"`
	// Collection of ZonalTrafficSubscription elements, see note 1.
	ZonalTrafficSubscription []ZonalTrafficSubscription `json:"zonalTrafficSubscription,omitempty"`
	// Collection of ZoneStatusSubscription elements, see note 1.
	ZoneStatusSubscription []ZoneStatusSubscription `json:"zoneStatusSubscription,omitempty"`
}

type OperationActionType

type OperationActionType string

OperationActionType : Operation that is being performed on the MEC application instance.

const (
	STOPPING_OperationActionType    OperationActionType = "STOPPING"
	TERMINATING_OperationActionType OperationActionType = "TERMINATING"
)

List of OperationActionType

type OperationStatus

type OperationStatus string
const (
	SERVICEABLE_OperationStatus   OperationStatus = "Serviceable"
	UNSERVICEABLE_OperationStatus OperationStatus = "Unserviceable"
	UNKNOWN_OperationStatus       OperationStatus = "Unknown"
)

List of OperationStatus

type PeriodicNotificationSubscription

type PeriodicNotificationSubscription struct {
	// Address of terminals to monitor (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
	Address           []string           `json:"address"`
	CallbackReference *CallbackReference `json:"callbackReference"`
	// A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
	ClientCorrelator string `json:"clientCorrelator,omitempty"`
	// Period of time (in seconds) notifications are provided for. If set to “0” (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications.
	Duration int32 `json:"duration,omitempty"`
	// Maximum frequency (in seconds) of notifications (can also be considered minimum time between notifications) per subscription.
	Frequency int32 `json:"frequency"`
	// Link to other resources that are in relationship with the resource.
	Link []Link `json:"link,omitempty"`
	// Accuracy of the provided distance in meters.
	RequestedAccuracy int32 `json:"requestedAccuracy"`
	// Identifies the entity that is requesting the information (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)
	Requester string `json:"requester,omitempty"`
	// Self referring URL
	ResourceURL string `json:"resourceURL,omitempty"`
}

A type containing data for periodic subscription.

type ProblemDetails

type ProblemDetails struct {
	// A human-readable explanation specific to this occurrence of the problem
	Detail string `json:"detail,omitempty"`
	// A URI reference that identifies the specific occurrence of the problem
	Instance string `json:"instance,omitempty"`
	// The HTTP status code for this occurrence of the problem
	Status int32 `json:"status,omitempty"`
	// A short, human-readable summary of the problem type
	Title string `json:"title,omitempty"`
	// A URI reference according to IETF RFC 3986 that identifies the problem type
	Type_ string `json:"type,omitempty"`
}

type RetrievalStatus

type RetrievalStatus string
const (
	RETRIEVED_RetrievalStatus     RetrievalStatus = "Retrieved"
	NOT_RETRIEVED_RetrievalStatus RetrievalStatus = "NotRetrieved"
	ERROR__RetrievalStatus        RetrievalStatus = "Error"
)

List of RetrievalStatus

type ServiceError

type ServiceError struct {
	// Message identifier, either with prefix SVC or with prefix POL
	MessageId string `json:"messageId"`
	// Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1
	Text string `json:"text"`
	// Variables to substitute into text string
	Variables []string `json:"variables,omitempty"`
}

used to indicate a notification termination or cancellation.

type SubscriptionNotification

type SubscriptionNotification struct {
	// CallbackData if passed by the application in the receiptRequest element during the associated subscription operation
	CallbackData            string                   `json:"callbackData,omitempty"`
	DistanceCriteria        *DistanceCriteria        `json:"distanceCriteria,omitempty"`
	EnteringLeavingCriteria *EnteringLeavingCriteria `json:"enteringLeavingCriteria,omitempty"`
	// Set to true if it is a final notification about location change.
	IsFinalNotification bool `json:"isFinalNotification,omitempty"`
	// Link to other resources that are in relationship with the resource.
	Link []Link `json:"link,omitempty"`
	// Collection of the terminal locations.
	TerminalLocation []TerminalLocation `json:"terminalLocation"`
}

A type containing the notification subscription.

type TerminalDistance

type TerminalDistance struct {
	// Accuracy of the provided distance in meters
	Accuracy int32 `json:"accuracy,omitempty"`
	// Distance from terminal to a location or between two terminals specified in meters
	Distance  int32      `json:"distance"`
	Timestamp *TimeStamp `json:"timestamp,omitempty"`
}

A type containing information about the distance from a terminal to a location or between two terminals, in addition the accuracy and a timestamp of the information are provided.

type TerminalLocation

type TerminalLocation struct {
	// Address of the terminal to which the location information applies (e.g., 'sip' URI, 'tel' URI, 'acr' URI).
	Address                 string           `json:"address"`
	CurrentLocation         *LocationInfo    `json:"currentLocation,omitempty"`
	ErrorInformation        *ServiceError    `json:"errorInformation,omitempty"`
	LocationRetrievalStatus *RetrievalStatus `json:"locationRetrievalStatus"`
}

A type containing device address, retrieval status and location information.

type TimeStamp

type TimeStamp struct {
	// The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
	NanoSeconds int32 `json:"nanoSeconds"`
	// The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
	Seconds int32 `json:"seconds"`
}

type UserEventType

type UserEventType string
const (
	ENTERING_UserEventType     UserEventType = "Entering"
	LEAVING_UserEventType      UserEventType = "Leaving"
	TRANSFERRING_UserEventType UserEventType = "Transferring"
)

List of UserEventType

type UserInfo

type UserInfo struct {
	// The identity of the access point the user is currently on, see note 1.
	AccessPointId string `json:"accessPointId"`
	// Address of user (e.g. 'sip' URI, 'tel' URI, 'acr' URI) currently on the access point, see note 1.
	Address string `json:"address"`
	// Reserved for future use.
	AncillaryInfo string `json:"ancillaryInfo,omitempty"`
	// Contextual information of a user location (e.g. aisle, floor, room number, etc.).
	ContextLocationInfo string        `json:"contextLocationInfo,omitempty"`
	LocationInfo        *LocationInfo `json:"locationInfo,omitempty"`
	// Self-referring URL, see note 1.
	ResourceURL string     `json:"resourceURL"`
	Timestamp   *TimeStamp `json:"timestamp"`
	// The identity of the zone the user is currently within, see note 1.
	ZoneId string `json:"zoneId"`
}

type UserList

type UserList struct {
	// Self referring URL
	ResourceURL string `json:"resourceURL"`
	// Collection of the zone information list.
	User []UserInfo `json:"user,omitempty"`
}

A type containing list of users.

type UserTrackingSubscription

type UserTrackingSubscription struct {
	// Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI) to monitor
	Address           string             `json:"address"`
	CallbackReference *CallbackReference `json:"callbackReference"`
	// A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
	ClientCorrelator string `json:"clientCorrelator,omitempty"`
	// Self referring URL
	ResourceURL string `json:"resourceURL,omitempty"`
	// 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.
	UserEventCriteria []UserEventType `json:"userEventCriteria,omitempty"`
}

A type containing user tracking subscription.

type UsersGETOpts

type UsersGETOpts struct {
	ZoneId        optional.Interface
	AccessPointId optional.Interface
	Address       optional.Interface
}

type ZonalPresenceNotification

type ZonalPresenceNotification struct {
	// Address of user (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI) to monitor
	Address string `json:"address"`
	// CallBackData if passed by the application during the associated ZonalTrafficSubscription and UserTrackingSubscription operation. See [REST_NetAPI_Common].
	CallbackData string `json:"callbackData,omitempty"`
	// Identifier of access point.
	CurrentAccessPointId string `json:"currentAccessPointId"`
	// Interest realm of access point (e.g. geographical area, a type of industry etc.).
	InterestRealm string `json:"interestRealm,omitempty"`
	// 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
	Link []Link `json:"link,omitempty"`
	// Identifier of access point.
	PreviousAccessPointId string         `json:"previousAccessPointId,omitempty"`
	Timestamp             *TimeStamp     `json:"timestamp"`
	UserEventType         *UserEventType `json:"userEventType"`
	// Identifier of zone
	ZoneId string `json:"zoneId"`
}

A type containing zonal presence notification

type ZonalTrafficSubscription

type ZonalTrafficSubscription struct {
	CallbackReference *CallbackReference `json:"callbackReference"`
	// A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
	ClientCorrelator string `json:"clientCorrelator,omitempty"`
	// 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.
	Duration int32 `json:"duration,omitempty"`
	// Interest realm of access point (e.g. geographical area, a type of industry etc.).
	InterestRealm []string `json:"interestRealm,omitempty"`
	// Self referring URL
	ResourceURL string `json:"resourceURL,omitempty"`
	// 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.
	UserEventCriteria []UserEventType `json:"userEventCriteria,omitempty"`
	// Identifier of zone
	ZoneId string `json:"zoneId"`
}

A type containing zonal traffic subscription

type ZoneInfo

type ZoneInfo struct {
	// The number of access points within the zone
	NumberOfAccessPoints int32 `json:"numberOfAccessPoints"`
	// Number of inoperable access points within the zone.
	NumberOfUnserviceableAccessPoints int32 `json:"numberOfUnserviceableAccessPoints"`
	// The number of users currently on the access point.
	NumberOfUsers int32 `json:"numberOfUsers"`
	// Self referring URL
	ResourceURL string `json:"resourceURL"`
	// Identifier of zone
	ZoneId string `json:"zoneId"`
}

A type containing zone information.

type ZoneList

type ZoneList struct {
	// Self referring URL
	ResourceURL string `json:"resourceURL"`
	// Collection of the zone information list.
	Zone []ZoneInfo `json:"zone,omitempty"`
}

A type containing a list of zones.

type ZoneStatusNotification

type ZoneStatusNotification struct {
	// Identifier of an access point.
	AccessPointId string `json:"accessPointId,omitempty"`
	// CallBackData if passed by the application during the associated ZoneStatusSubscription operation. See [REST_NetAPI_Common].
	CallbackData string `json:"callbackData,omitempty"`
	// 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
	Link []Link `json:"link,omitempty"`
	// 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.
	NumberOfUsersInAP int32 `json:"numberOfUsersInAP,omitempty"`
	// 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.
	NumberOfUsersInZone int32            `json:"numberOfUsersInZone,omitempty"`
	OperationStatus     *OperationStatus `json:"operationStatus,omitempty"`
	Timestamp           *TimeStamp       `json:"timestamp"`
	// Identifier of zone
	ZoneId string `json:"zoneId"`
}

A type containing zone status notification.

type ZoneStatusSubscription

type ZoneStatusSubscription struct {
	CallbackReference *CallbackReference `json:"callbackReference"`
	// A correlator that the client can use to tag this particular resource representation during a request to create a resource on the server.
	ClientCorrelator string `json:"clientCorrelator,omitempty"`
	// Threshold number of users in an access point which if crossed shall cause a notification
	NumberOfUsersAPThreshold int32 `json:"numberOfUsersAPThreshold,omitempty"`
	// Threshold number of users in a zone which if crossed shall cause a notification
	NumberOfUsersZoneThreshold int32 `json:"numberOfUsersZoneThreshold,omitempty"`
	// List of operation status values to generate notifications for (these apply to all access points within a zone).
	OperationStatus []OperationStatus `json:"operationStatus,omitempty"`
	// Self referring URL
	ResourceURL string `json:"resourceURL,omitempty"`
	// Identifier of zone
	ZoneId string `json:"zoneId"`
}

A type containing zone status subscription.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL