APIs

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

OperationRouteDescription
POST/registerRegister a new user
POST/register/:tokenValidate a new user

2.1.2 User Login/Logout

OperationRouteDescription
POST/loginUser login
POST/logoutUser logout

2.1.3 Miscellanea

OperationRouteDescription
GET/Get message "Hello from Express"
GET/organization/typesGet a list of organization types
GET/land_use/typesGet a list of land use types
GET/wardsGet a list of wards
GET/space/typesGet a list of space types
GET/partnership/rolesGet a list of partnership roles
GET/project/typesGet a list of project types

2.1.4 Administrative Operations

OperationRouteDescription
GET/usersGet all registered users
GET/users/email/:emailGet a user by email
GET/users/username/:usernameGet a user by username
PUT/users/updateUpdate a user

2.1.5 Opportunity Listing

OperationRouteDescription
GET/opportunitesGet all opportunities
GET/opportunities/userGet all the opportunities posted by a user
GET/opportunity/:idGet the opportunity with a specific id
POST/opportunitiesAdd an opportunity
POST/opportunity/searchGet opportunities, filtered

2.1.5.1 Opportunity Listing - File Upload

OperationRouteDescription
POST/uploadUpload files related to a partnership opportunity

2.1.6 Notification of Interest

OperationRouteDescription
POST/interests/:idSend a notification of interest
GET/interests/sentSee a user's sent notifications of interest
GET/interests/receivedSee a user's received notification of interest