230 lines
5.6 KiB
Markdown

# mycoreapi.api.UserApi
## Load the API package
```dart
import 'package:mycoreapi/api.dart';
```
All URIs are relative to *http://192.168.31.140*
Method | HTTP request | Description
------------- | ------------- | -------------
[**userCreateUser**](UserApi.md#usercreateuser) | **POST** /api/user |
[**userDeleteUser**](UserApi.md#userdeleteuser) | **DELETE** /api/user/{id} |
[**userGet**](UserApi.md#userget) | **GET** /api/user | Get a list of user
[**userGet2**](UserApi.md#userget2) | **GET** /api/user/{id} | Get a specific user
[**userUpdateUser**](UserApi.md#userupdateuser) | **PUT** /api/user |
# **userCreateUser**
> UserInfoDetailDTO userCreateUser(userInfo)
### Example
```dart
import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
final api_instance = UserApi();
final userInfo = UserInfo(); // UserInfo |
try {
final result = api_instance.userCreateUser(userInfo);
print(result);
} catch (e) {
print('Exception when calling UserApi->userCreateUser: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userInfo** | [**UserInfo**](UserInfo.md)| |
### Return type
[**UserInfoDetailDTO**](UserInfoDetailDTO.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)
# **userDeleteUser**
> MultipartFile userDeleteUser(id)
### Example
```dart
import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
final api_instance = UserApi();
final id = id_example; // String |
try {
final result = api_instance.userDeleteUser(id);
print(result);
} catch (e) {
print('Exception when calling UserApi->userDeleteUser: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| |
### Return type
[**MultipartFile**](MultipartFile.md)
### Authorization
[bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/octet-stream
[[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)
# **userGet**
> MultipartFile userGet()
Get a list of user
### Example
```dart
import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
final api_instance = UserApi();
try {
final result = api_instance.userGet();
print(result);
} catch (e) {
print('Exception when calling UserApi->userGet: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**MultipartFile**](MultipartFile.md)
### Authorization
[bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/octet-stream
[[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)
# **userGet2**
> UserInfoDetailDTO userGet2(id)
Get a specific user
### Example
```dart
import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
final api_instance = UserApi();
final id = id_example; // String | id user
try {
final result = api_instance.userGet2(id);
print(result);
} catch (e) {
print('Exception when calling UserApi->userGet2: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| id user |
### Return type
[**UserInfoDetailDTO**](UserInfoDetailDTO.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)
# **userUpdateUser**
> UserInfoDetailDTO userUpdateUser(userInfo)
### Example
```dart
import 'package:mycoreapi/api.dart';
// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
final api_instance = UserApi();
final userInfo = UserInfo(); // UserInfo |
try {
final result = api_instance.userUpdateUser(userInfo);
print(result);
} catch (e) {
print('Exception when calling UserApi->userUpdateUser: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userInfo** | [**UserInfo**](UserInfo.md)| |
### Return type
[**UserInfoDetailDTO**](UserInfoDetailDTO.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)