manager-app/manager_api_new/doc/SectionEventApi.md

manager_api_new.api.SectionEventApi

Load the API package

import 'package:manager_api_new/api.dart';

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

Method	HTTP request	Description
sectionEventCreateMapAnnotation	POST /api/SectionEvent/{programmeBlockId}/map-annotations
sectionEventCreateProgrammeBlock	POST /api/SectionEvent/{sectionEventId}/programmes
sectionEventDeleteMapAnnotation	DELETE /api/SectionEvent/map-annotations/{mapAnnotationId}
sectionEventDeleteProgrammeBlock	DELETE /api/SectionEvent/programmes/{programBlockId}
sectionEventGetAllMapAnnotationsFromProgrammeBlock	GET /api/SectionEvent/{programBlockId}/map-annotations
sectionEventGetAllProgrammeBlockFromSection	GET /api/SectionEvent/{sectionEventId}/programmes
sectionEventUpdateMapAnnotation	PUT /api/SectionEvent/map-annotations
sectionEventUpdateProgrammeBlock	PUT /api/SectionEvent/programmes

sectionEventCreateMapAnnotation

MapAnnotationDTO sectionEventCreateMapAnnotation(programmeBlockId, mapAnnotationDTO)

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 = 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

Return type

MapAnnotationDTO

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]

sectionEventCreateProgrammeBlock

ProgrammeBlockDTO sectionEventCreateProgrammeBlock(sectionEventId, programmeBlockDTO)

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 = 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

Return type

ProgrammeBlockDTO

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]

sectionEventDeleteMapAnnotation

String sectionEventDeleteMapAnnotation(mapAnnotationId)

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 = 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

HTTP request headers

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

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

sectionEventDeleteProgrammeBlock

String sectionEventDeleteProgrammeBlock(programBlockId)

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 = 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

HTTP request headers

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

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

sectionEventGetAllMapAnnotationsFromProgrammeBlock

List sectionEventGetAllMapAnnotationsFromProgrammeBlock(programBlockId)

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 = 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

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]

sectionEventGetAllProgrammeBlockFromSection

List sectionEventGetAllProgrammeBlockFromSection(sectionEventId)

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 = 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

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]

sectionEventUpdateMapAnnotation

MapAnnotationDTO sectionEventUpdateMapAnnotation(mapAnnotationDTO)

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 = 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

Return type

MapAnnotationDTO

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]

sectionEventUpdateProgrammeBlock

ProgrammeBlockDTO sectionEventUpdateProgrammeBlock(programmeBlockDTO)

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 = 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

Return type

ProgrammeBlockDTO

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]