openapi-generator/samples/client/petstore/android/httpclient/docs/UserApi.md

UserApi

All URIs are relative to http://petstore.swagger.io/v2

Method	HTTP request	Description
createUser	POST /user	Create user
createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
deleteUser	DELETE /user/{username}	Delete user
getUserByName	GET /user/{username}	Get user by user name
loginUser	GET /user/login	Logs user into the system
logoutUser	GET /user/logout	Logs out current logged in user session
updateUser	PUT /user/{username}	Updated user

createUser

createUser(user)

Create user

This can only be done by the logged in user.

Example

// Import classes:
//import org.openapitools.client.api.UserApi;

UserApi apiInstance = new UserApi();
User user = new User(); // User | Created user object
try {
    apiInstance.createUser(user);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#createUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
user	User	Created user object

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

createUsersWithArrayInput

createUsersWithArrayInput(user)

Creates list of users with given input array

Example

// Import classes:
//import org.openapitools.client.api.UserApi;

UserApi apiInstance = new UserApi();
List<User> user = Arrays.asList(new List()); // List<User> | List of user object
try {
    apiInstance.createUsersWithArrayInput(user);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#createUsersWithArrayInput");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
user	List<User>	List of user object

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

createUsersWithListInput

createUsersWithListInput(user)

Creates list of users with given input array

Example

// Import classes:
//import org.openapitools.client.api.UserApi;

UserApi apiInstance = new UserApi();
List<User> user = Arrays.asList(new List()); // List<User> | List of user object
try {
    apiInstance.createUsersWithListInput(user);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#createUsersWithListInput");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
user	List<User>	List of user object

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

deleteUser

deleteUser(username)

Delete user

This can only be done by the logged in user.

Example

// Import classes:
//import org.openapitools.client.api.UserApi;

UserApi apiInstance = new UserApi();
String username = null; // String | The name that needs to be deleted
try {
    apiInstance.deleteUser(username);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#deleteUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The name that needs to be deleted	[default to null]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getUserByName

User getUserByName(username)

Get user by user name

Example

// Import classes:
//import org.openapitools.client.api.UserApi;

UserApi apiInstance = new UserApi();
String username = null; // String | The name that needs to be fetched. Use user1 for testing.
try {
    User result = apiInstance.getUserByName(username);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#getUserByName");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The name that needs to be fetched. Use user1 for testing.	[default to null]

Return type

User

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

loginUser

String loginUser(username, password)

Logs user into the system

Example

// Import classes:
//import org.openapitools.client.api.UserApi;

UserApi apiInstance = new UserApi();
String username = null; // String | The user name for login
String password = null; // String | The password for login in clear text
try {
    String result = apiInstance.loginUser(username, password);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#loginUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	The user name for login	[default to null]
password	String	The password for login in clear text	[default to null]

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

logoutUser

logoutUser()

Logs out current logged in user session

Example

// Import classes:
//import org.openapitools.client.api.UserApi;

UserApi apiInstance = new UserApi();
try {
    apiInstance.logoutUser();
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#logoutUser");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

updateUser

updateUser(username, user)

Updated user

This can only be done by the logged in user.

Example

// Import classes:
//import org.openapitools.client.api.UserApi;

UserApi apiInstance = new UserApi();
String username = null; // String | name that need to be deleted
User user = new User(); // User | Updated user object
try {
    apiInstance.updateUser(username, user);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#updateUser");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
username	String	name that need to be deleted	[default to null]
user	User	Updated user object

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined