API 명세서 샘플

Request Sample - 1 : 유효성 체크 및 존재 확인 성공

{ "userEmail" : "smegyeong@gmail.com" }
JSON
복사

Response Sample - 1

{ "isSuccess": true, "responseCode": 1000, "message": "요청에 성공하였습니다", "result": "smegyeong@gmail.com", "httpStatus": "OK" }
JSON
복사

Request Sample - 2 : 유효성 체크 실패

{ "userEmail" : "smegyeong@gmailcom" }
JSON
복사

Response Sample - 2

{ "isSuccess": false, "responseCode": 4003, "message": "유효하지 않는 이메일 형식입니다", "result": false, "httpStatus": "BAD_REQUEST" }
JSON
복사

Request Sample - 3 : 존재하지 않는 사용자

{ "userEmail" : "simmigyeong@gmail.com" }
JSON
복사

Response Sample - 3

{ "isSuccess": false, "responseCode": 4004, "message": "존재하지 않는 사용자입니다", "result": false, "httpStatus": "NOT_FOUND" }
JSON
복사
유효성 체크 및 존재 확인이 성공하여 Response 로 전달되는 userEmail 을 리스트에 추가 후스터디 그룹 생성 API 호출 시 전달
Search
Header (2)
Name
Type
Mandatory
Example
Description
String
N
eyJ0eXBlIjoiand0IiwiYWxnIjoiSFMyNTYifQ.eyJ1c2VySWQiOjIsImlhdCI6MTY1OTg5MjM4OCwiZXhwIjoxNjU5ODk5NTg4fQ._vs62Hoc8dOGGXAAXwwWgnVg2TMsJ59_pM1UlbvXgLM
AccessToken
COUNT1
Search
Name
Type
Mandatory
Example
Default
Description
String
Y
초대하고자 하는 사용자 이메일
COUNT1
Search
Name
Type
Description
COUNT0
Search
Name
Type
Value
COUNT0

Response

Search
HttpStatus
Code
Error Type
Message
Description
401 Unauthorized
0
Request
Access Token이 없는 경우
401 Unauthorized
0
Request
유효기간이 만료된 Refresh Token
409 Conflict
0
Request
유효하지 않은 Access Token