manager-app/manager_api_new/doc/SectionMapApi.md
Thomas Fransolet e16e898140 Map done !
2025-05-15 15:11:21 +02:00

192 lines
5.1 KiB
Markdown

# manager_api_new.api.SectionMapApi
## Load the API package
```dart
import 'package:manager_api_new/api.dart';
```
All URIs are relative to *http://localhost:5000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**sectionMapCreate**](SectionMapApi.md#sectionmapcreate) | **POST** /api/SectionMap/{sectionId}/points |
[**sectionMapDelete**](SectionMapApi.md#sectionmapdelete) | **DELETE** /api/SectionMap/points/delete/{geoPointId} |
[**sectionMapGetAllGeoPointsFromSection**](SectionMapApi.md#sectionmapgetallgeopointsfromsection) | **GET** /api/SectionMap/{sectionId}/points |
[**sectionMapUpdate**](SectionMapApi.md#sectionmapupdate) | **PUT** /api/SectionMap |
# **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)
# **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)
# **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)
# **sectionMapUpdate**
> GeoPoint 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
[**GeoPoint**](GeoPoint.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)