Search
Duplicate

Room API

Search
담당자
진행상황
method
기능
URL
request header
response header
request
response
에러 코드
시작 전
POST
스터디 룸 등록
Open
/api/v1/rooms
Auth
{ ”data”:{ ”name” : “앨리스의 방”, ”price” : “6000”, ”address” : “서울특별시 서초구 도곡동 140-5”, ”size” : “2”, ”desc” : “이 방은 넓고 조용하고 커피가 무한 리필입니당!! 얼른 예약하세요”, ”equipment” : [ “1”, “2” ], } ”files” : [ “imageUrl.com”, “imageUrl.com” ] }
{ ”statusCode” : “201”, ”message” : “스터디 룸 등록에 성공했습니다” , ”data”: { ”data”:{ ”name” : “앨리스의 방”, ”price” : “6000”, ”address” : “서울특별시 서초구 도곡동 140-5”, ”size” : “2”, ”desc” : “이 방은 넓고 조용하고 커피가 무한 리필입니당!! 얼른 예약하세요”, ”equipment” : [ “1”, “2” ], } ”files” : [ “imageUrl.com”, “imageUrl.com” ] } }
400 유효하지 않은 요청 403 권한 없음
시작 전
PATCH
스터디 룸 정보 수정
Open
/api/v1/rooms/{roomsId}
Auth
{ ”name “ : “수정이후 방이름”, ”price” : “7000”, ”address” : “서울특별시 서초구 도곡동 140-5”, ”size” : “3”, ”desc” : “수정한 내용”, ”equipment”: [1,2,3] }
{ ”statusCode” : “201”, ”message” : “스터디 룸 등록에 성공했습니다” , ”data” : { ”name” : “수정 이후 방이름”, ”price” : “7000”, ”address” : “서울특별시 서초구 도곡동 140-5”, ”size” : “3”, ”desc” : “수정한 내용” } }
400 유효하지 않은 요청 403 권한 없음
시작 전
PATCH
방 이미지 수정
Open
/api/v1/rooms/{roomsId}/updateImages
Auth
{ ”data”: { ”removeImages”: [13,23,224] }, ”files”: $files }
{ ”statusCode” : “200”, ”message” : “이미지 변경에 성공했습니다”, ”data”:{ ”imageUrl”: [”imageUrl.com”, …] } }
400 유효하지 않은 요청 403 권한 없음
시작 전
GET
해당 스터디 룸 조회
Open
/api/v1/rooms/{roomsId}
Auth
{ ”statusCode” : “200”, ”message” : “스터디 룸 정보 조회에 성공했습니다”, ”data”: { ”name” : “앨리스의 방”, ”price” : “6000”, ”address” : “서울특별시 서초구 도곡동 140-5”, ”size” : “2”, ”desc” : “이 방은 넓고 조용하고 커피가 무한 리필입니당!! 얼른 예약하세요”, ”equipment” : [ “1”, “2” ], "isClosed”: false, ”image” : [ “imageUrl.com”, “imageUrl.com” ], ”reservatedTimeList”: [[’2021-04-01 08:00:00, 2021-04-01 09:00:00], […]], ”restScheduleList”: [[’2021-04-01 08:00:00, 2021-04-01 09:00:00], […]] } }
400 유효하지 않은 요청 403 권한 없음
시작 전
GET
스터디 룸 전체 필터 조회
Open
/api/v1/rooms
{ ”cursor”: 52 ”pageSize: 10, ”keyword”: “앨리스” ”price” : [7000, 50000], ”size” : [3,15], ”equipment”: [1,2,5,10], "latitude”: 33.1232, ”longitude”: 126.5703, ”searchLevel”: 6 }
{ ”statusCode” : “200”, ”message” : “스터디 룸 정보 조회에 성공했습니다”, ”data”: { ”roomsId” : 52, ”name”: “앨리스의 방”, ”price” : “6000”, ”address” : “서울특별시 서초구 도곡동 140-5”, ”size” : 2, ”isClosed”: false, "createdAt”: “2021-05-01 13:24:53”, ”image” : “imageUrl.com”, "latitude”: 33.1232, ”longitude”: 126.5703, ”searchDistance”: 100.0 } }
400 유효하지 않은 요청
시작 전
GET
등록한 룸 전체 조회
Open
/api/v1/rooms/host
Auth
{ ”keyword”: “앨리스” }
{ ”statusCode” : “200”, ”message” : “스터디 룸 정보 조회에 성공했습니다”, ”data”: { content[{ ”roomsId” : 52, ”name”: “앨리스의 방”, ”price” : “6000”, ”address” : “서울특별시 서초구 도곡동 140-5”, ”size” : 2, ”isClosed”: false, "createdAt”: “2021-05-01 13:24:53”, ”image” : [“imageUrl.com”, …], ”desc”: "상세하게 설명하자면 좋은 방입니다", equipment: [{options: [{id: 4, name: "선풍기"}, {id: 9, name: "전자렌지"}], …], reservatedTimeList: [[”2021-05-01 13:24:53”, “2021-05-01 13:24:53”], …], restScheduleList: [[”2021-05-01 13:24:53”, “2021-05-01 13:24:53”], …], }, … ], …pageableData }
400 유효하지 않은 요청 403 권한 없음
시작 전
PATCH
방 운영 여부 변경
Open
/api/v1/rooms/{roomsId}/updateIsClosed
Auth
{ ”statusCode” : “200”, ”message” : “스터디 룸 운영 여부 변경에 성공했습니다” }
400 유효하지 않은 요청 403 권한 없음
시작 전
DELETE
방 삭제
Open
/api/v1/rooms/{roomsId}
Auth
{ ”statusCode” : “200”, ”message” : “스터디 룸 삭제에 성공했습니다” }
400 유효하지 않은 요청 403 권한 없음
시작 전
GET
휴식 일정 조회
Open
/api/v1/rooms/{roomsId}/restschedule
Auth
{ ”statusCode” : “200”, ”message” : “휴식 일정 조회에 성공했습니다”, ”data”: { content[{ ”id” : 52, "startTime”: "2024-01-02 04:00:00”, ”endTime”: "2024-01-02 05:00:00” }, … ], …pageableData }
400 유효하지 않은 요청 403 권한 없음
시작 전
POST
휴식 일정 등록
Open
/api/v1/rooms/{roomsId}/restschedule
Auth
{ ”startDate” : “2023-10-19”, ”endDate” : “2023-10-19”, }
{ ”statusCode” : “201”, ”message” : “휴식 일정 등록에 성공했습니다” }
400 유효하지 않은 요청 403 권한 없음
시작 전
DELETE
휴식 일정 삭제
Open
/api/v1/rooms/{roomsId}/restschedule/{restscheduleId}
Auth
{ ”statusCode” : “200”, ”message” : “휴식 일정 삭제에 성공했습니다” }
400 유효하지 않은 요청 403 권한 없음