# mycore_api.api.HomeApi

## Load the API package
```dart
import 'package:mycore_api/api.dart';
```

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**homeCreate**](HomeApi.md#homecreate) | **POST** /api/home | Create a home
[**homeDelete**](HomeApi.md#homedelete) | **DELETE** /api/home/{homeId} | Delete a home
[**homeGetAll**](HomeApi.md#homegetall) | **GET** /api/home/{userId} | Get all home for specified user
[**homeGetDetail**](HomeApi.md#homegetdetail) | **GET** /api/home/detail/{homeId} | Get detail info of a specified home
[**homeUpdate**](HomeApi.md#homeupdate) | **PUT** /api/home | Update a home


# **homeCreate**
> HomeDTO homeCreate(createOrUpdateHomeDTO)

Create a home

### Example
```dart
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 = HomeApi();
final createOrUpdateHomeDTO = CreateOrUpdateHomeDTO(); // CreateOrUpdateHomeDTO | Home to create

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createOrUpdateHomeDTO** | [**CreateOrUpdateHomeDTO**](CreateOrUpdateHomeDTO.md)| Home to create | 

### Return type

[**HomeDTO**](HomeDTO.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **homeDelete**
> String homeDelete(homeId)

Delete a home

### Example
```dart
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 = HomeApi();
final homeId = homeId_example; // String | Id of home to delete

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **homeId** | **String**| Id of home to delete | 

### Return type

**String**

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **homeGetAll**
> List<HomeDTO> homeGetAll(userId)

Get all home for specified user

### Example
```dart
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 = HomeApi();
final userId = userId_example; // String | User Id

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**| User Id | 

### Return type

[**List<HomeDTO>**](HomeDTO.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **homeGetDetail**
> HomeDetailDTO homeGetDetail(homeId)

Get detail info of a specified home

### Example
```dart
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 = HomeApi();
final homeId = homeId_example; // String | home id

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **homeId** | **String**| home id | 

### Return type

[**HomeDetailDTO**](HomeDetailDTO.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **homeUpdate**
> HomeDTO homeUpdate(createOrUpdateHomeDTO)

Update a home

### Example
```dart
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 = HomeApi();
final createOrUpdateHomeDTO = CreateOrUpdateHomeDTO(); // CreateOrUpdateHomeDTO | Home to update

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **createOrUpdateHomeDTO** | [**CreateOrUpdateHomeDTO**](CreateOrUpdateHomeDTO.md)| Home to update | 

### Return type

[**HomeDTO**](HomeDTO.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)