Skip to content

RITct/student-mail-benefits

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Student Benefits

An Open API containing all information regarding student licenses for popular professional products.

Table Of Contents

Using the API

Routes

Route Method Function
/benefits/ GET Get All Benefits
/benefits/ POST Create a benefit
/benefits/<PK>/ GET Fetch Benefit By PK
/category/ GET Get all categories
/category/<PK> GET Fetch Category by PK

Benefit Data

Arguments Type Details
id Integer Primary Key
title String Title of the benefit
description String A small description of the benefit
link String Link to the website of the benefit
category Integer The category of the benefit
img_link String The link to the image of the benefit
highlights JSON String JSON List of Strings containing important features of the benefit

Get All Benefits

Get all the verified benefits stored in this API.
To filter by category, pass category=<category_id> as a GET parameter

Fetch Benefit By PK

Get details of Benefit by PK

Create a Benefit

Contribute to this collection by adding an unlisted benefit

Arguments Type Required
title String Yes
description String Yes
link String Yes
category Integer No
img_link String No
highlights JSON String No

NOTE: Your contribution will be listed only after verification by community members.

Get all Categories

Get all the categories.

Fetch Category by PK

Fetch a category by it's PK

About

API for fetching benefits of student mail

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%