Skip to content

Latest commit

 

History

History
224 lines (148 loc) · 5.74 KB

UserApi.md

File metadata and controls

224 lines (148 loc) · 5.74 KB

radiomanager.UserApi

All URIs are relative to https://radiomanager.io/api/v2

Method HTTP request Description
deleteUserById DELETE /users/{id} Remove User from station by Id
getUserById GET /users/{id} Get user by id
inviteUserByMail POST /users/invite Invite user by mail
listUsers GET /users Get all users.

deleteUserById

InlineResponse202 deleteUserById(id)

Remove User from station by Id

Remove User from station by Id, will not actually delete a User record

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let 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 = 'Token';

let apiInstance = new radiomanager.UserApi();
let id = 789; // Number | ID of User **(Required)**
apiInstance.deleteUserById(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number ID of User (Required)

Return type

InlineResponse202

Authorization

API-Key

HTTP request headers

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

getUserById

UserResult getUserById(id)

Get user by id

Get user by id

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let 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 = 'Token';

let apiInstance = new radiomanager.UserApi();
let id = 789; // Number | id of User
apiInstance.getUserById(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number id of User

Return type

UserResult

Authorization

API-Key

HTTP request headers

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

inviteUserByMail

InlineResponse202 inviteUserByMail(inviteUserData)

Invite user by mail

Invite user by mail

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let 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 = 'Token';

let apiInstance = new radiomanager.UserApi();
let inviteUserData = new radiomanager.InviteUserData(); // InviteUserData | Data *(Required)*
apiInstance.inviteUserByMail(inviteUserData).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
inviteUserData InviteUserData Data (Required)

Return type

InlineResponse202

Authorization

API-Key

HTTP request headers

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

listUsers

InlineResponse20013 listUsers(opts)

Get all users.

List all users.

Example

import radiomanager from 'radiomanager';
let defaultClient = radiomanager.ApiClient.instance;
// Configure API key authorization: API-Key
let 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 = 'Token';

let apiInstance = new radiomanager.UserApi();
let opts = {
  'roleId': 789, // Number | Search on Role ID *(Optional)*
  'groupId': 789, // Number | Search on Group ID *(Optional)*
  'page': 1, // Number | Current page *(Optional)*
  'limit': 789, // Number | Results per page *(Optional)*
  'orderBy': "orderBy_example", // String | Field to order the results *(Optional)*
  'orderDirection': "orderDirection_example" // String | Direction of ordering *(Optional)*
};
apiInstance.listUsers(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
roleId Number Search on Role ID (Optional) [optional]
groupId Number Search on Group ID (Optional) [optional]
page Number Current page (Optional) [optional] [default to 1]
limit Number Results per page (Optional) [optional]
orderBy String Field to order the results (Optional) [optional]
orderDirection String Direction of ordering (Optional) [optional]

Return type

InlineResponse20013

Authorization

API-Key

HTTP request headers

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