Skip to content

Latest commit

 

History

History
203 lines (167 loc) · 3.04 KB

README.md

File metadata and controls

203 lines (167 loc) · 3.04 KB

완 료 ! ! ! ! ! ! 가즈아아아아아아

Sirius Student Management API

시리우스의 종합 학생 관리 시스템

개발 현황:

  • 시간표 API
  • 급식 API
  • Todo API
  • 조회 API
  • 게시판 API

시간표 API

시간표 불러오기

TYPE: GET REQUEST

 
{ "timesc" : 
  [
    {
        "title" : "영어",
        "period" : 1
    },
    {
        "title" : "국어",
        "period" : 2
    },
  ]
}

URL/timesc/studentPk/시간표일자(YYYYMMDD)/
예시

User API

유저 생성

TYPE: POST REQUEST

{
  "result":"success",
  "pk":1
}

에러 예시

{
  "result":"fail",
  "reason":"Already Existing ID"
}

전달값
"username" "password"

URL/signup/stclasstype/school/edumintype/grade

로그인 (로그체크)

{
  "result":"success",
  "res":"Succeeded in <AREA>",
  "pk":777
}

전달값
"username" "password"

URL/api/logcheck

To do list API

Todo 생성

TYPE: GET REQUEST

{
  "result":"success",
  "todopk":2
}

URL/todoList/create/StudentPk/title/body/

Todo 보기

TYPE: GET REQUEST

{
   "todo":[
      {
        "title":"수학의 정석 수(하) 풀기",
        "body":"p27~p33",
        "subject":"수학",
        "todopk":2
      }
   ]
}

Todo 삭제

TYPE: GET REQUEST

{
  "result":"success",
}

URL/todoList/delete/todoPk/

게시판 API

글 쓰기

TYPE: GET REQUEST

{
  "result":"SUCCESS!!!"
}

전달값
"title" "body"

URL/forum/send/<forumpk>/<studentpk>

글 조회

{
   "result":[
      {
         "title":"히히",
         "body":"크크루삥뽕",
         "likes":3,
         "author":"tte",
         "id":1
      },
      {
         "title":"OOOOOO",
         "body":"oksick",
         "likes":1,
         "author":"tt7",
         "id":2
      },
      {
         "title":"Helpme",
         "body":"oksick",
         "likes":0,
         "author":"tt7",
         "id":3
      }
   ]
}

URL/forum/query/<forumpk>

좋아요

{
  "result":"SUCCESS!!!"
}

URL/forum/like/<postid>

급식 API

시간표 불러오기

TYPE: GET REQUEST

{
    "food":{
        "menu":[
            "후리카케밥  (2.5.6.10.13.)",
            "미트스파게티.  (1.2.5.6.10.12.13.16.18.)",
            "포기김치.  (9.13.)",
            "음료  (5.13.)",
            "불고기치아바타샌드위치  (1.2.5.6.12.13.16.)",
            "모듬피클.  (13.)",
            "열대과일샐러드  (1.5.13.)"
        ]
    }
}

URL/food/StudentPk/시간표일자(YYYYMMDD)/
예시

조회 API

Local Group 모두 불러오기 (시도)

URL/getlocals

Galaxy 모두 불러오기 (좀 더 세부적인거...)

URL/getgalaxies/[시도]

학교 불러오기

URL/getschool/[시도]/[구/시]/[학교 종류: 중학교, 고등학교, 등]