1. Overview#
The Restful API developers can use to build frontend on top of
2. API Tables#
2.1 Index#
2.1.1 User Registration#
| Operation | Route | Description |
|---|
POST | /register | Register a new user |
POST | /register/:token | Validate a new user |
2.1.2 User Login/Logout#
| Operation | Route | Description |
|---|
POST | /login | User login |
POST | /logout | User logout |
2.1.3 Miscellanea#
| Operation | Route | Description |
|---|
GET | / | Get message "Hello from Express" |
GET | /organization/types | Get a list of organization types |
GET | /land_use/types | Get a list of land use types |
GET | /wards | Get a list of wards |
GET | /space/types | Get a list of space types |
GET | /partnership/roles | Get a list of partnership roles |
GET | /project/types | Get a list of project types |
2.1.4 Administrative Operations#
| Operation | Route | Description |
|---|
GET | /users | Get all registered users |
GET | /users/email/:email | Get a user by email |
GET | /users/username/:username | Get a user by username |
PUT | /users/update | Update a user |
2.1.5 Opportunity Listing#
| Operation | Route | Description |
|---|
GET | /opportunites | Get all opportunities |
GET | /opportunities/user | Get all the opportunities posted by a user |
GET | /opportunity/:id | Get the opportunity with a specific id |
POST | /opportunities | Add an opportunity |
POST | /opportunity/search | Get opportunities, filtered |
2.1.5.1 Opportunity Listing - File Upload#
| Operation | Route | Description |
|---|
POST | /upload | Upload files related to a partnership opportunity |
2.1.6 Notification of Interest#
| Operation | Route | Description |
|---|
POST | /interests/:id | Send a notification of interest |
GET | /interests/sent | See a user's sent notifications of interest |
GET | /interests/received | See a user's received notification of interest |