mymuseum-visitapp/manager_api/doc/UserApi.md

manager_api.api.UserApi

Load the API package

import 'package:manager_api/api.dart';

All URIs are relative to https://api.mymuseum.be

Method	HTTP request	Description
userCreateUser	POST /api/User
userDeleteUser	DELETE /api/User/{id}
userGet	GET /api/User
userGetDetail	GET /api/User/{id}
userUpdateUser	PUT /api/User

userCreateUser

UserDetailDTO userCreateUser(user)

Example

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

final api_instance = UserApi();
final user = User(); // User | 

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

Parameters

Name	Type	Description	Notes
user	User

Return type

UserDetailDTO

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]

userDeleteUser

String userDeleteUser(id)

Example

import 'package:manager_api/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

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]

userGet

List userGet()

Example

import 'package:manager_api/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

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]

userGetDetail

UserDetailDTO userGetDetail(id)

Example

import 'package:manager_api/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.userGetDetail(id);
    print(result);
} catch (e) {
    print('Exception when calling UserApi->userGetDetail: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String

Return type

UserDetailDTO

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]

userUpdateUser

UserDetailDTO userUpdateUser(user)

Example

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

final api_instance = UserApi();
final user = User(); // User | 

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

Parameters

Name	Type	Description	Notes
user	User

Return type

UserDetailDTO

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]