Skip to content

Latest commit

 

History

History
135 lines (85 loc) · 3.93 KB

UserApi.md

File metadata and controls

135 lines (85 loc) · 3.93 KB

\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

Success DeleteUserById(ctx, id) Remove user from station by Id

Remove user from station by Id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 id of User

Return type

Success

Authorization

[API Key](../README.md#API Key)

HTTP request headers

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

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

GetUserById

UserResult GetUserById(ctx, id) Get user by id

Get user by id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int64 id of User

Return type

UserResult

Authorization

[API Key](../README.md#API Key)

HTTP request headers

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

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

InviteUserByMail

InviteUserSuccess InviteUserByMail(ctx, data) Invite user by mail

Invite user by mail

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
data InviteUserData Data (Required)

Return type

InviteUserSuccess

Authorization

[API Key](../README.md#API Key)

HTTP request headers

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

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

ListUsers

UserResults ListUsers(ctx, optional) Get all users.

List all users.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

UserResults

Authorization

[API Key](../README.md#API Key)

HTTP request headers

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

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