548 lines
16 KiB
Markdown
548 lines
16 KiB
Markdown
# manager_api_new.api.SectionMapApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *https://localhost:5001*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**sectionMapCreate**](SectionMapApi.md#sectionmapcreate) | **POST** /api/SectionMap/{sectionId}/points |
|
|
[**sectionMapCreateGuidedPath**](SectionMapApi.md#sectionmapcreateguidedpath) | **POST** /api/SectionMap/{sectionMapId}/guided-path |
|
|
[**sectionMapCreateGuidedStep**](SectionMapApi.md#sectionmapcreateguidedstep) | **POST** /api/SectionMap/guided-path/{guidedPathId}/guided-step |
|
|
[**sectionMapDelete**](SectionMapApi.md#sectionmapdelete) | **DELETE** /api/SectionMap/points/{geoPointId} |
|
|
[**sectionMapDeleteGuidedPath**](SectionMapApi.md#sectionmapdeleteguidedpath) | **DELETE** /api/SectionMap/guided-path/{guidedPathId} |
|
|
[**sectionMapDeleteGuidedStep**](SectionMapApi.md#sectionmapdeleteguidedstep) | **DELETE** /api/SectionMap/guided-step/{guidedStepId} |
|
|
[**sectionMapGetAllGeoPointsFromSection**](SectionMapApi.md#sectionmapgetallgeopointsfromsection) | **GET** /api/SectionMap/{sectionId}/points |
|
|
[**sectionMapGetAllGuidedPathFromSection**](SectionMapApi.md#sectionmapgetallguidedpathfromsection) | **GET** /api/SectionMap/{sectionMapId}/guided-path |
|
|
[**sectionMapGetAllGuidedStepFromGuidedPath**](SectionMapApi.md#sectionmapgetallguidedstepfromguidedpath) | **GET** /api/SectionMap/guided-path/{guidedPathId}/guided-step |
|
|
[**sectionMapUpdate**](SectionMapApi.md#sectionmapupdate) | **PUT** /api/SectionMap |
|
|
[**sectionMapUpdateGuidedPath**](SectionMapApi.md#sectionmapupdateguidedpath) | **PUT** /api/SectionMap/guided-path |
|
|
[**sectionMapUpdateGuidedStep**](SectionMapApi.md#sectionmapupdateguidedstep) | **PUT** /api/SectionMap/guided-step |
|
|
|
|
|
|
# **sectionMapCreate**
|
|
> GeoPointDTO sectionMapCreate(sectionId, geoPointDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final sectionId = sectionId_example; // String |
|
|
final geoPointDTO = GeoPointDTO(); // GeoPointDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapCreate(sectionId, geoPointDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapCreate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**sectionId** | **String**| |
|
|
**geoPointDTO** | [**GeoPointDTO**](GeoPointDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**GeoPointDTO**](GeoPointDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### 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)
|
|
|
|
# **sectionMapCreateGuidedPath**
|
|
> GuidedPathDTO sectionMapCreateGuidedPath(sectionMapId, guidedPathDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final sectionMapId = sectionMapId_example; // String |
|
|
final guidedPathDTO = GuidedPathDTO(); // GuidedPathDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapCreateGuidedPath(sectionMapId, guidedPathDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapCreateGuidedPath: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**sectionMapId** | **String**| |
|
|
**guidedPathDTO** | [**GuidedPathDTO**](GuidedPathDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**GuidedPathDTO**](GuidedPathDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### 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)
|
|
|
|
# **sectionMapCreateGuidedStep**
|
|
> GuidedStepDTO sectionMapCreateGuidedStep(guidedPathId, guidedStepDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final guidedPathId = guidedPathId_example; // String |
|
|
final guidedStepDTO = GuidedStepDTO(); // GuidedStepDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapCreateGuidedStep(guidedPathId, guidedStepDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapCreateGuidedStep: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**guidedPathId** | **String**| |
|
|
**guidedStepDTO** | [**GuidedStepDTO**](GuidedStepDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**GuidedStepDTO**](GuidedStepDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### 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)
|
|
|
|
# **sectionMapDelete**
|
|
> String sectionMapDelete(geoPointId)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final geoPointId = 56; // int |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapDelete(geoPointId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapDelete: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**geoPointId** | **int**| |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **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)
|
|
|
|
# **sectionMapDeleteGuidedPath**
|
|
> String sectionMapDeleteGuidedPath(guidedPathId)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final guidedPathId = guidedPathId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapDeleteGuidedPath(guidedPathId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapDeleteGuidedPath: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**guidedPathId** | **String**| |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **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)
|
|
|
|
# **sectionMapDeleteGuidedStep**
|
|
> String sectionMapDeleteGuidedStep(guidedStepId)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final guidedStepId = guidedStepId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapDeleteGuidedStep(guidedStepId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapDeleteGuidedStep: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**guidedStepId** | **String**| |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **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)
|
|
|
|
# **sectionMapGetAllGeoPointsFromSection**
|
|
> List<GeoPointDTO> sectionMapGetAllGeoPointsFromSection(sectionId)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final sectionId = sectionId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapGetAllGeoPointsFromSection(sectionId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapGetAllGeoPointsFromSection: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**sectionId** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**List<GeoPointDTO>**](GeoPointDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **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)
|
|
|
|
# **sectionMapGetAllGuidedPathFromSection**
|
|
> List<GuidedPathDTO> sectionMapGetAllGuidedPathFromSection(sectionMapId)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final sectionMapId = sectionMapId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapGetAllGuidedPathFromSection(sectionMapId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapGetAllGuidedPathFromSection: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**sectionMapId** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**List<GuidedPathDTO>**](GuidedPathDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **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)
|
|
|
|
# **sectionMapGetAllGuidedStepFromGuidedPath**
|
|
> List<GuidedStepDTO> sectionMapGetAllGuidedStepFromGuidedPath(guidedPathId)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final guidedPathId = guidedPathId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapGetAllGuidedStepFromGuidedPath(guidedPathId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapGetAllGuidedStepFromGuidedPath: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**guidedPathId** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**List<GuidedStepDTO>**](GuidedStepDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **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)
|
|
|
|
# **sectionMapUpdate**
|
|
> GeoPointDTO sectionMapUpdate(geoPointDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final geoPointDTO = GeoPointDTO(); // GeoPointDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapUpdate(geoPointDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapUpdate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**geoPointDTO** | [**GeoPointDTO**](GeoPointDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**GeoPointDTO**](GeoPointDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### 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)
|
|
|
|
# **sectionMapUpdateGuidedPath**
|
|
> GuidedPathDTO sectionMapUpdateGuidedPath(guidedPathDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final guidedPathDTO = GuidedPathDTO(); // GuidedPathDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapUpdateGuidedPath(guidedPathDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapUpdateGuidedPath: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**guidedPathDTO** | [**GuidedPathDTO**](GuidedPathDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**GuidedPathDTO**](GuidedPathDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### 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)
|
|
|
|
# **sectionMapUpdateGuidedStep**
|
|
> GuidedStepDTO sectionMapUpdateGuidedStep(guidedStepDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = SectionMapApi();
|
|
final guidedStepDTO = GuidedStepDTO(); // GuidedStepDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionMapUpdateGuidedStep(guidedStepDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionMapApi->sectionMapUpdateGuidedStep: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**guidedStepDTO** | [**GuidedStepDTO**](GuidedStepDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**GuidedStepDTO**](GuidedStepDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### 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)
|
|
|