Code Monkey home page Code Monkey logo

ieee-api's Introduction

IEEE-UVCE API

This api will be used in the official IEEE-Website for interaction with the frontend, idk when that will be build.

  sd-team is the API_KEY

The base URL is

https://ieee-uvce.000webhostapp.com

Interaction Points for manipulating event posts

  ?add=1
  ?update=1
  ?delete=all
  ?delete={id of the record}
  ?fetch=all
  ?fetch={id of the record}

Request to add Posts

Must send a request to add request --> ?add=1

Get requests that can be made? / Parameters

1) heading

?add=1&heading = {Post heading here}

2) subheading

?add=1&subheading = {Post subheading here}

3) form-link

?add=1&form-link = {form-link here}

4) img

?add=1&img = {img_link_here}

5) last-date

?add=1&last-date = {last date here}

Sample add request

     https://ieee-uvce.000webhostapp.com?add=1&heading={heading}&subheading={subheading}&form-link={form-link}&last-date={last-date}&img={img_url_here}
Its not required that all these Parameters have to be passed to insert the record, however heading and subheading Parameters are compulsary/required and without which other Parameters will not take effect.

Request Update Posts

Must send a request to update request --> ?update=1

Get requests that can be made? / Parameters

0) id

?update=1&id = {Post id}

1) heading

?update=1&heading = {Post heading here}

2) subheading

?update=1&subheading = {Post subheading here}

3) form-link

?update=1&form-link = {form-link here}

4) img

?update=1&img = {img_link_here}

5) last-date

?update=1&last-date = {last date here}

Sample update request

     https://ieee-uvce.000webhostapp.com?update=1&id={id to be updated}&heading={heading to be updated}&subheading={heading to be updated}&form-link={form link to be updated}&last-date={last date to be updated}&img={image url to be updated}
Its not required that all these Parameters have to be passed to insert the record, however id Parameter is compulsary/required and without which other Parameters will not take effect.

Fetch the posts

Must send a request to fetch posts request

  ?fetch=all

this fetches all the posts, or

  ?fetch={id of the specific post}

Sample fetch request

    https://ieee-uvce.000webhostapp.com?fetch=all

    or

    https://ieee-uvce.000webhostapp.com?fetch={id of the post}
Note: either all or the id of the post which needs to be fetched must be passed as a parameter.

Delete posts

Must send a request to delete posts request

  ?delete={id of the specific post to be deleted}

Sample fetch request

    https://ieee-uvce.000webhostapp.com?fetch={id of the post to be deleted}

Add response looks like

image

Fetch response looks like

image

Update response looks like

image

Delete response looks like

image

ieee-api's People

Contributors

hi-kartik2004 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.