Automatically generated by fhq-server.
- Version: v0.2.54
- Date: 2025-08-21 14:05:35
Example connect/disconnect:
from freehackquest_libclient_py import FreeHackQuestClient
cli = FreeHackQuestClient('ws://localhost:1234')
...
cli.close()
addhint - Method add hint to quest
Method add hint to quest
Access: unauthorized - no, user - no, admin - yes
- questid - integer, required; quest id
- hint - string, required; hint text
response = cli.addhint({
"questid": 0,
"hint": ""
})
answerlist - Return user answers list
Return user answers list
Access: unauthorized - no, user - no, admin - yes
- page - integer, required; Number of page
- onpage - integer, required; How much rows on page
- questid - integer, optional; Filter for questid
- userid - integer, optional; Filter for userid
response = cli.answerlist({
"page": 0,
"onpage": 10,
"questid": 0,
"userid": 0
})
chat_latest_messages - Method will be send chat message and it sent to another users
Method will be send chat message and it sent to another users
Access: unauthorized - yes, user - yes, admin - yes
response = cli.chat_latest_messages({
})
chat_send_message - Method will be send chat message and it sent to another users
Method will be send chat message and it sent to another users
Access: unauthorized - no, user - yes, admin - yes
- type - string, required; Type
- message - string, required; Message
response = cli.chat_send_message({
"type": "",
"message": ""
})
chats_add_to_black_list - Add user to black list
Add user to black list
Access: unauthorized - no, user - yes, admin - yes
response = cli.chats_add_to_black_list({
})
chats_add_to_chat - Add user to some chat
Add user to some chat
Access: unauthorized - no, user - yes, admin - yes
response = cli.chats_add_to_chat({
})
chats_change_owner - Change owner of the chat
Change owner of the chat
Access: unauthorized - no, user - yes, admin - yes
response = cli.chats_change_owner({
})
chats_create_group_chat - Create group chat
Create group chat
Access: unauthorized - no, user - yes, admin - yes
response = cli.chats_create_group_chat({
})
chats_delete_from_black_list - Delete user from black list
Delete user from black list
Access: unauthorized - no, user - yes, admin - yes
response = cli.chats_delete_from_black_list({
})
chats_delete_from_chat - Delete user from chat
Delete user from chat
Access: unauthorized - no, user - yes, admin - yes
response = cli.chats_delete_from_chat({
})
chats_dialogs_list - Show list of dialogs
Show list of dialogs
Access: unauthorized - no, user - yes, admin - yes
response = cli.chats_dialogs_list({
})
chats_message_delete - Delete message from chat
Delete message from chat
Access: unauthorized - no, user - yes, admin - yes
- message_id - integer, required; Message id for remove
response = cli.chats_message_delete({
"message_id": 0
})
chats_message_edit - Edit message
Edit message
Access: unauthorized - no, user - yes, admin - yes
- message_id - integer, required; Message id
- message_new - string, required; New message
response = cli.chats_message_edit({
"message_id": 0,
"message_new": ""
})
chats_message_read - Get all messages in chat
Get all messages in chat
Access: unauthorized - no, user - yes, admin - yes
- chat - string, required; Chat for reading messages
response = cli.chats_message_read({
"chat": ""
})
chats_message_send - Method will be send chat message and it sent to another users
Method will be send chat message and it sent to another users
Access: unauthorized - no, user - yes, admin - yes
- chat - string, required; Chat for sending a message
- message - string, required; Message
response = cli.chats_message_send({
"chat": "",
"message": ""
})
classbook_add_record - Adds a new article with the specified name, content, and id.
Adds a new article with the specified name, content, and id.
Access: unauthorized - no, user - no, admin - yes
- parentid - integer, required; pareintid for classbook article
- name - string, required; name of article
- content - string, required; content of article
- uuid - string, optional; uuid of article
- ordered - integer, optional; order of article
response = cli.classbook_add_record({
"parentid": 0,
"name": "",
"content": "",
"uuid": "",
"ordered": 0
})
classbook_delete_record - Delete a article with a given classbookid
Delete a article with a given classbookid
Access: unauthorized - no, user - no, admin - yes
- classbookid - integer, required; id for classbook article
response = cli.classbook_delete_record({
"classbookid": 0
})
classbook_export - Export classbook's articles to html or markdown, optionally in zip archive.
Export classbook's articles to html or markdown, optionally in zip archive.
Access: unauthorized - no, user - yes, admin - yes
- output - string, required; The output file format
- lang - string, required; The output file format
- zip - boolean, optional; Zipping the output
response = cli.classbook_export({
"output": "",
"lang": "",
"zip": ""
})
classbook_info - Return name and content, langs, path classbook article with a given id
Return name and content, langs, path classbook article with a given id
Access: unauthorized - yes, user - yes, admin - yes
- classbookid - integer, required; id for the classbook article
- lang - string, optional; Set lang for the article
response = cli.classbook_info({
"classbookid": 0,
"lang": ""
})
classbook_list - Return list of classbook articles
Return list of classbook articles
Access: unauthorized - yes, user - yes, admin - yes
- parentid - integer, required; parentid for classbook articles
- lang - string, optional; lang for classbook articles
- search - string, optional; Search string for classbook articles
response = cli.classbook_list({
"parentid": 0,
"lang": "",
"search": ""
})
classbook_localization_add_record - Add a new article localization for the English version
Add a new article localization for the English version
Access: unauthorized - no, user - no, admin - yes
- classbookid - integer, required; Classbookid for article localization
- lang - string, required; Language
- name - string, required; Article name
- content - string, required; The content of the article
response = cli.classbook_localization_add_record({
"classbookid": 0,
"lang": "",
"name": "",
"content": ""
})
classbook_localization_delete_record - Delete an article localization
Delete an article localization
Access: unauthorized - no, user - no, admin - yes
- classbook_localizationid - integer, required; Localization id
response = cli.classbook_localization_delete_record({
"classbook_localizationid": 0
})
classbook_localization_info - Find and display localization for an article by classbookid
Find and display localization for an article by classbookid
Access: unauthorized - no, user - no, admin - yes
- classbook_localizationid - integer, required; Localization id
response = cli.classbook_localization_info({
"classbook_localizationid": 0
})
classbook_localization_update_record - Update table with localization by classbookid
Update table with localization by classbookid
Access: unauthorized - no, user - no, admin - yes
- classbook_localizationid - integer, required; Localization id
- name - string, required; Article name
- content - string, required; The content of the article
response = cli.classbook_localization_update_record({
"classbook_localizationid": 0,
"name": "",
"content": ""
})
classbook_propasal_approve - Approve updating requests
Approve updating requests
Access: unauthorized - no, user - no, admin - yes
- classbook_proposal_id - integer, required; Proposal id
response = cli.classbook_propasal_approve({
"classbook_proposal_id": 0
})
classbook_propasal_prepare_merge_record - Prepare to merge updating requests
Prepare to merge updating requests
Access: unauthorized - no, user - no, admin - yes
- classbook_proposal_id - integer, required; Proposal id
response = cli.classbook_propasal_prepare_merge_record({
"classbook_proposal_id": 0
})
classbook_propasal_update - Approve updating requests
Approve updating requests
Access: unauthorized - no, user - no, admin - yes
- classbook_proposal_id - integer, required; Proposal id
- content - string, required; new content
response = cli.classbook_propasal_update({
"classbook_proposal_id": 0,
"content": ""
})
classbook_proposal_add_record - Propose an update of article
Propose an update of article
Access: unauthorized - no, user - yes, admin - yes
- classbookid - integer, required; Classbookid for an article
- lang - string, required; Language
- name - string, required; Article name
- content - string, required; The content of the article
response = cli.classbook_proposal_add_record({
"classbookid": 0,
"lang": "",
"name": "",
"content": ""
})
classbook_proposal_delete_record - Delete a proposal of updating an article
Delete a proposal of updating an article
Access: unauthorized - no, user - yes, admin - yes
- classbook_proposal_id - integer, required; Proposal id
response = cli.classbook_proposal_delete_record({
"classbook_proposal_id": 0
})
classbook_proposal_info - Find and display all proposal data by id
Find and display all proposal data by id
Access: unauthorized - no, user - yes, admin - yes
- classbook_proposal_id - integer, required; Proposal id
response = cli.classbook_proposal_info({
"classbook_proposal_id": 0
})
classbook_proposal_list - Display list of proposals by classbookid
Display list of proposals by classbookid
Access: unauthorized - no, user - yes, admin - yes
- classbookid - integer, required; Classbookid for an article
- lang - string, optional; Language
response = cli.classbook_proposal_list({
"classbookid": 0,
"lang": ""
})
classbook_update_record - Update a article with a given classbookid
Update a article with a given classbookid
Access: unauthorized - no, user - no, admin - yes
- classbookid - integer, required; id for classbook article
- name - string, optional; name for classbook article
- content - string, optional; content for classbook article
- ordered - integer, optional; ordered for classbook article
- parentid - integer, optional; parentid for classbook article
response = cli.classbook_update_record({
"classbookid": 0,
"name": "",
"content": "",
"ordered": 0,
"parentid": 0
})
createpublicevent - Create the public event
Create the public event
Access: unauthorized - no, user - no, admin - yes
- type - string, required; Type of event
- message - string, required; Message
response = cli.createpublicevent({
"type": "",
"message": ""
})
deletehint - Method for delete hint from quest
Method for delete hint from quest
Access: unauthorized - no, user - no, admin - yes
- hintid - integer, required; hint id
response = cli.deletehint({
"hintid": 0
})
deletepublicevent - Delete public event
Delete public event
Access: unauthorized - no, user - no, admin - yes
- eventid - integer, required; Event ID
response = cli.deletepublicevent({
"eventid": 0
})
feedback_add - Create the feedback
Create the feedback
Access: unauthorized - yes, user - yes, admin - yes
- from - string, required; From user
- text - string, required; Text of feedback
- type - string, required; Type of feedback
response = cli.feedback_add({
"from": "",
"text": "",
"type": ""
})
game_create - Create the game
Create the game
Access: unauthorized - no, user - no, admin - yes
- freehackquest_game_format_version - integer, required; Format Version
- uuid - string, required; Global Identificator of the Game
- name - string, required; Name of the Game
- description - string, required; Description of the Game
- state - string, required; State of the game
- form - string, required; Form of the game
- type - string, required; Type of the game
- date_start - string, required; Date start
- date_stop - string, required; Date stop
- date_restart - string, required; Date restart
- organizators - string, required; Organizators
response = cli.game_create({
"freehackquest_game_format_version": 0,
"uuid": "",
"name": "",
"description": "",
"state": "",
"form": "",
"type": "",
"date_start": "",
"date_stop": "",
"date_restart": "",
"organizators": ""
})
game_delete - Remove game and all quests
Remove game and all quests
Access: unauthorized - no, user - no, admin - yes
- uuid - string, required; Global Identificator of the Game
- admin_password - string, required; Admin Password
response = cli.game_delete({
"uuid": "",
"admin_password": ""
})
game_export - Export the game
Export the game
Access: unauthorized - no, user - no, admin - yes
- uuid - string, required; Global Identificator of the Game
response = cli.game_export({
"uuid": ""
})
game_import - Import game
Import game
Access: unauthorized - no, user - no, admin - yes
- uuid - string, required; Global Identificator of the Game
response = cli.game_import({
"uuid": ""
})
game_info - Return game info
Return game info
Access: unauthorized - yes, user - yes, admin - yes
- uuid - string, required; Global Identificator of the Game
response = cli.game_info({
"uuid": ""
})
game_update - Update game info
Update game info
Access: unauthorized - no, user - no, admin - yes
- uuid - string, required; Global Identificator of the Game
- name - string, optional; Name of the Game
- description - string, optional; Description of the Game
- state - string, optional; State of the game
- form - string, optional; Form of the game
- type - string, optional; Type of the game
- date_start - string, optional; Date start
- date_stop - string, optional; Date stop
- date_restart - string, optional; Date restart
- organizators - string, optional; Organizators
response = cli.game_update({
"uuid": "",
"name": "",
"description": "",
"state": "",
"form": "",
"type": "",
"date_start": "",
"date_stop": "",
"date_restart": "",
"organizators": ""
})
game_update_logo - Update game logo
Update game logo
Access: unauthorized - no, user - no, admin - yes
- uuid - string, required; Global Identificator of the Game
- image_png_base64 - string, required; Image PNG in Base64
response = cli.game_update_logo({
"uuid": "",
"image_png_base64": ""
})
games.info - Return info about game by uuid
Return info about game by uuid
Access: unauthorized - yes, user - yes, admin - yes
- uuid - string, required; Global Identificator of the Game
response = cli.games.info({
"uuid": ""
})
games_list - Method returned list of games
Method returned list of games
Access: unauthorized - yes, user - yes, admin - yes
response = cli.games_list({
})
getmap - Returned coordinate list
Returned coordinate list
Access: unauthorized - yes, user - yes, admin - yes
response = cli.getmap({
})
getpublicevent - Return public event info by id
Return public event info by id
Access: unauthorized - yes, user - yes, admin - yes
- eventid - integer, required; Event id
response = cli.getpublicevent({
"eventid": 0
})
hints - Return list of hints
Return list of hints
Access: unauthorized - yes, user - yes, admin - yes
- questid - integer, required; Quest id
response = cli.hints({
"questid": 0
})
leaks.add - Method adds a leak
Method adds a leak
Access: unauthorized - no, user - no, admin - yes
- uuid - string, required; UUID of the leak
- game_uuid - string, required; UUID of the game
- name - string, required; Visible part of the content
- content - string, required; Content of the leak
- score - integer, required; Price of the leak
response = cli.leaks.add({
"uuid": "",
"game_uuid": "",
"name": "",
"content": "",
"score": 0
})
leaks.buy - Method buys a leak
Method buys a leak
Access: unauthorized - no, user - yes, admin - no
- id - integer, required; Leak id
response = cli.leaks.buy({
"id": 0
})
leaks.delete - Method deletes a leak
Method deletes a leak
Access: unauthorized - no, user - no, admin - yes
- id - integer, required; Leak id
response = cli.leaks.delete({
"id": 0
})
leaks.list - Method returns list of leaks
Method returns list of leaks
Access: unauthorized - yes, user - yes, admin - yes
- page - integer, required; Number of page
- onpage - integer, required; How much rows in one page
response = cli.leaks.list({
"page": 0,
"onpage": 10
})
leaks.update - Method updates a leak
Method updates a leak
Access: unauthorized - no, user - no, admin - yes
- id - integer, required; Leak id
- name - string, optional; Visible part of the content
- content - string, optional; Content of the leak
- score - integer, optional; Price of the leak
response = cli.leaks.update({
"id": 0,
"name": "",
"content": "",
"score": 0
})
login - Method for login
Method for login
Access: unauthorized - yes, user - no, admin - no
- email - string, required; E-mail
- password - string, required; Password
response = cli.login({
"email": "",
"password": ""
})
lxd_containers - Any actions with the container. Actions: create, start, stop and delete container
Any actions with the container. Actions: create, start, stop and delete container
Access: unauthorized - no, user - no, admin - yes
- name - string, required; Container name
- action - string, required; Actions: create, start, stop and delete container
response = cli.lxd_containers({
"name": "",
"action": ""
})
lxd_exec - Exec command in the container with name.
Exec command in the container with name.
Access: unauthorized - no, user - no, admin - yes
- name - string, required; Container name
- command - string, required; Name of execution command
response = cli.lxd_exec({
"name": "",
"command": ""
})
lxd_file - Pull, push, delete file inside the container.
Pull, push, delete file inside the container.
Access: unauthorized - no, user - no, admin - yes
- name - string, required; Container name
- action - string, required; Action with files: pull, push or delete
- path - string, required; Path to file inside the container
response = cli.lxd_file({
"name": "",
"action": "",
"path": ""
})
lxd_import_container - Import container from json configuration.
Import container from json configuration.
Access: unauthorized - no, user - no, admin - yes
- config - string, required; Container's configuration in json dumped string.
response = cli.lxd_import_container({
"config": ""
})
lxd_import_service_from_zip - Import Service from zip.
Import Service from zip.
Access: unauthorized - no, user - no, admin - yes
- zip_file - string, required; Service's configuration in Base64 zip archive.
response = cli.lxd_import_service_from_zip({
"zip_file": ""
})
lxd_info - Get information about the orhestra, containers.
Get information about the orhestra, containers.
Access: unauthorized - no, user - no, admin - yes
- name - string, required; Container name
- get - string, optional; Requested information
response = cli.lxd_info({
"name": "",
"get": ""
})
lxd_list - Get information about all containers.
Get information about all containers.
Access: unauthorized - no, user - no, admin - yes
response = cli.lxd_list({
})
lxd_open_port - Opens the container port.
Opens the container port.
Access: unauthorized - no, user - no, admin - yes
- name - string, required; Container name
- port - integer, required; Number container port
- protocol - string, required; Protocol
response = cli.lxd_open_port({
"name": "",
"port": 0,
"protocol": ""
})
lxd_start_service - Start service.
Start service.
Access: unauthorized - no, user - no, admin - yes
- name - string, required; Service's name.
response = cli.lxd_start_service({
"name": ""
})
mail_info - This method Will be return info of mail
This method Will be return info of mail
Access: unauthorized - no, user - no, admin - yes
response = cli.mail_info({
})
mail_send - Mail Send
Mail Send
Access: unauthorized - no, user - no, admin - yes
- to - string, required; E-mail of the recipient
- subject - string, required; Subject of the message
- body - string, required; Body of the message
response = cli.mail_send({
"to": "",
"subject": "",
"body": ""
})
mails_list - Mails list
Mails list
Access: unauthorized - no, user - no, admin - yes
- filter_email - string, optional; Filter by email
- filter_subject - string, optional; Filter by subject
- filter_message - string, optional; Filter by message
- onpage - integer, optional; On page
- page - integer, optional; page
response = cli.mails_list({
"filter_email": "",
"filter_subject": "",
"filter_message": "",
"onpage": 10,
"page": 0
})
public_info - Method return public information about server
Method return public information about server
Access: unauthorized - yes, user - yes, admin - yes
response = cli.public_info({
})
publiceventslist - Return list of public events
Return list of public events
Access: unauthorized - yes, user - yes, admin - yes
- page - integer, required; Number of page
- onpage - integer, required; How much rows in one page
- type - string, optional; Filter by type events
- search - string, optional; Filter by message event
response = cli.publiceventslist({
"page": 0,
"onpage": 10,
"type": "",
"search": ""
})
quest - Update the quest info
Update the quest info
Access: unauthorized - yes, user - yes, admin - yes
- questid - integer, required; Quest ID
response = cli.quest({
"questid": 0
})
quest_delete - Method for delete quest
Method for delete quest
Access: unauthorized - no, user - no, admin - yes
- questid - integer, required; Quest ID
response = cli.quest_delete({
"questid": 0
})
quest_pass - Quest pass
Quest pass
Access: unauthorized - no, user - yes, admin - yes
- questid - integer, required; Quest ID
- answer - string, required; Answer
response = cli.quest_pass({
"questid": 0,
"answer": ""
})
quest_proposal - Add quest proposal
Add quest proposal
Access: unauthorized - no, user - yes, admin - yes
- gameid - integer, required; Which game included this quest
- name - string, required; Name of the quest
- text - string, required; Description of the quest
- score - integer, required; How much append to user score after solve quest by them
- author - string, required; Author of the quest
- subject - string, required; Subject must be one from types (look types)
- answer - string, required; Answer for the quest
- answer_format - string, required; Answer format for the quest
response = cli.quest_proposal({
"gameid": 0,
"name": "",
"text": "",
"score": 0,
"author": "",
"subject": "",
"answer": "",
"answer_format": ""
})
quest_statistics - Mehtod will be return quest public statistics
Mehtod will be return quest public statistics
Access: unauthorized - yes, user - yes, admin - yes
- questid - integer, required; Quest ID
response = cli.quest_statistics({
"questid": 0
})
quest_update - Update the quest info
Update the quest info
Access: unauthorized - no, user - no, admin - yes
- questid - integer, required; Quest ID
- name - string, optional; Name of the quest
- gameid - integer, optional; Which game included this quest
- text - string, optional; Description of the quest
- score - integer, optional; How much append to user score after solve quest by them
- subject - string, optional; Subject must be one from types
- author - string, optional; Author of the quest
- answer - string, optional; Answer for the quest
- answer_format - string, optional; Answer format for the quest
- state - string, optional; State of the quest
- description_state - string, optional; You can update some descriptions for quest state
- copyright - string, optional; You can update copyright
response = cli.quest_update({
"questid": 0,
"name": "",
"gameid": 0,
"text": "",
"score": 0,
"subject": "",
"author": "",
"answer": "",
"answer_format": "",
"state": "",
"description_state": "",
"copyright": ""
})
quests - Method will be returned quest list
Method will be returned quest list
Access: unauthorized - yes, user - yes, admin - yes
- subject - string, optional; Filter by subject
- gameid - integer, optional; Filter by local gameid
- filter - string, optional; Filter by some text
response = cli.quests({
"subject": "",
"gameid": 0,
"filter": ""
})
quests.add - Method will be create new quest
Method will be create new quest
Access: unauthorized - no, user - no, admin - yes
- uuid - string, required; Global Identificator of the quest
- gameid - integer, required; Which game included this quest
- name - string, required; Name of the quest
- text - string, required; Description of the quest
- score - integer, required; How much append to user score after solve quest by them
- author - string, required; Author of the quest
- subject - string, required; Subject must be one from types
- answer - string, required; Answer for the quest
- answer_format - string, required; Answer format for the quest
- state - string, required; State of the quest
- description_state - string, required; You can add some descriptions for quest state
- copyright - string, optional; You can add some copyright information
response = cli.quests.add({
"uuid": "",
"gameid": 0,
"name": "",
"text": "",
"score": 0,
"author": "",
"subject": "",
"answer": "",
"answer_format": "",
"state": "",
"description_state": "",
"copyright": ""
})
quests_files.delete - Delete file from quest
Delete file from quest
Access: unauthorized - no, user - no, admin - yes
- quest_uuid - string, required; Quest UUID
- file_id - integer, required; File ID
response = cli.quests_files.delete({
"quest_uuid": "",
"file_id": 0
})
quests_files.upload - Update the quest
Update the quest
Access: unauthorized - no, user - no, admin - yes
- quest_uuid - string, required; Quest UUID
- file_base64 - string, required; Byte-array encoded in base64
- file_name - string, required; File name
response = cli.quests_files.upload({
"quest_uuid": "",
"file_base64": "",
"file_name": ""
})
quests_proposal_list - Quests proposal list
Quests proposal list
Access: unauthorized - no, user - no, admin - yes
- page_size - integer, optional; Pgae size
- page_index - integer, optional; Page index
response = cli.quests_proposal_list({
"page_size": 0,
"page_index": 0
})
quests_subjects - Method returned list of quests by subjects
Method returned list of quests by subjects
Access: unauthorized - yes, user - yes, admin - yes
response = cli.quests_subjects({
})
quests_user_answer_list - Return user answers list
Return user answers list
Access: unauthorized - no, user - yes, admin - yes
- questid - integer, required; Filter for questid
response = cli.quests_user_answer_list({
"questid": 0
})
quests_writeups_delete - This method will be remove writeup
This method will be remove writeup
Access: unauthorized - no, user - no, admin - yes
- writeupid - integer, required; WriteUp ID
response = cli.quests_writeups_delete({
"writeupid": 0
})
quests_writeups_list - This method will be returned list of writeups by questid
This method will be returned list of writeups by questid
Access: unauthorized - yes, user - yes, admin - yes
- questid - integer, required; Quest ID
response = cli.quests_writeups_list({
"questid": 0
})
quests_writeups_proposal - This method will be add writeup from authorized user
This method will be add writeup from authorized user
Access: unauthorized - no, user - yes, admin - yes
- questid - integer, required; Quest ID
- writeup_link - string, required; Link to writeup (Must be start from https://www.youtube.com/watch?v=)
response = cli.quests_writeups_proposal({
"questid": 0,
"writeup_link": ""
})
quests_writeups_update - This method will be update writeup approve now
This method will be update writeup approve now
Access: unauthorized - no, user - no, admin - yes
- writeupid - integer, required; WriteUp ID
- approve - string, required; Approve value 1 or 0
response = cli.quests_writeups_update({
"writeupid": 0,
"approve": ""
})
registration - Method for registration
Method for registration
Access: unauthorized - yes, user - no, admin - no
- email - string, required; E-mail
- university - string, required; University
response = cli.registration({
"email": "",
"university": ""
})
scoreboard - Method return scoreboard
Method return scoreboard
Access: unauthorized - yes, user - yes, admin - yes
- page - integer, required; Number of page
- onpage - integer, required; How much rows in one page
response = cli.scoreboard({
"page": 0,
"onpage": 10
})
server.uuid_generate - for generate new uuid
for generate new uuid
Access: unauthorized - no, user - no, admin - yes
- typeobj - string, required; type object of uuid for some
response = cli.server.uuid_generate({
"typeobj": ""
})
server.uuid_info - return info about uuid
return info about uuid
Access: unauthorized - yes, user - yes, admin - yes
- uuid - string, required; uuid for some object
response = cli.server.uuid_info({
"uuid": ""
})
server_api - This method Will be return list of all handlers
This method Will be return list of all handlers
Access: unauthorized - yes, user - yes, admin - yes
response = cli.server_api({
})
server_info - Return server private information
Return server private information
Access: unauthorized - no, user - no, admin - yes
response = cli.server_info({
})
server_settings - Return server settings
Return server settings
Access: unauthorized - no, user - no, admin - yes
response = cli.server_settings({
})
server_settings_update - Update server settings
Update server settings
Access: unauthorized - no, user - no, admin - yes
- name - string, required; name of setting
- value - string, required; value of setting
response = cli.server_settings_update({
"name": "",
"value": ""
})
token - Method for login by token
Method for login by token
Access: unauthorized - yes, user - no, admin - no
- token - string, required; Authorization token
response = cli.token({
"token": ""
})
updateuserlocation - This method will be try update user location by lastip
This method will be try update user location by lastip
Access: unauthorized - no, user - no, admin - yes
- userid - integer, required; User ID
response = cli.updateuserlocation({
"userid": 0
})
useful_links_add - Method for add new useful link
Method for add new useful link
Access: unauthorized - no, user - no, admin - yes
- url - string, required; URL
- description - string, required; Description
- author - string, required; Author
response = cli.useful_links_add({
"url": "",
"description": "",
"author": ""
})
useful_links_clicked - Useful Links removed from favorite
Useful Links removed from favorite
Access: unauthorized - yes, user - yes, admin - yes
- useful_link_id - integer, required; Id of useful link
response = cli.useful_links_clicked({
"useful_link_id": 0
})
useful_links_comment_add - Useful Links add comment
Useful Links add comment
Access: unauthorized - no, user - yes, admin - yes
- useful_link_id - integer, required; Id of useful link
- comment - string, required; Comment
response = cli.useful_links_comment_add({
"useful_link_id": 0,
"comment": ""
})
useful_links_comment_delete - Useful Links remove comment
Useful Links remove comment
Access: unauthorized - no, user - yes, admin - yes
- useful_link_comment_id - integer, required; Comment Id for useful link
response = cli.useful_links_comment_delete({
"useful_link_comment_id": 0
})
useful_links_comment_list - Useful Links list of comments
Useful Links list of comments
Access: unauthorized - yes, user - yes, admin - yes
- useful_link_id - integer, required; Id of useful link
response = cli.useful_links_comment_list({
"useful_link_id": 0
})
useful_links_delete - Method for delete link by admin
Method for delete link by admin
Access: unauthorized - no, user - no, admin - yes
- useful_link_id - integer, required; Id of useful link
response = cli.useful_links_delete({
"useful_link_id": 0
})
useful_links_list - Method will be return list of useful links
Method will be return list of useful links
Access: unauthorized - yes, user - yes, admin - yes
- filter - string, optional; Filter by word
- filter_by_tag - string, optional; Filter by tag
- page_index - integer, optional; Page Index
- page_size - integer, optional; Page Size (default 10)
response = cli.useful_links_list({
"filter": "",
"filter_by_tag": "",
"page_index": 0,
"page_size": 0
})
useful_links_retrieve - Method for retrieve useful link
Method for retrieve useful link
Access: unauthorized - yes, user - yes, admin - yes
- useful_link_id - integer, required; Id of useful link
response = cli.useful_links_retrieve({
"useful_link_id": 0
})
useful_links_tag_add - Useful Links add tag
Useful Links add tag
Access: unauthorized - no, user - no, admin - yes
- useful_link_id - integer, required; Id of useful link
- tag - string, required; Tag Value
response = cli.useful_links_tag_add({
"useful_link_id": 0,
"tag": ""
})
useful_links_tag_delete - Useful Links remove tag
Useful Links remove tag
Access: unauthorized - no, user - no, admin - yes
- useful_link_id - integer, required; Useful Link Id
- tag - string, required; Tag Value
response = cli.useful_links_tag_delete({
"useful_link_id": 0,
"tag": ""
})
useful_links_tag_list - Useful Links - List of tags
Useful Links - List of tags
Access: unauthorized - yes, user - yes, admin - yes
response = cli.useful_links_tag_list({
})
useful_links_update - Method for update useful link
Method for update useful link
Access: unauthorized - no, user - no, admin - yes
- useful_link_id - integer, required; Id of useful link
- url - string, required; URL
- description - string, required; Description
- author - string, required; Author
response = cli.useful_links_update({
"useful_link_id": 0,
"url": "",
"description": "",
"author": ""
})
useful_links_user_favorite - Useful Links add to favorite
Useful Links add to favorite
Access: unauthorized - no, user - yes, admin - yes
- useful_link_id - integer, required; Id of useful link
response = cli.useful_links_user_favorite({
"useful_link_id": 0
})
useful_links_user_favorite_list - Useful Links list of favorite
Useful Links list of favorite
Access: unauthorized - no, user - yes, admin - yes
response = cli.useful_links_user_favorite_list({
})
useful_links_user_propose - Useful Links propose link by user
Useful Links propose link by user
Access: unauthorized - no, user - yes, admin - yes
- url - string, required; Url
- description - string, required; Description
- tags - string, required; tags
response = cli.useful_links_user_propose({
"url": "",
"description": "",
"tags": ""
})
useful_links_user_propose_approve - Useful Links Approve propose link by admin
Useful Links Approve propose link by admin
Access: unauthorized - no, user - no, admin - yes
- useful_links_propose_id - integer, required; Id of propose for useful_links
response = cli.useful_links_user_propose_approve({
"useful_links_propose_id": 0
})
useful_links_user_unfavorite - Useful Links removed from favorite
Useful Links removed from favorite
Access: unauthorized - no, user - yes, admin - yes
- useful_link_id - integer, required; Id of useful link
response = cli.useful_links_user_unfavorite({
"useful_link_id": 0
})
user - Return user info
Return user info
Access: unauthorized - yes, user - yes, admin - yes
- userid - integer, optional; Id of user
response = cli.user({
"userid": 0
})
user_change_password - This method for change user password
This method for change user password
Access: unauthorized - no, user - yes, admin - yes
- password_old - string, required; Old password
- password_new - string, required; New password
response = cli.user_change_password({
"password_old": "",
"password_new": ""
})
user_reset_password - Method for reset password
Method for reset password
Access: unauthorized - yes, user - no, admin - no
- email - string, required; E-mail
response = cli.user_reset_password({
"email": ""
})
user_skills - Return user skills info
Return user skills info
Access: unauthorized - yes, user - yes, admin - yes
- userid - integer, required; Id of user
response = cli.user_skills({
"userid": 0
})
user_update - Update user info
Update user info
Access: unauthorized - no, user - yes, admin - yes
- userid - integer, required; Id of user
- nick - string, optional; Nick of user
- university - string, optional; University of user
- about - string, optional; About of user
- country - string, optional; Country of user
response = cli.user_update({
"userid": 0,
"nick": "",
"university": "",
"about": "",
"country": ""
})
users - Method return list of users
Method return list of users
Access: unauthorized - no, user - no, admin - yes
- filter_text - string, optional; Filter by user email or nick
- filter_role - string, optional; Filter by user role
- onpage - integer, optional; On Page
- page - integer, optional; Number of page
response = cli.users({
"filter_text": "",
"filter_role": "",
"onpage": 10,
"page": 0
})
users_add - Method for add new user
Method for add new user
Access: unauthorized - no, user - no, admin - yes
- uuid - string, required; User's Global Unique Identifier
- email - string, required; User's E-mail
- nick - string, required; User's nick
- password - string, required; Password
- role - string, required; User's role
- university - string, optional; University
response = cli.users_add({
"uuid": "",
"email": "",
"nick": "",
"password": "",
"role": "",
"university": ""
})
users_change_email - Method for email changing
Method for email changing
Access: unauthorized - no, user - yes, admin - yes
- email - string, required; New E-mail
- password - string, required; Password
response = cli.users_change_email({
"email": "",
"password": ""
})
users_change_email_verification - Method for email changing verification
Method for email changing verification
Access: unauthorized - no, user - yes, admin - yes
- code - string, required; Verification code
response = cli.users_change_email_verification({
"code": ""
})
users_delete - Method for deleting a user
Method for deleting a user
Access: unauthorized - no, user - no, admin - yes
- userid - integer, required; User's id
- password - string, required; Admin's password
response = cli.users_delete({
"userid": 0,
"password": ""
})
users_info - Return user info
Return user info
Access: unauthorized - yes, user - yes, admin - yes
- uuid - integer, required; Global unique identify of user
response = cli.users_info({
"uuid": 0
})
users_registration - Method for registration
Method for registration
Access: unauthorized - yes, user - no, admin - no
- email - string, required; E-mail
response = cli.users_registration({
"email": ""
})
users_registration_verification - Method for registration verification
Method for registration verification
Access: unauthorized - yes, user - no, admin - no
- code - string, required; Verification code
response = cli.users_registration_verification({
"code": ""
})
users_tokens - List of active user tokens
List of active user tokens
Access: unauthorized - no, user - yes, admin - yes
response = cli.users_tokens({
})