tablet-app/manager_api/doc/DeviceApi.md

manager_api.api.DeviceApi

Load the API package

import 'package:manager_api/api.dart';

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

Method	HTTP request	Description
deviceCreate	POST /api/Device
deviceDelete	DELETE /api/Device/{id}
deviceGet	GET /api/Device
deviceGetDetail	GET /api/Device/{id}/detail
deviceUpdate	PUT /api/Device
deviceUpdateMainInfos	PUT /api/Device/mainInfos

deviceCreate

DeviceDetailDTO deviceCreate(deviceDetailDTO)

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 = DeviceApi();
final deviceDetailDTO = DeviceDetailDTO(); // DeviceDetailDTO | 

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

Parameters

Name	Type	Description	Notes
deviceDetailDTO	DeviceDetailDTO

Return type

DeviceDetailDTO

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]

deviceDelete

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

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

deviceGet

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

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

deviceGetDetail

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

DeviceDetailDTO

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]

deviceUpdate

DeviceDetailDTO deviceUpdate(deviceDetailDTO)

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 = DeviceApi();
final deviceDetailDTO = DeviceDetailDTO(); // DeviceDetailDTO | 

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

Parameters

Name	Type	Description	Notes
deviceDetailDTO	DeviceDetailDTO

Return type

DeviceDetailDTO

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]

deviceUpdateMainInfos

DeviceDTO deviceUpdateMainInfos(deviceDTO)

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 = DeviceApi();
final deviceDTO = DeviceDTO(); // DeviceDTO | 

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

Parameters

Name	Type	Description	Notes
deviceDTO	DeviceDTO

Return type

DeviceDTO

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]