세종대학교 컴퓨터학술 중앙동아리 인터페이스의 웹api입니다.{{develop}}은 호스트 https://interface-app-dev.herokuapp.com를 변수로 만든 것입니다.
예외 앞의 숫자는 HttpStatus입니다.
생략가능한 key는 key-value자체를 생략하거나, value를 \"\"로 둘 수 있습니다.
공지사항을 저장합니다.
\n없음
\ntitle: 제목content: 내용
/api/v1/posts/id에 해당하는 공지를 수정합니다.
400 존재하지 않는 게시글 입니다. : id가 존재하지 않아 발생
title: 제목content: 내용
모든 공지사항을 조회합니다.
\n없음
\n","urlObject":{"path":["api","v1","posts","list"],"host":["{{develop}}"],"query":[],"variable":[]}},"response":[{"id":"3008d489-615e-4ad9-9ad1-564a9bbbb477","name":"findAll","originalRequest":{"method":"GET","header":[],"url":"{{develop}}/api/v1/posts/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sat, 09 Jan 2021 07:52:53 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 3,\n \"title\": \"movie day\",\n \"content\": \"let's watch the movie\",\n \"modifiedDate\": \"2021-01-09 07:52\"\n },\n {\n \"id\": 2,\n \"title\": \"movie day\",\n \"content\": \"let's watch the movie\",\n \"modifiedDate\": \"2021-01-09 07:52\"\n }\n]"}],"_postman_id":"cdb02676-1d5e-4592-854b-076bc8dba3fa"},{"name":"delete","id":"d0d6944e-d6f8-41d0-983b-75a5ede33279","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{develop}}/api/v1/posts/1","description":"/api/v1/posts/id에 해당하는 공지를 삭제합니다.
400 존재하지 않는 게시글 입니다. : id가 존재하지 않아 발생
모든 공지사항을 삭제합니다.
response: 1
없음
\n","urlObject":{"path":["api","v1","posts","all"],"host":["{{develop}}"],"query":[],"variable":[]}},"response":[{"id":"2cea2a65-0e9d-4a6d-8466-9289fb300a16","name":"deleteAll","originalRequest":{"method":"DELETE","header":[],"url":"{{develop}}/api/v1/posts/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 08 Jan 2021 18:10:21 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"198dc374-1598-4150-be00-460434777195"}],"id":"34d07663-cade-43f2-801e-e100d401750e","_postman_id":"34d07663-cade-43f2-801e-e100d401750e","description":""},{"name":"meeting","item":[{"name":"모임생성","id":"0efd2472-b9f3-4d81-9a95-4a385b9715f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"passkey\":\"XY4T8\",\r\n \"lat\":\"33.33\",\r\n \"lon\":\"22.22\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{develop}}/api/v1/meet/insert","description":"관리자가 출석체크를 위한 모임을 만듭니다.
\nstartTime, endTime 키는 삭제됐습니다!400 이미 존재하는 출석키 입니다.: passkey중복400 현재보다 이른시각에 모임생성할 수 없습니다.: startTime 오류
passkey: 인증할 출석키startTime: 출석 인증 유효 시작시간 (형식: yyyy-MM-ddTHH:mm이고 중간에 T넣어 구분해줘야 합니다.)
\n\n생략가능. 생략시 현재시각이 들어갑니다.
\n
입력시 현재보다 이후의 시각을 입력해야합니다 .
lat: 위도lon: 경도
startTime생략 예시
\n{\n \"passkey\":\"XY4T8\",\n \"lat\":\"33.33\",\n \"lon\":\"22.22\"\n}\n관리자가 출석암호가 중복되는지 알아야 할 때 요청합니다
\nGET으로 변경됐습니다!400 이미 존재하는 출석키 입니다.: passkey중복
회원이 모임에 참여하여 출석 인증할때 사용합니다.
\ndateTime 키 삭제됐습니다.
\n\n출석키 만료만
\n401입니다.
400 존재하지 않는 출석키 입니다.: 존재하지 않는 출석키 사용시 오류.400 이미 출석되었습니다: 같은 회원이 같은 모임에 두 번이상 출석인증시 오류.400 출석키가 만료되었습니다.: 출석가능 시간이 지난 경우.400 출석 위치가 다릅니다.: 출석가능 위도/경도가 아닌 곳에서 요청시 발생하는 오류400 이미 사용중인 토큰입니다.: token이 잘못입력되어 다른 회원과 중복되는경우400 입력하지 않은 항목이 있습니다.: 빠진 필수 항목이 있을 경우401 출석키가 만료되었습니다.: 출석가능 시간이 지나 인증 요청시 발생하는 오류
studentId: 학번**(필수)**name: 이름**(필수)**generation: 기수**(필수)**passkey: 출석암호**(필수)**token: fcmToken**(필수)**lat:위도**(필수)**lon:경도**(필수)**
parameter에 studentId키에 값을 넣어 회원별 출석한 모임을 조회합니다.
400 존재하지 않는 회원입니다.: studentId 오류
parameter에 passkey키에 값을 넣어 모임별 출석한 회원목록을 조회합니다.
400 존재하지 않는 출석키 입니다. : passkey오류
관리자가 등록한 모든 passkey를 조회합니다.
\n없음
\n","urlObject":{"path":["api","v1","meet","passkeys"],"host":["{{develop}}"],"query":[],"variable":[]}},"response":[{"id":"0be4acd8-37d1-4401-a58e-0b4fc9463950","name":"모든 passkey 조회","originalRequest":{"method":"GET","header":[],"url":"{{develop}}/api/v1/meet/passkeys"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sun, 10 Jan 2021 08:40:22 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"passkey\": \"SSD2K\",\n \"startTime\": \"2020-11-11T00:00:00\",\n \"endTime\": \"2020-11-11T01:00:00\"\n },\n {\n \"passkey\": \"VJ5FG\",\n \"startTime\": \"2020-09-09T00:00:00\",\n \"endTime\": \"2020-09-09T01:00:00\"\n },\n {\n \"passkey\": \"XY4T8\",\n \"startTime\": \"2020-09-08T16:00:00\",\n \"endTime\": \"2020-09-08T17:00:00\"\n },\n {\n \"passkey\": \"A\",\n \"startTime\": \"2020-09-08T16:00:00\",\n \"endTime\": \"2020-09-08T17:00:00\"\n }\n]"}],"_postman_id":"0431c49b-16e7-4386-9166-4d8b2b183cc6"},{"name":"delete (passkey별)","id":"e04bd2bd-c076-4c3c-a0e1-bd67412ce84e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"passkey\":\"XY4T8\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{develop}}/api/v1/meet/delete","description":"관리자가 passkey에 해당하는 모임을 삭제합니다.
400 존재하지 않는 출석키 입니다.: passkey오류
passkey: 출석키
ㅡ
\n","event":[{"listen":"prerequest","script":{"id":"8611fa4b-8682-4cbf-bb95-52cd8aca5c90","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"698091e6-dabd-46d2-be14-6a98b2a94743","type":"text/javascript","exec":[""]}}],"_postman_id":"427046e1-ec56-4af0-a7ac-0ae6f1037d32"},{"name":"calendar","item":[{"name":"save","id":"3342f0ca-9025-4fe0-9427-f818c7e4bbb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date\": \"2021-01-01\",\r\n \"title\": \"2021 코딩의 해\",\r\n \"content\":\"해는 영어로 sun\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{develop}}/api/v1/calendar","description":"일정 등록을 요청합니다.
\n중복추가 방어 예외 추가됐습니다!
\n400 이미 존재하는 일정입니다 이미 일정이 존재하는 날짜에 추가시도할 때 오류
date : 일정의 날짜title : 일정의 제목content : 일정의 내용
/api/v1/calendar/id에 해당하는 일정을 수정합니다.
400 존재하지 않는 일정입니다.: id오류
date : 일정의 날짜title : 일정의 제목content : 일정의 내용
/api/v1/calendar/id에 해당하는 calendar를 response합니다.
400 존재하지 않는 일정입니다.: id오류
/api/v1/calendar/id에 해당하는 calendar를 삭제합니다.
400 존재하지 않는 일정입니다.: id오류
전체 일정을 조회합니다.
\n없음
\n","urlObject":{"path":["api","v1","calendar","list"],"host":["{{develop}}"],"query":[],"variable":[]}},"response":[{"id":"adb69884-ae97-4712-8290-09d88013f677","name":"findAll","originalRequest":{"method":"GET","header":[],"url":"{{develop}}/api/v1/calendar/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 25 Feb 2021 08:59:11 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"date\": \"2020-08-13\",\n \"title\": \"종강총회\",\n \"content\": \"종강총회기념코딩합시다\"\n }\n]"}],"_postman_id":"f30b5b86-ef04-4031-ae72-948b42ddc6f9"}],"id":"ac168f20-165c-412e-883e-a7409579b0b3","description":"일정관리,조회
\n","_postman_id":"ac168f20-165c-412e-883e-a7409579b0b3"},{"name":"login","item":[{"name":"login","id":"4ce6a4ac-f136-45ee-b500-ae019b08c00d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"pw\":\"wrong\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{develop}}/api/v1/login","description":"password를 입력하고 인증되면 해당 서비스를 이용할 수 있습니다.
response: 00로 로그인되었습니다.
400, 존재하지 않는 권한종류 입니다.
pw: 패스워드 입력
비밀번호를 변경합니다.
response: update success 또는 update failed
400, 존재하지 않는 권한종류 입니다.
role: 관리자, 회원 구분
\n\n\n
관리자,회원으로 구분
password: 패스워드 입력
권한에 해당하는 비밀번호를 조회합니다.
\n400, 존재하지 않는 권한종류 입니다.
role: 관리자, 회원 구분
\n\n","urlObject":{"path":["api","v1","login","find"],"host":["{{develop}}"],"query":[],"variable":[]}},"response":[{"id":"29eebc69-22b0-4b82-8b1f-46d762300a5c","name":"password 오류","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"role\":\"admin\",\r\n \"pw\":\"WrongPassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{develop}}/api/v1/member/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"56"},{"key":"Date","value":"Sat, 09 Jan 2021 08:13:14 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"존재하지 않는 타입 또는 비밀번호입니다."},{"id":"6a93ed06-8093-4982-a71f-fb68fed867d7","name":"login","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"role\":\"admin\",\r\n \"pw\":\"interfaceAdmin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{develop}}/api/v1/member/login"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"4"},{"key":"Date","value":"Sat, 09 Jan 2021 08:12:32 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"true"},{"id":"b29ac110-6b1a-4e5a-90b9-775073fd28ba","name":"type오류","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"role\":\"WrongAdmin\",\r\n \"pw\":\"interfaceAdmin\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{develop}}/api/v1/member/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"text/plain;charset=UTF-8"},{"key":"Content-Length","value":"56"},{"key":"Date","value":"Sat, 09 Jan 2021 08:12:53 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"존재하지 않는 타입 또는 비밀번호입니다."}],"_postman_id":"d5ac8bfc-911e-4d3d-9276-3ce527c2d4d0"}],"id":"9de205b3-e839-4fe2-b30f-836fbddb60e4","description":"\n
관리자,회원으로 구분
회원인지, 관리자인지 구분합니다.
\n","event":[{"listen":"prerequest","script":{"id":"e56ef954-1f3e-4eee-bafe-09e12851a2e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c949a7cc-0f1c-4f2d-ac36-e3e062f04b7e","type":"text/javascript","exec":[""]}}],"_postman_id":"9de205b3-e839-4fe2-b30f-836fbddb60e4"},{"name":"member","item":[{"name":"findAll","id":"a25d034d-402f-47dd-a0ee-41f31c7a0f48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{develop}}/api/v1/member/list","description":"전체 회원의 명부를 조회합니다.
\n없음
\n","urlObject":{"path":["api","v1","member","list"],"host":["{{develop}}"],"query":[],"variable":[]}},"response":[{"id":"d16956ac-9187-44da-bbe8-02976f59374b","name":"findAll","originalRequest":{"method":"GET","header":[],"url":"{{develop}}/api/v1/member/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 24 Feb 2021 10:10:41 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 4,\n \"studentId\": \"400400\",\n \"name\": \"yun\",\n \"generation\": \"29\",\n \"contact\": \"kim@gmail.com\",\n \"phone\": \"010-2222-2222\",\n \"department\": \"우유배달학과\",\n \"state\": \"재학\",\n \"manageStatus\": {\n \"openingMeeting\": \"O\",\n \"firstDues\": \"O\",\n \"finalMeeting\": \"O\",\n \"secondDues\": \"O\"\n }\n },\n {\n \"id\": 5,\n \"studentId\": \"500500\",\n \"name\": \"lim\",\n \"generation\": \"29\",\n \"contact\": \"kim@gmail.com\",\n \"phone\": \"010-2222-2222\",\n \"department\": \"우유배달학과\",\n \"state\": \"재학\",\n \"manageStatus\": {\n \"openingMeeting\": \"O\",\n \"firstDues\": \"O\",\n \"finalMeeting\": \"O\",\n \"secondDues\": \"O\"\n }\n },\n {\n \"id\": 6,\n \"studentId\": \"600600\",\n \"name\": \"oh\",\n \"generation\": \"29\",\n \"contact\": \"kim@gmail.com\",\n \"phone\": \"010-2222-2222\",\n \"department\": \"우유배달학과\",\n \"state\": \"재학\",\n \"manageStatus\": {\n \"openingMeeting\": \"O\",\n \"firstDues\": \"O\",\n \"finalMeeting\": \"O\",\n \"secondDues\": \"O\"\n }\n },\n {\n \"id\": 1,\n \"studentId\": \"100100\",\n \"name\": \"kim\",\n \"generation\": \"30\",\n \"contact\": \"kim@gmail.com\",\n \"phone\": \"010-2222-2222\",\n \"department\": \"우유배달학과\",\n \"state\": \"재학\",\n \"manageStatus\": {\n \"openingMeeting\": \"O\",\n \"firstDues\": \"O\",\n \"finalMeeting\": \"O\",\n \"secondDues\": \"O\"\n }\n },\n {\n \"id\": 2,\n \"studentId\": \"200200\",\n \"name\": \"lee\",\n \"generation\": \"30\",\n \"contact\": \"kim@gmail.com\",\n \"phone\": \"010-2222-2222\",\n \"department\": \"우유배달학과\",\n \"state\": \"재학\",\n \"manageStatus\": {\n \"openingMeeting\": \"O\",\n \"firstDues\": \"O\",\n \"finalMeeting\": \"O\",\n \"secondDues\": \"O\"\n }\n },\n {\n \"id\": 3,\n \"studentId\": \"300300\",\n \"name\": \"park\",\n \"generation\": \"30\",\n \"contact\": \"kim@gmail.com\",\n \"phone\": \"010-2222-2222\",\n \"department\": \"우유배달학과\",\n \"state\": \"재학\",\n \"manageStatus\": {\n \"openingMeeting\": \"O\",\n \"firstDues\": \"O\",\n \"finalMeeting\": \"O\",\n \"secondDues\": \"O\"\n }\n }\n]"}],"_postman_id":"a25d034d-402f-47dd-a0ee-41f31c7a0f48"},{"name":"find","id":"aa0dd21d-db4e-468b-9709-0fa50c2647ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{develop}}/api/v1/member/1","description":"/api/v1/member/id에 해당하는 회원을 조회합니다.
400 존재하지 않는 회원 입니다.: url에 입력된 id에 해당하는 학생이 존재하지 않는 오류(id는 studentId와 다릅니다.)
/api/v1/member/id에 해당하는 회원을 삭제합니다.
400 존재하지 않는 회원 입니다.: url에 입력된 id에 해당하는 학생이 존재하지 않는 오류(id는 studentId와 다릅니다.)
회원을 저장합니다.
\n400 입력하지 않은 항목이 있습니다.: 필수입력항목이 빠졌을때 오류.400 이미 존재하는 회원입니다.: 다른 회원의 학번일 때 오류
studentId: 고유한 회원 학번 (필수)name: 이름 (필수)generation: 기수 (필수)phone: 전화번호contact: email등 전화번호 외 연락처department: 전공state: 학적상태
\n\n\n
재학,휴학,군휴학,졸업으로만 구분(default =재학)
manageStatus: 관리자 관리 영역
\n\n생략할경우 모두 default =
\nfalse
firstDues: 1학기 회비 납부 여부secondDues: 2학기 회비 납부 여부openingMeeting: 개총 참석 여부finalMeeting : 종총 참석 여부가장 간단한 요청 sample
\n{\n \"studentId\": \"170170\",\n \"name\": \"kimhanui\",\n \"generation\": \"30\"\n}\n/api/v1/member/id에 해당하는 회원을 수정합니다.
400 입력하지 않은 항목이 있습니다.: 필수 입력 항목이 빠졌을 때 오류.400 존재하지 않는 회원 입니다.: url에 입력된 id에 해당하는 학생이 존재하지 않는 오류(id는 studentId와 다릅니다.)400 이미 존재하는 학번입니다.: 다른 회원의 학번일 때 오류.
studentId: 고유한 회원 학번 (필수)name: 이름 (필수)generation: 기수 (필수)phone: 전화번호contact: email등 전화번호 외 연락처department: 전공state: 학적상태
\n\n\n
재학,휴학,군휴학,졸업으로 구분(default =재학)
manageStatus: 관리자 관리 영역
\n\n생략할경우 모두 default =
\nfalse
firstDues: 1학기 회비 납부 여부secondDues: 2학기 회비 납부 여부openingMeeting: 개총 참석 여부finalMeeting : 종총 참석 여부가장 간단한 요청 sample
\n{\n \"studentId\": \"170170\",\n \"name\": \"kimhanui\",\n \"generation\": \"30\"\n} \n회원 명부를 저장, 조회, 수정, 삭제합니다.
\n","_postman_id":"dc27ff54-fa0f-4295-a7ff-5f25c765900d"},{"name":"delay test","item":[{"name":"delay","id":"a9bc58f1-92ff-4333-9489-5ee5d34bd544","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{develop}}/api/v1/delay","urlObject":{"path":["api","v1","delay"],"host":["{{develop}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9bc58f1-92ff-4333-9489-5ee5d34bd544"}],"id":"90a07716-52ee-487e-9367-90fafbb30e5e","_postman_id":"90a07716-52ee-487e-9367-90fafbb30e5e","description":""}],"event":[{"listen":"prerequest","script":{"id":"f1f130c6-a643-4fa5-add1-471bcf9c495f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ea8b72c1-fb55-4eb5-ad45-bbd3e2dbccb6","type":"text/javascript","exec":[""]}}],"variable":[{"key":"{{develop}}","value":"https://interface-app-dev.herokuapp.com"}]}