370 lines
11 KiB
Markdown
370 lines
11 KiB
Markdown
# manager_api_new.api.SectionEventApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *https://localhost:5001*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**sectionEventCreateMapAnnotation**](SectionEventApi.md#sectioneventcreatemapannotation) | **POST** /api/SectionEvent/{programmeBlockId}/map-annotations |
|
|
[**sectionEventCreateProgrammeBlock**](SectionEventApi.md#sectioneventcreateprogrammeblock) | **POST** /api/SectionEvent/{sectionEventId}/programmes |
|
|
[**sectionEventDeleteMapAnnotation**](SectionEventApi.md#sectioneventdeletemapannotation) | **DELETE** /api/SectionEvent/map-annotations/{mapAnnotationId} |
|
|
[**sectionEventDeleteProgrammeBlock**](SectionEventApi.md#sectioneventdeleteprogrammeblock) | **DELETE** /api/SectionEvent/programmes/{programBlockId} |
|
|
[**sectionEventGetAllMapAnnotationsFromProgrammeBlock**](SectionEventApi.md#sectioneventgetallmapannotationsfromprogrammeblock) | **GET** /api/SectionEvent/{programBlockId}/map-annotations |
|
|
[**sectionEventGetAllProgrammeBlockFromSection**](SectionEventApi.md#sectioneventgetallprogrammeblockfromsection) | **GET** /api/SectionEvent/{sectionEventId}/programmes |
|
|
[**sectionEventUpdateMapAnnotation**](SectionEventApi.md#sectioneventupdatemapannotation) | **PUT** /api/SectionEvent/map-annotations |
|
|
[**sectionEventUpdateProgrammeBlock**](SectionEventApi.md#sectioneventupdateprogrammeblock) | **PUT** /api/SectionEvent/programmes |
|
|
|
|
|
|
# **sectionEventCreateMapAnnotation**
|
|
> MapAnnotationDTO sectionEventCreateMapAnnotation(programmeBlockId, mapAnnotationDTO)
|
|
|
|
|
|
|
|
### 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 = SectionEventApi();
|
|
final programmeBlockId = programmeBlockId_example; // String |
|
|
final mapAnnotationDTO = MapAnnotationDTO(); // MapAnnotationDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionEventCreateMapAnnotation(programmeBlockId, mapAnnotationDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionEventApi->sectionEventCreateMapAnnotation: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**programmeBlockId** | **String**| |
|
|
**mapAnnotationDTO** | [**MapAnnotationDTO**](MapAnnotationDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**MapAnnotationDTO**](MapAnnotationDTO.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)
|
|
|
|
# **sectionEventCreateProgrammeBlock**
|
|
> ProgrammeBlockDTO sectionEventCreateProgrammeBlock(sectionEventId, programmeBlockDTO)
|
|
|
|
|
|
|
|
### 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 = SectionEventApi();
|
|
final sectionEventId = sectionEventId_example; // String |
|
|
final programmeBlockDTO = ProgrammeBlockDTO(); // ProgrammeBlockDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionEventCreateProgrammeBlock(sectionEventId, programmeBlockDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionEventApi->sectionEventCreateProgrammeBlock: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**sectionEventId** | **String**| |
|
|
**programmeBlockDTO** | [**ProgrammeBlockDTO**](ProgrammeBlockDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**ProgrammeBlockDTO**](ProgrammeBlockDTO.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)
|
|
|
|
# **sectionEventDeleteMapAnnotation**
|
|
> String sectionEventDeleteMapAnnotation(mapAnnotationId)
|
|
|
|
|
|
|
|
### 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 = SectionEventApi();
|
|
final mapAnnotationId = mapAnnotationId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionEventDeleteMapAnnotation(mapAnnotationId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionEventApi->sectionEventDeleteMapAnnotation: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**mapAnnotationId** | **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)
|
|
|
|
# **sectionEventDeleteProgrammeBlock**
|
|
> String sectionEventDeleteProgrammeBlock(programBlockId)
|
|
|
|
|
|
|
|
### 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 = SectionEventApi();
|
|
final programBlockId = programBlockId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionEventDeleteProgrammeBlock(programBlockId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionEventApi->sectionEventDeleteProgrammeBlock: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**programBlockId** | **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)
|
|
|
|
# **sectionEventGetAllMapAnnotationsFromProgrammeBlock**
|
|
> List<MapAnnotationDTO> sectionEventGetAllMapAnnotationsFromProgrammeBlock(programBlockId)
|
|
|
|
|
|
|
|
### 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 = SectionEventApi();
|
|
final programBlockId = programBlockId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionEventGetAllMapAnnotationsFromProgrammeBlock(programBlockId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionEventApi->sectionEventGetAllMapAnnotationsFromProgrammeBlock: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**programBlockId** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**List<MapAnnotationDTO>**](MapAnnotationDTO.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)
|
|
|
|
# **sectionEventGetAllProgrammeBlockFromSection**
|
|
> List<ProgrammeBlock> sectionEventGetAllProgrammeBlockFromSection(sectionEventId)
|
|
|
|
|
|
|
|
### 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 = SectionEventApi();
|
|
final sectionEventId = sectionEventId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.sectionEventGetAllProgrammeBlockFromSection(sectionEventId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionEventApi->sectionEventGetAllProgrammeBlockFromSection: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**sectionEventId** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**List<ProgrammeBlock>**](ProgrammeBlock.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)
|
|
|
|
# **sectionEventUpdateMapAnnotation**
|
|
> MapAnnotationDTO sectionEventUpdateMapAnnotation(mapAnnotationDTO)
|
|
|
|
|
|
|
|
### 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 = SectionEventApi();
|
|
final mapAnnotationDTO = MapAnnotationDTO(); // MapAnnotationDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionEventUpdateMapAnnotation(mapAnnotationDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionEventApi->sectionEventUpdateMapAnnotation: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**mapAnnotationDTO** | [**MapAnnotationDTO**](MapAnnotationDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**MapAnnotationDTO**](MapAnnotationDTO.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)
|
|
|
|
# **sectionEventUpdateProgrammeBlock**
|
|
> ProgrammeBlockDTO sectionEventUpdateProgrammeBlock(programmeBlockDTO)
|
|
|
|
|
|
|
|
### 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 = SectionEventApi();
|
|
final programmeBlockDTO = ProgrammeBlockDTO(); // ProgrammeBlockDTO |
|
|
|
|
try {
|
|
final result = api_instance.sectionEventUpdateProgrammeBlock(programmeBlockDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling SectionEventApi->sectionEventUpdateProgrammeBlock: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**programmeBlockDTO** | [**ProgrammeBlockDTO**](ProgrammeBlockDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**ProgrammeBlockDTO**](ProgrammeBlockDTO.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)
|
|
|