Skip to content

Latest commit

 

History

History
124 lines (88 loc) · 4.04 KB

UserApi.md

File metadata and controls

124 lines (88 loc) · 4.04 KB

Infoplus\UserApi

All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api

Method HTTP request Description
getUserById GET /beta/user/{userId} Get an user by id
getUserBySearchText GET /beta/user/search Search users

getUserById

\Infoplus\Infoplus\Model\User getUserById($user_id)

Get an user by id

Returns the user identified by the specified id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\UserApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_id = "user_id_example"; // string | Id of user to be returned.

try {
    $result = $apiInstance->getUserById($user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
user_id string Id of user to be returned.

Return type

\Infoplus\Infoplus\Model\User

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserBySearchText

\Infoplus\Infoplus\Model\User[] getUserBySearchText($search_text, $page, $limit)

Search users

Returns the list of users that match the given searchText.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\UserApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$search_text = "search_text_example"; // string | Search text, used to filter results.
$page = 56; // int | Result page number.  Defaults to 1.
$limit = 56; // int | Maximum results per page.  Defaults to 20.  Max allowed value is 250.

try {
    $result = $apiInstance->getUserBySearchText($search_text, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->getUserBySearchText: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
search_text string Search text, used to filter results. [optional]
page int Result page number. Defaults to 1. [optional]
limit int Maximum results per page. Defaults to 20. Max allowed value is 250. [optional]

Return type

\Infoplus\Infoplus\Model\User[]

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]