UsersApi.md

UsersApi

All URIs are relative to https://de.openlegaldata.io/api

Method	HTTP request	Description
usersList	GET /users/
usersMe	GET /users/me/
usersRead	GET /users/{id}/

usersList

InlineResponse20012 usersList(limit, offset)

API endpoint that allows a user's profile to be viewed or edited.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

UsersApi apiInstance = new UsersApi();
Integer limit = 56; // Integer | Number of results to return per page.
Integer offset = 56; // Integer | The initial index from which to return the results.
try {
    InlineResponse20012 result = apiInstance.usersList(limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#usersList");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer	Number of results to return per page.	[optional]
offset	Integer	The initial index from which to return the results.	[optional]

Return type

InlineResponse20012

Authorization

api_key

HTTP request headers

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

usersMe

InlineResponse20012 usersMe(limit, offset)

Show current user (useful for verifying API key)

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

UsersApi apiInstance = new UsersApi();
Integer limit = 56; // Integer | Number of results to return per page.
Integer offset = 56; // Integer | The initial index from which to return the results.
try {
    InlineResponse20012 result = apiInstance.usersMe(limit, offset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#usersMe");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
limit	Integer	Number of results to return per page.	[optional]
offset	Integer	The initial index from which to return the results.	[optional]

Return type

InlineResponse20012

Authorization

api_key

HTTP request headers

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

usersRead

User usersRead(id)

API endpoint that allows a user's profile to be viewed or edited.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.UsersApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

UsersApi apiInstance = new UsersApi();
Integer id = 56; // Integer | A unique integer value identifying this Benutzer/in.
try {
    User result = apiInstance.usersRead(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#usersRead");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Integer	A unique integer value identifying this Benutzer/in.

Return type

User

Authorization

api_key

HTTP request headers

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