manager-app/manager_api_new/doc/InstanceApi.md

manager_api_new.api.InstanceApi

Load the API package

import 'package:manager_api_new/api.dart';

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

Method	HTTP request	Description
instanceCreateInstance	POST /api/Instance
instanceDeleteInstance	DELETE /api/Instance/{id}
instanceGet	GET /api/Instance
instanceGetAppKeyByPin	GET /api/Instance/app-key
instanceGetDetail	GET /api/Instance/{id}
instanceGetInstanceByPinCode	GET /api/Instance/byPin
instanceUpdateinstance	PUT /api/Instance

instanceCreateInstance

InstanceDTO instanceCreateInstance(instanceDTO)

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 = InstanceApi();
final instanceDTO = InstanceDTO(); // InstanceDTO | 

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

Parameters

Name	Type	Description	Notes
instanceDTO	InstanceDTO

Return type

InstanceDTO

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]

instanceDeleteInstance

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

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

instanceGet

List instanceGet()

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 = InstanceApi();

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

instanceGetAppKeyByPin

Object instanceGetAppKeyByPin(pinCode, appType)

Example

import 'package:manager_api_new/api.dart';
// TODO Configure API key authorization: apikey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apikey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apikey').apiKeyPrefix = 'Bearer';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = InstanceApi();
final pinCode = pinCode_example; // String | 
final appType = appType_example; // String | 

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

Parameters

Name	Type	Description	Notes
pinCode	String		[optional]
appType	String		[optional]

Return type

Object

Authorization

apikey, 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]

instanceGetDetail

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

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

Parameters

Name	Type	Description	Notes
id	String

Return type

InstanceDTO

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]

instanceGetInstanceByPinCode

InstanceDTO instanceGetInstanceByPinCode(pinCode)

Example

import 'package:manager_api_new/api.dart';
// TODO Configure API key authorization: apikey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apikey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apikey').apiKeyPrefix = 'Bearer';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = InstanceApi();
final pinCode = pinCode_example; // String | 

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

Parameters

Name	Type	Description	Notes
pinCode	String		[optional]

Return type

InstanceDTO

Authorization

apikey, 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]

instanceUpdateinstance

InstanceDTO instanceUpdateinstance(instanceDTO)

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 = InstanceApi();
final instanceDTO = InstanceDTO(); // InstanceDTO | 

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

Parameters

Name	Type	Description	Notes
instanceDTO	InstanceDTO

Return type

InstanceDTO

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]