myhomie_app/mycore_api/doc/ProviderApi.md

mycore_api.api.ProviderApi

Load the API package

import 'package:mycore_api/api.dart';

All URIs are relative to http://192.168.31.140

Method	HTTP request	Description
providerCreate	POST /api/provider	Create a provider
providerDelete	DELETE /api/provider/{providerId}	Delete a provider
providerGetAll	GET /api/provider/{homeId}	Get all home providers
providerUpdate	PUT /api/provider	Update a provider

providerCreate

ProviderDTO providerCreate(providerDTO)

Create a provider

Example

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

final api_instance = ProviderApi();
final providerDTO = ProviderDTO(); // ProviderDTO | Provider to create

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

Parameters

Name	Type	Description	Notes
providerDTO	ProviderDTO	Provider to create

Return type

ProviderDTO

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]

providerDelete

String providerDelete(providerId)

Delete a provider

Example

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

final api_instance = ProviderApi();
final providerId = providerId_example; // String | Id of provider to delete

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

Parameters

Name	Type	Description	Notes
providerId	String	Id of provider to delete

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]

providerGetAll

List providerGetAll(homeId)

Get all home providers

Example

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

final api_instance = ProviderApi();
final homeId = homeId_example; // String | Home Id

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

Parameters

Name	Type	Description	Notes
homeId	String	Home Id

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]

providerUpdate

DeviceDetailDTO providerUpdate(providerDTO)

Update a provider

Example

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

final api_instance = ProviderApi();
final providerDTO = ProviderDTO(); // ProviderDTO | Provider to update

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

Parameters

Name	Type	Description	Notes
providerDTO	ProviderDTO	Provider to update

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]