Skip to content

Latest commit

 

History

History
121 lines (84 loc) · 3.22 KB

UserApi.md

File metadata and controls

121 lines (84 loc) · 3.22 KB
Raw

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

User getUserById(userId)

Get an user by id

Returns the user identified by the specified id.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['API-Key'] = "Token"

var apiInstance = new infoplus.UserApi()

var userId = "userId_example"; // {String} Id of user to be returned.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserById(userId, callback);

Parameters

Name Type Description Notes
userId String Id of user to be returned.

Return type

User

Authorization

api_key

HTTP reuqest headers

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

getUserBySearchText

[User] getUserBySearchText(opts)

Search users

Returns the list of users that match the given searchText.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['API-Key'] = "Token"

var apiInstance = new infoplus.UserApi()

var opts = { 
  'searchText': "searchText_example", // {String} Search text, used to filter results.
  'page': 56, // {Integer} Result page number.  Defaults to 1.
  'limit': 56 // {Integer} Maximum results per page.  Defaults to 20.  Max allowed value is 250.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserBySearchText(opts, callback);

Parameters

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

Return type

[User]

Authorization

api_key

HTTP reuqest headers

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