API-Docs.md

Franchise Hub Server API Routes

BASE DEBUG ROUTE: https://franchise-hub-server.herokuapp.com

Hello World!

• GET ➜ /

Website

Create new forms:

• POST ➜ /api/v1/webview/forms/franchisor-registration/new

• POST ➜ /api/v1/webview/forms/newsletter-subscribers/new

• POST ➜ /api/v1/webview/forms/free-advice/new

• POST ➜ /api/v1/webview/forms/franchisee-application/new

GET card data:

• GET ➜ /api/v1/webview/section/top-franchise-opportunities/all

• GET ➜ /api/v1/webview/section/listed-franchises/all

• GET ➜ /api/v1/webview/section/trending-videos/all

• GET ➜ /api/v1/webview/section/trending-franchises

• ?quantity=number-of-items
  

• GET ➜ /api/v1/webview/section/events/all

Filter Franchises:

• GET ➜ /api/v1/webview/section/filter

• ?search_by=location
  
  • &industry=industry
    
  • &country=country
    
  • &state=state
    
• ?search_by=investment
  
  • &industry=industry
    
  • &min=min_investment
    
  • &max=max_investment

Dashboard

Admin Login:

• POST ➜ /api/v1/admin/login

• POST ➜ /api/v1/admin/logout

Event Section Menu:

• GET ➜ /api/v1/admin/dashboard/web/events/:page

• ?quantity=per-page-quantity
  

• POST ➜ /api/v1/admin/dashboard/web/events/new

• DELETE ➜ /api/v1/admin/dashboard/web/events/:objectId

Trending Videos Section Menu:

• GET ➜ /api/v1/admin/dashboard/web/trending-videos/:page

• ?quantity=per-page-quantity
  

• POST ➜ /api/v1/admin/dashboard/web/trending-videos/new

• DELETE ➜ /api/v1/admin/dashboard/web/trending-videos/:objectId

Franchisor Registration Form Menu:

• POST ➜ /api/v1/admin/dashboard/forms/franchisor-registration/new

• GET ➜ /api/v1/admin/dashboard/forms/franchisor-registration/all/:page

• ?quantity=per-page-quantity
  

• GET ➜ /api/v1/admin/dashboard/forms/franchisor-registration/read/:page

• ?quantity=per-page-quantity
  

• GET ➜ /api/v1/admin/dashboard/forms/franchisor-registration/unread/:page

• ?quantity=per-page-quantity
  

• PUT ➜ /api/v1/admin/dashboard/forms/franchisor-registration/update/:objectId

• PUT ➜ /api/v1/admin/dashboard/forms/franchisor-registration/mark-read/:objectId

• PUT ➜ /api/v1/admin/dashboard/forms/franchisor-registration/mark-unread/:objectId

• PUT ➜ /api/v1/admin/dashboard/forms/franchisor-registration/enable-listing/:objectId

• PUT ➜ /api/v1/admin/dashboard/forms/franchisor-registration/disable-listing/:objectId

• DELETE ➜ /api/v1/admin/dashboard/forms/franchisor-registration/:objectId

Franchisee Application Form Menu:

• GET ➜ /api/v1/admin/dashboard/forms/franchisee-application/all/:page

• ?quantity=per-page-quantity
  

• GET ➜ /api/v1/admin/dashboard/forms/franchisee-application/read/:page

• ?quantity=per-page-quantity
  

• GET ➜ /api/v1/admin/dashboard/forms/franchisee-application/unread/:page

• ?quantity=per-page-quantity
  

• PUT ➜ /api/v1/admin/dashboard/forms/franchisee-application/mark-read/:objectId

• PUT ➜ /api/v1/admin/dashboard/forms/franchisee-application/mark-unread/:objectId

• DELETE ➜ /api/v1/admin/dashboard/forms/franchisee-application/:objectId

Free Advice Form Menu:

• GET ➜ /api/v1/admin/dashboard/forms/free-advice/all/:page

• ?quantity=per-page-quantity
  

• GET ➜ /api/v1/admin/dashboard/forms/free-advice/read/:page

• ?quantity=per-page-quantity
  

• GET ➜ /api/v1/admin/dashboard/forms/free-advice/unread/:page

• ?quantity=per-page-quantity
  

• PUT ➜ /api/v1/admin/dashboard/forms/free-advice/mark-read/:objectId

• PUT ➜ /api/v1/admin/dashboard/forms/free-advice/mark-unread/:objectId

• DELETE ➜ /api/v1/admin/dashboard/forms/free-advice/:objectId

Newsletter Subscribers Form Menu:

• GET ➜ /api/v1/admin/dashboard/forms/newsletter-subscribers/:page

• ?quantity=per-page-quantity
  

• PUT ➜ /api/v1/admin/dashboard/forms/newsletter-subscribers/mark-allread

• DELETE ➜ /api/v1/admin/dashboard/forms/newsletter-subscribers/:objectId

Admin Profile

Change Admin Username:

• POST ➜ /api/v1/admin/dashboard/profile/change-username

Change Admin Password:

• POST ➜ /api/v1/admin/dashboard/profile/change-password