Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 1.66 KB

README.md

File metadata and controls

85 lines (60 loc) · 1.66 KB
Raw

Assignment Buddy API

The API documentation. each POST request accepts data in req.body.

API : https://abuddyapi.glitch.me/

API Reference

Generate Assignment

  POST /api/generate
Parameter Type Description
subject string Required. Assignment subject prefix (ex. bis)
number string Required. Assignment number (ex. 1)
qs array(string) Required. Assignment questions as array
download boolean Download PDF right away if true 
  RESPONSE ON SUCCESS 
  { 
  success : true, 
  data : "Assignment successfully created"
  }

  RESPONSE ON ERROR
  {
  success :  false,
  data : "Internal Server Error"
  }

Download Assignment

  POST /api/download
Parameter Type Description
subject string Required. Assignment subject prefix (ex. bis)
number string Required. Assignment number (ex. 1) 
  RESPONSE ON SUCCESS 
  downloads file on success

  RESPONSE ON ERROR
  {
  success :  false,
  data : "Assignment does not exist"
  }

Get totalassignments count of a subject

  POST /api/totalassignments
Parameter Type Description
subject string Required. subject prefix (ex. bis) 
  RESPONSE ON SUCCESS 
  {
  success :  true,
  data : "Total Assignments : 3",
  total : 3
  }

Authors