# AdvantEdgeGisEngineRestApi.GeospatialDataApi

All URIs are relative to *https://localhost/sandboxname/gis/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteGeoDataByName**](GeospatialDataApi.md#deleteGeoDataByName) | **DELETE** /geodata/{assetName} | Delete geospatial data
[**getAssetData**](GeospatialDataApi.md#getAssetData) | **GET** /geodata | Get geospatial data
[**getDistanceGeoDataByName**](GeospatialDataApi.md#getDistanceGeoDataByName) | **POST** /geodata/{assetName}/distanceTo | Get distance between geospatial data points
[**getGeoDataByName**](GeospatialDataApi.md#getGeoDataByName) | **GET** /geodata/{assetName} | Get geospatial data
[**getGeoDataPowerValues**](GeospatialDataApi.md#getGeoDataPowerValues) | **POST** /geodata/cellularPower | Get RSRQ and RSRP values for a list of coordinates
[**getWithinRangeByName**](GeospatialDataApi.md#getWithinRangeByName) | **POST** /geodata/{assetName}/withinRange | Returns if a geospatial data points is within a specified distance from a location
[**updateGeoDataByName**](GeospatialDataApi.md#updateGeoDataByName) | **POST** /geodata/{assetName} | Create/Update geospatial data


<a name="deleteGeoDataByName"></a>
# **deleteGeoDataByName**
> deleteGeoDataByName(assetName)

Delete geospatial data

Delete geospatial data for the given asset

### Example
```javascript
var AdvantEdgeGisEngineRestApi = require('advant_edge_gis_engine_rest_api');

var apiInstance = new AdvantEdgeGisEngineRestApi.GeospatialDataApi();

var assetName = "assetName_example"; // String | Name of geospatial asset


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteGeoDataByName(assetName, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetName** | **String**| Name of geospatial asset | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getAssetData"></a>
# **getAssetData**
> GeoDataAssetList getAssetData(opts)

Get geospatial data

Get geospatial data for all assets present in database

### Example
```javascript
var AdvantEdgeGisEngineRestApi = require('advant_edge_gis_engine_rest_api');

var apiInstance = new AdvantEdgeGisEngineRestApi.GeospatialDataApi();

var opts = { 
  'assetType': "assetType_example", // String | Filter by asset type
  'subType': "subType_example", // String | Filter by asset sub type
  'excludePath': "excludePath_example" // String | Exclude UE paths in response (default: false)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getAssetData(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetType** | **String**| Filter by asset type | [optional] 
 **subType** | **String**| Filter by asset sub type | [optional] 
 **excludePath** | **String**| Exclude UE paths in response (default: false) | [optional] 

### Return type

[**GeoDataAssetList**](GeoDataAssetList.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getDistanceGeoDataByName"></a>
# **getDistanceGeoDataByName**
> Distance getDistanceGeoDataByName(assetName, targetPoint)

Get distance between geospatial data points

Get distance between geospatial data for the given asset and another asset or geospatial coordinates

### Example
```javascript
var AdvantEdgeGisEngineRestApi = require('advant_edge_gis_engine_rest_api');

var apiInstance = new AdvantEdgeGisEngineRestApi.GeospatialDataApi();

var assetName = "assetName_example"; // String | Name of geospatial asset

var targetPoint = new AdvantEdgeGisEngineRestApi.TargetPoint(); // TargetPoint | Parameters of geospatial assets


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDistanceGeoDataByName(assetName, targetPoint, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetName** | **String**| Name of geospatial asset | 
 **targetPoint** | [**TargetPoint**](TargetPoint.md)| Parameters of geospatial assets | 

### Return type

[**Distance**](Distance.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getGeoDataByName"></a>
# **getGeoDataByName**
> GeoDataAsset getGeoDataByName(assetName, opts)

Get geospatial data

Get geospatial data for the given asset

### Example
```javascript
var AdvantEdgeGisEngineRestApi = require('advant_edge_gis_engine_rest_api');

var apiInstance = new AdvantEdgeGisEngineRestApi.GeospatialDataApi();

var assetName = "assetName_example"; // String | Name of geospatial asset

var opts = { 
  'excludePath': "excludePath_example" // String | Exclude UE paths in response (default: false)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getGeoDataByName(assetName, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetName** | **String**| Name of geospatial asset | 
 **excludePath** | **String**| Exclude UE paths in response (default: false) | [optional] 

### Return type

[**GeoDataAsset**](GeoDataAsset.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getGeoDataPowerValues"></a>
# **getGeoDataPowerValues**
> CoordinatePowerList getGeoDataPowerValues(coordinates)

Get RSRQ and RSRP values for a list of coordinates

Get RSRQ and RSRP values for a list of coordinates

### Example
```javascript
var AdvantEdgeGisEngineRestApi = require('advant_edge_gis_engine_rest_api');

var apiInstance = new AdvantEdgeGisEngineRestApi.GeospatialDataApi();

var coordinates = new AdvantEdgeGisEngineRestApi.GeoCoordinateList(); // GeoCoordinateList | List of geo coordinates


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getGeoDataPowerValues(coordinates, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **coordinates** | [**GeoCoordinateList**](GeoCoordinateList.md)| List of geo coordinates | 

### Return type

[**CoordinatePowerList**](CoordinatePowerList.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getWithinRangeByName"></a>
# **getWithinRangeByName**
> WithinRange getWithinRangeByName(assetName, targetRange)

Returns if a geospatial data points is within a specified distance from a location

Get geospatial data for the given asset and if it is within range of another asset or geospatial coordinates

### Example
```javascript
var AdvantEdgeGisEngineRestApi = require('advant_edge_gis_engine_rest_api');

var apiInstance = new AdvantEdgeGisEngineRestApi.GeospatialDataApi();

var assetName = "assetName_example"; // String | Name of geospatial asset

var targetRange = new AdvantEdgeGisEngineRestApi.TargetRange(); // TargetRange | Parameters of geospatial assets


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getWithinRangeByName(assetName, targetRange, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetName** | **String**| Name of geospatial asset | 
 **targetRange** | [**TargetRange**](TargetRange.md)| Parameters of geospatial assets | 

### Return type

[**WithinRange**](WithinRange.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="updateGeoDataByName"></a>
# **updateGeoDataByName**
> updateGeoDataByName(assetName, geoData)

Create/Update geospatial data

Create/Update geospatial data for the given asset

### Example
```javascript
var AdvantEdgeGisEngineRestApi = require('advant_edge_gis_engine_rest_api');

var apiInstance = new AdvantEdgeGisEngineRestApi.GeospatialDataApi();

var assetName = "assetName_example"; // String | Name of geospatial asset

var geoData = new AdvantEdgeGisEngineRestApi.GeoDataAsset(); // GeoDataAsset | Geospatial data


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updateGeoDataByName(assetName, geoData, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **assetName** | **String**| Name of geospatial asset | 
 **geoData** | [**GeoDataAsset**](GeoDataAsset.md)| Geospatial data | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

