Skip to content

Latest commit

 

History

History
198 lines (182 loc) · 5.48 KB

API doc.md

File metadata and controls

198 lines (182 loc) · 5.48 KB

Signup

URL $~~$ : $~$ /signup

  • Method:POST

    Data Params

        {
      {"user":
          {
          "email":"user735@gmail.com",
          "phone":"9248786695",
          "usertype":"is-admin",
          "registernumber":"user7529"
          },
      "profile":{
                  "firstname":"user73",
                  "lastname":"new",
                  "fullname":"harry",
                  "address":"new",
                  "standard":["1-A"]}
                  }
      }

    Responses

    • Success Response
      User created successfully
    • Failure Response
      returns the Exception while the process

Login

URL $~~$ : $~$ /login

Data Params

    {
    "email:<email>
    "phone":<phone>
    }

Responses

  • Success Response

    {status : "successfully logged in"
    data : <logged in users data>
    token : <token>}

  • Failure Response
    User Does Not Exist

User Details

$~~~$ Methods

$~~~~~$ GET,PATCH,DELETE

$~~~~~$ URL $~~$ : $~$ user/id

  • GET

$~~~~~~~~~$ Responses

$~~~~~~~~~~~~~~~$ Success Response
$~~~~~~~~~~~~~~~$ $~~~~~~~$ {"status" : "success",
$~~~~~~~~~~~~~~~$ $~~~~~~~$ "data" : <data(Array)>}
$~~~~~~~~~~~~~~~$ Failure Response
$~~~~~~~~~~~~~~~~~~~~~~$ User Does Not Exist

  • PATCH

    Data Params

      {
    {"user":
        {
        "email":"user735@gmail.com",
        "phone":"9248786695",
        "usertype":"is-admin",
        "registernumber":"user7529"
        },
    "profile":{
                "firstname":"user73",
                "lastname":"new",
                "fullname":"harry",
                "address":"new",
                "standard":["1-A"]}
                }
    }

    Responses

    • Success Response
      {"status" : "Updated Successfully",

    • Failure Response
      Exception while updating

  • DELETE

    Responses

    • Success Response
      {"status" : "User Deleted Successfully",

    • Failure Response
      User Dosen't exist

Profile

URL $~~$ : $~$ /profile

Responses

  • Success Response $~$ (if user logged in)
    {"status" : "success" , "data":<[logged in user data]>}
  • Failure Response
    User Does not logged in

Grade

URL $~~$ : $~$ /grade

Methods

$~~~~~$ GET,POST,PATCH,DELETE

  • POST

    Data Params

      {
      "grade":<int>,"section":<array of sections>
  }

    Responses

    • Success Response $~$ (if user logged in)
      {"status" : "success" , "message":"Grade Created"}
    • Failure Response
      Grade already exists
  • GET

    Responses

    • Success Response

      • if student user logged in

        {"status" : "success" , "data:[grade of student]"}

      • if staff user logged in

        {"status" : "success" , "data:[<grades which allocated to the logged in staff>]"}

      • if admin user logged in

        {"status" : "success" , "data:[<all grades>]"}

    • Failure Response
      $~~~${"status": "failure", 'data': 'Your not have access to view this page'}
  • PATCH

    URL $~~$ : $~$ /grade/id

    Data Params

     {
     "grade":<int>,"section":<array of sections>
 }

    Responses

    • Success Response
      {"message": "Grade Updated "}
    • Failure Response
      {"status": "failure", 'data': '<Exception error while updating>'}
  • DELETE

    URL $~~$ : $~$ /grade/id

    Responses

    • Success Response
      {"message": "Grade Deleted "}
    • Failure Response
      {"status": "failure", 'data': '<Exception error while updating>'}

    Subject

URL $~~$ : $~$ /grade

Methods

$~~~~~$ GET,POST,PATCH,DELETE

  • POST

    Data Params

      {
  "name":<string>,"code":<int>,"grade":<grade id>
   }

    Responses

    • Success Response $~$ (if user logged in)
      {"status" : "success" , "message":"Subject Created"}
    • Failure Response
      Exception while process
  • GET

    query params

    grade=grade id

    Responses

    • Success Response
      {"status" : "success" , "data:[subjects in grade]"

    • Failure Response
      $~~~${"status": "failure", 'data': 'No subjects in grade'}

  • PATCH

    URL $~~$ : $~$ /subject/id

    Data Params

     {
 "name":<string>,"code":<int>,"grade":<grade id>
  }

    Responses

    • Success Response
      {"message": "Subject Updated "}
    • Failure Response
      {"status": "failure", 'data': '<Exception error while updating>'}
  • DELETE

    URL $~~$ : $~$ /grade/id

    Responses

    • Success Response
      {"message": "Subject Deleted "}
    • Failure Response
      {"status": "failure", 'data': '<Exception error while delete>'}