manager-app/manager_api_new/doc/SectionApi.md

manager_api_new.api.SectionApi

Load the API package

import 'package:manager_api_new/api.dart';

All URIs are relative to https://api.mymuseum.be

Method	HTTP request	Description
sectionCreate	POST /api/Section
sectionDelete	DELETE /api/Section/{id}
sectionDeleteAllForConfiguration	DELETE /api/Section/configuration/{id}
sectionGet	GET /api/Section
sectionGetAllBeaconsForInstance	GET /api/Section/beacons/{instanceId}
sectionGetAllSectionSubSections	GET /api/Section/{id}/subsections
sectionGetArticleDTO	GET /api/Section/ArticleDTO
sectionGetDetail	GET /api/Section/{id}
sectionGetFromConfiguration	GET /api/Section/configuration/{id}
sectionGetMapDTO	GET /api/Section/MapDTO
sectionGetMenuDTO	GET /api/Section/MenuDTO
sectionGetQuizzDTO	GET /api/Section/QuizzDTO
sectionGetSliderDTO	GET /api/Section/SliderDTO
sectionGetVideoDTO	GET /api/Section/VideoDTO
sectionGetWebDTO	GET /api/Section/WebDTO
sectionPlayerMessageDTO	GET /api/Section/PlayerMessageDTO
sectionUpdate	PUT /api/Section
sectionUpdateOrder	PUT /api/Section/order

sectionCreate

SectionDTO sectionCreate(sectionDTO)

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 = SectionApi();
final sectionDTO = SectionDTO(); // SectionDTO | 

try {
    final result = api_instance.sectionCreate(sectionDTO);
    print(result);
} catch (e) {
    print('Exception when calling SectionApi->sectionCreate: $e\n');
}

Parameters

Name	Type	Description	Notes
sectionDTO	SectionDTO

Return type

SectionDTO

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]

sectionDelete

String sectionDelete(id)

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 = SectionApi();
final id = id_example; // String | 

try {
    final result = api_instance.sectionDelete(id);
    print(result);
} catch (e) {
    print('Exception when calling SectionApi->sectionDelete: $e\n');
}

Parameters

Name	Type	Description	Notes
id	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]

sectionDeleteAllForConfiguration

String sectionDeleteAllForConfiguration(id)

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 = SectionApi();
final id = id_example; // String | 

try {
    final result = api_instance.sectionDeleteAllForConfiguration(id);
    print(result);
} catch (e) {
    print('Exception when calling SectionApi->sectionDeleteAllForConfiguration: $e\n');
}

Parameters

Name	Type	Description	Notes
id	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]

sectionGet

List sectionGet(instanceId)

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 = SectionApi();
final instanceId = instanceId_example; // String | 

try {
    final result = api_instance.sectionGet(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling SectionApi->sectionGet: $e\n');
}

Parameters

Name	Type	Description	Notes
instanceId	String		[optional]

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]

sectionGetAllBeaconsForInstance

List sectionGetAllBeaconsForInstance(instanceId)

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 = SectionApi();
final instanceId = instanceId_example; // String | 

try {
    final result = api_instance.sectionGetAllBeaconsForInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling SectionApi->sectionGetAllBeaconsForInstance: $e\n');
}

Parameters

Name	Type	Description	Notes
instanceId	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]

sectionGetAllSectionSubSections

List