Library Management System (LMS) - ITP Project 2nd Semester
#Api server Documentation
[endpoint: (http://localhost:5000/innoLibrary/api)]
private keys are provided to developers and special people ask for permission: telegram - @rakhmatullinart
Available methods: Available methods:
- sign_up (*)
- sign_in (*)
- get_document(*)
- take_document(*)
- add_document(*)
- delete_document(*)
- create_user
- identify_request(*)
- is_free_login
- is_true_data
- get_book_info
- take_book
- get_user(*)
- add_document
- delete_document
- set_name
- set_phone_number
- add_fine_for_book
- set_address
- check_out_book
- return_book
- search_for_a_book
- renew_book
- get_user_info(*)
- initUI
- userLogIn
- userSignUp
- placeBooks
- showBook
- closeBook
- general_info
- get_doc_info
- get_all_users
- get_all_documents
- checkout
- permit_to_checkout
- are_copies
- checkout_by_author
- get_table
- get_user_obj
- get_taken_books
- create_class_object
Descriptions ###sign_up required parameters
- login
- password
- name
- user_type
sample output:
json {'success': 'True', errors: {}} ###sign_in required parameters
- login
- password
headers = {'application/json'}
format json
required parameters
obligatory to pass following:
- doc_type - type of a document - string
- title - string
- authors - array of strings
- price - string
- room - string
- level - string
parameter passing depending on type of document
- search for in database for corresponding fields
####example of python request import requests
test_book = {'doc_type': 'book', 'title': 'ITP', 'authors': ['Victor Rivera'] .....}
requests.post(url='www.someurl/endpoint/add_document', data=json.dumps(test_book), headers=headers)
###sign_up Create a new user account
required parameters
- login
- password
- name
- user_type
###sign_in Log in to user account
required parameters
- login
- password
###get_document Get book info from database using its id
required parameters
- doc_id
- data
###take_document Assign one copy of document to specified user in the database
required parameters
- private_key
###add_document Add new document to the database
required parameters
- data
- private_key
###delete_document Delete document from database
required parameters
- data
- private_key
###create_user Create a new user account
required parameters
- login
- user_type
- password
###identify_request Identify a request
required parameters
- key
###is_free_login Check availability of given login
required parameters
- login
###is_true_data Check if given data is correct
required parameters
- login
- password
###get_book_info Get information about given book using its id
required parameters
- doc_id
###take_book Assign specified book to user
required parameters
- doc_id
###get_user Get user account using id
required parameters
- uid
###add_document Add new document
required parameters
- common
- doc_type
###initUI Initialize User Id
required parameters
- login
- password
###delete_document Delete document
required parameters
- doc_id
- doc_type
###set_name Set name of the user
required parameters
- self
- new_name
###set_phone_number Set phone number of the user
required parameters
- self
- new_phone_number
###add_fine_for_book Add a fine for a certain book
required parameters
- self
- book_name
###set_address Set address of the user
required parameters
- self
- new_address
###check_out_book Check out the book
required parameters
- self
- bok
###return_book Return a book from user to library
required parameters
- self
- bok
####search_for_a_book Search for a book in a library system
required parameters
- self
- list_of_all_books
- looking_for
###renew_book Special feature to renew the book
required parameters
- self
- name_of_book
###userLogIn Prints login text
###userSignUp Sign up for a user
###placeBooks Put books on a certain place
required parameters
- name
- position
###showBook Show book
###create_class_object Creates an object of a certain class
required parameters
- doc_type
- mas
###get_taken_books Show books taken by certain user
required parameters
- uid
###get_user_obj Get object of class "user"
required parameters
- uid
###get_table Get table of documents of a given type
required parameters
- doc_type
###checkout_by_author Check out document by a given author
required parameters
- authors
###are_copies Checks if two given books are copies
required parameters
- doc1
- doc2
###permit_to_checkout Checks if the book is able to be checked out
required parameters
- books
- wanted_book_id
###checkout Check out a book
required parameters
- kwargs
- doc_type
- table
- doc_id
- obj
###get_all_documents Get all documents
###get_all_users Get all users
###get_doc_info Get information about given document
required parameters
- doc_id
- doc_type
###general_info Get name and phone of a given user
required parameters
- uid