mycorerepository/Test service generation - dart/doc/ScreenDeviceApi.md

mycoreapi.api.ScreenDeviceApi

Load the API package

import 'package:mycoreapi/api.dart';

All URIs are relative to http://192.168.31.140

Method	HTTP request	Description
screenDeviceCreateDevice	POST /api/device/screen
screenDeviceDeleteDevice	DELETE /api/device/screen/{deviceId}
screenDeviceGetAllScreenDevices	GET /api/device/screen
screenDeviceGetDeviceInfo	GET /api/device/screen/{screenDeviceId}
screenDeviceUpdateDevice	PUT /api/device/screen/{screenDeviceId}

screenDeviceCreateDevice

MultipartFile screenDeviceCreateDevice(screenDevice)

Example

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

final api_instance = ScreenDeviceApi();
final screenDevice = ScreenDevice(); // ScreenDevice | 

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

Parameters

Name	Type	Description	Notes
screenDevice	ScreenDevice

Return type

MultipartFile

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/octet-stream

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

screenDeviceDeleteDevice

MultipartFile screenDeviceDeleteDevice(deviceId)

Example

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

final api_instance = ScreenDeviceApi();
final deviceId = deviceId_example; // String | 

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

Parameters

Name	Type	Description	Notes
deviceId	String

Return type

MultipartFile

Authorization

bearer

HTTP request headers

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

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

screenDeviceGetAllScreenDevices

List screenDeviceGetAllScreenDevices()

Example

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

final api_instance = ScreenDeviceApi();

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

Parameters

This endpoint does not need any parameter.

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]

screenDeviceGetDeviceInfo

ScreenDevice screenDeviceGetDeviceInfo(screenDeviceId)

Example

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

final api_instance = ScreenDeviceApi();
final screenDeviceId = screenDeviceId_example; // String | Id of the screen device you want to get information

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

Parameters

Name	Type	Description	Notes
screenDeviceId	String	Id of the screen device you want to get information

Return type

ScreenDevice

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]

screenDeviceUpdateDevice

MultipartFile screenDeviceUpdateDevice(screenDeviceId, screenDevice)

Example

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

final api_instance = ScreenDeviceApi();
final screenDeviceId = 56; // int | 
final screenDevice = ScreenDevice(); // ScreenDevice | 

try { 
    final result = api_instance.screenDeviceUpdateDevice(screenDeviceId, screenDevice);
    print(result);
} catch (e) {
    print('Exception when calling ScreenDeviceApi->screenDeviceUpdateDevice: $e\n');
}

Parameters

Name	Type	Description	Notes
screenDeviceId	int
screenDevice	ScreenDevice

Return type

MultipartFile

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/octet-stream

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