UNOV/manager-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
manager-app/manager_api_new/doc/SectionMapApi.md
Thomas Fransolet 986bb7fab2 Wip service generation
2025-07-17 12:11:59 +02:00

16 KiB
Raw Blame History

manager_api_new.api.SectionMapApi

Load the API package

import 'package:manager_api_new/api.dart';

All URIs are relative to https://localhost:5001

Method HTTP request Description
sectionMapCreate POST /api/SectionMap/{sectionId}/points
sectionMapCreateGuidedPath POST /api/SectionMap/{sectionMapId}/guided-path
sectionMapCreateGuidedStep POST /api/SectionMap/guided-path/{guidedPathId}/guided-step
sectionMapDelete DELETE /api/SectionMap/points/{geoPointId}
sectionMapDeleteGuidedPath DELETE /api/SectionMap/guided-path/{guidedPathId}
sectionMapDeleteGuidedStep DELETE /api/SectionMap/guided-step/{guidedStepId}
sectionMapGetAllGeoPointsFromSection GET /api/SectionMap/{sectionId}/points
sectionMapGetAllGuidedPathFromSection GET /api/SectionMap/{sectionMapId}/guided-path
sectionMapGetAllGuidedStepFromGuidedPath GET /api/SectionMap/guided-path/{guidedPathId}/guided-step
sectionMapUpdate PUT /api/SectionMap
sectionMapUpdateGuidedPath PUT /api/SectionMap/guided-path
sectionMapUpdateGuidedStep PUT /api/SectionMap/guided-step

sectionMapCreate

GeoPointDTO sectionMapCreate(sectionId, geoPointDTO)

Example

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

Return type

GeoPointDTO

Authorization

bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapCreateGuidedPath

GuidedPathDTO sectionMapCreateGuidedPath(sectionMapId, guidedPathDTO)

Example

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

Return type

GuidedPathDTO

Authorization

bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapCreateGuidedStep

GuidedStepDTO sectionMapCreateGuidedStep(guidedPathId, guidedStepDTO)

Example

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

Return type

GuidedStepDTO

Authorization

bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapDelete

String sectionMapDelete(geoPointId)

Example

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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapDeleteGuidedPath

String sectionMapDeleteGuidedPath(guidedPathId)

Example

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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapDeleteGuidedStep

String sectionMapDeleteGuidedStep(guidedStepId)

Example

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

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapGetAllGeoPointsFromSection

List sectionMapGetAllGeoPointsFromSection(sectionId)

Example

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

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapGetAllGuidedPathFromSection

List sectionMapGetAllGuidedPathFromSection(sectionMapId)

Example

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

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapGetAllGuidedStepFromGuidedPath

List sectionMapGetAllGuidedStepFromGuidedPath(guidedPathId)

Example

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

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapUpdate

GeoPoint sectionMapUpdate(geoPointDTO)

Example

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

Return type

GeoPoint

Authorization

bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapUpdateGuidedPath

GuidedPathDTO sectionMapUpdateGuidedPath(guidedPathDTO)

Example

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

Return type

GuidedPathDTO

Authorization

bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sectionMapUpdateGuidedStep

GuidedStepDTO sectionMapUpdateGuidedStep(guidedStepDTO)

Example

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

Return type

GuidedStepDTO

Authorization

bearer

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]