This repository has been archived by the owner on Nov 30, 2022. It is now read-only.
API call list #77
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
needs discussion
List of the potential API calls for the V.0 project, sorted by page:
-ButtonFile:
Description: This is the Button post page. Inserted in this page both the creator of the button and the visitors can see the Button data and the Feeds associated with this Button.
API calls:
Button/FindByID : Receive all button data by it's id
Feeds are lists of interactions, in this case we can show different lists of interactions cards depending on predefined filters, these filters are:
-Button data changes (shows cards refered to the changes in Button Data made by the creator)
-User comments : show only posted comments of visitors and creators on the Button ordered from recent to past.
-External Notifications : shows updates from external sources like telegram.
-All interactions: shows all interactions of the Button on the feed
-ButtonNew
Description: In this page we create the Button post according to the ButtonTemplate prefered for the Network. Form fields show up according to this ButtonTemplate .
•ButtonTemplate/findById
•Button/New
-Config
Description: Edit all data regarding User including its created Networks and modderation.
•User GET, PUT and DELETE (username,name,email,avatar,description,share location,language, interests, receive notifications, distance, base location, password, telegram user, phone number, blocked users)
• Network GET, PUT, DELETE by Creator (User) reference (network name, networks searchname, description, location, icon, tags, url, friend networks ids, blocked users, admin users. external data(optional): external url, )
-Explore
Description: Display Buttons in different formats and filtered in different ways.
•Buttons filterBy (tag, button type, location, date interval, and ButtonTemplate data) orderBy (Last created, First created, event date, Distance, Button interactions, User likes)
• Display on Map one by one: Get Buttons filtered by view coordinates rectangle and its basic data (Creator avatar, Button type, tags, position) (position). When clicked the pin it calls for more info (Button image, description, title date, locationname)
•Display on list: Get all buttons determined by the map position and the filters and display them o a list (creator avatar, creator name, button type, tags, Button title, Button image, button location name, button date)
•Display on map by zones: Shows Buttons on list filtered by poligons selected by the user on the map. Filter by poligonal coordinate.
-Faqs
No api calls
-Login
Description: User access page.
User GET by username, email
-NetworkAccess
Description: Networks access screen for private network. Asks the user to accept to join the network.
Network GET by id, PUT Network admitted users
-NetworkNew
Description: Create new network by the current User. Creates a basic network
•Network POST - (name, )
-Notifications
Description: List of user interactions with the same Feed structure that can be filtered by :
User GET Interactions
-Profile
Description: View User Profile data. Acces profile edition and user block/like interactions.
User GET, PUT likes / blockedBy (when it's other user profile)
-Recovery
Description: Password reset page.
User PUT password
-Signup
Description : Create account page
User GET POST
The text was updated successfully, but these errors were encountered: