Skip to content

API Documentation

mustafafeyzioglu edited this page May 16, 2017 · 9 revisions

University Students API Documentation

Introduction

Purpose of this API is to track students informations in Universities. In this API we have a post and a get method to add a student to our database and get the students in the database .

GET /api/students

It returns all students without any parameter.

Resource URL

Resource Information

Response Format JSON
Requires Authentication No

Parameters

None.

Example Request

GET http://127.0.0.1:8000/api/students/

Example Response

Example Response

POST /api/students

It creates a new student with the given name, number, gpa, department and university. Then it saves it to the database.

Resource URL

Resource Information

Response Format JSON
Requires Authentication No

Parameters

Name Required Description Example
name yes Full name of the Student Ali Aslanalp
number yes Student number of the Student 2008222324
gpa yes GPA of the Student 2.8
department yes Department that the student pursues his/her degree Computer Engineering
university yes University name that the student pursues his/her/degree Bogazici University

Example Request

Example Request

Example Response

Example Response

Clone this wiki locally