tablet-app/manager_api/doc/ConfigurationApi.md

manager_api.api.ConfigurationApi

Load the API package

import 'package:manager_api/api.dart';

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

Method	HTTP request	Description
configurationCreate	POST /api/Configuration
configurationDelete	DELETE /api/Configuration/{id}
configurationExport	GET /api/Configuration/{id}/export
configurationGet	GET /api/Configuration
configurationGetConfigurationsByPinCode	GET /api/Configuration/byPin
configurationGetDetail	GET /api/Configuration/{id}
configurationImport	POST /api/Configuration/import
configurationUpdate	PUT /api/Configuration

configurationCreate

ConfigurationDTO configurationCreate(configurationDTO)

Example

import 'package:manager_api/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ConfigurationApi();
final configurationDTO = ConfigurationDTO(); // ConfigurationDTO | 

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

Parameters

Name	Type	Description	Notes
configurationDTO	ConfigurationDTO

Return type

ConfigurationDTO

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]

configurationDelete

String configurationDelete(id)

Example

import 'package:manager_api/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ConfigurationApi();
final id = id_example; // String | 

try {
    final result = api_instance.configurationDelete(id);
    print(result);
} catch (e) {
    print('Exception when calling ConfigurationApi->configurationDelete: $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]

configurationExport

MultipartFile configurationExport(id, language)

Example

import 'package:manager_api/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ConfigurationApi();
final id = id_example; // String | 
final language = language_example; // String | 

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

Parameters

Name	Type	Description	Notes
id	String
language	String		[optional]

Return type

MultipartFile

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/octet-stream, application/json

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

configurationGet

List configurationGet(instanceId)

Example

import 'package:manager_api/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ConfigurationApi();
final instanceId = instanceId_example; // String | 

try {
    final result = api_instance.configurationGet(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling ConfigurationApi->configurationGet: $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]

configurationGetConfigurationsByPinCode

List configurationGetConfigurationsByPinCode(pinCode)

Example

import 'package:manager_api/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ConfigurationApi();
final pinCode = 56; // int | 

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

Parameters

Name	Type	Description	Notes
pinCode	int		[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]

configurationGetDetail

ConfigurationDTO configurationGetDetail(id)

Example

import 'package:manager_api/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ConfigurationApi();
final id = id_example; // String | 

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

Parameters

Name	Type	Description	Notes
id	String

Return type

ConfigurationDTO

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]

configurationImport

String configurationImport(exportConfigurationDTO)

Example

import 'package:manager_api/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ConfigurationApi();
final exportConfigurationDTO = ExportConfigurationDTO(); // ExportConfigurationDTO | 

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

Parameters

Name	Type	Description	Notes
exportConfigurationDTO	ExportConfigurationDTO

Return type

String

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]

configurationUpdate

ConfigurationDTO configurationUpdate(configurationDTO)

Example

import 'package:manager_api/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ConfigurationApi();
final configurationDTO = ConfigurationDTO(); // ConfigurationDTO | 

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

Parameters

Name	Type	Description	Notes
configurationDTO	ConfigurationDTO

Return type

ConfigurationDTO

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]