마이페이지 API - Yapp-17th/Android_2_Backend GitHub Wiki

Base URL

http://101.101.219.23/api/mypage-service/

View My-Profile

바텀 네비게이션으로 마이페이지 들어올 때

Request

  • url

    /v1/user/my-profile

  • method

    GET

  • header

    method parameter Description Required
    Authorization {{token}} access token O

Response

  • success response

    {
    "status": 200,
    "success": true,
    "message": "회원 프로필 조회 완료",
    "data": {
        "userId": 1,
        "isMine": true,
        "userName": "소연",
        "like": 0,
        "dislike": 0,
        "intro": "안녕하세요1",
        "category": [
            "축구"
        ],
        "city": "종로구"
    }
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 200 O
    success boolean 성공 여부 true O
    message String 성공 여부 true O
    data 회원 프로필 데이터 O
    data.userId Boolean 내 아이디 1 O
    data.isMine Boolean 내 프로필인지 여부 true O
    data.userName String 회원 닉네임 "짹짹" O
    data.like Long 회원 좋아요 수 53 O
    data.dislike Long 회원 싫어요 수 3 O
    data.intro String 회원 소개 O
    data.category String List 회원 관심 운동 종목 ["달리기", "축구", "배드민턴"] O
    data.city String 회원 주소 노원구 O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 마이페이지를 요청을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 마이페이지를 요청을 시도했을 경우
    404 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 마이페이지를 요청을 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Edit My Profile

Request

  • url

    /v1/user/my-profile

  • method

    PUT

  • header

    method parameter Description Required
    Content-Type application/json

  • request body

    {
    "userName": {{String}},
    "email": {{String}},
    "nickName": {{String}},
    "address": {{Long}},
    "category": [],
    "intro": {{Long}}
}
    Field Type Description Example Required
    userName String 카카오톡에서 받아오는 유저 이름 O
    email String 카카오톡에서 받아오는 유저 이메일 O
    nickName String 유저 닉네임(중복X) O
    address Long 위치 O
    category List 관심 종목 O
    intro String 자기소개 O

Response

  • success response

    • body

      {
    "status": 200,
    "success": true,
    "message": "회원 정보를 정상적으로 업데이트 했습니다."
}
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      message String 회원가입 성공 메세지 O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 회원 정보 수정을 시도했을 경우
    400 false "SIGN_UP_DUPLICATE" "동일한 이메일이 있습니다." 이미 같은 이메일이 존재할 경우
    400 false "SIGN_UP_DUPLICATE" "동일한 닉네임이 있습니다." 이미 같은 닉네임을 가지고 있는 사용자가 있을 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." PUT가 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

View Profile

채팅이나 게시글을 통해 마이페이지 조회할 경우

Request

  • url

    /v1/user/{userId}/profile

  • method

    GET

  • header

    method parameter Description Required
    Authorization {{token}} access token O

  • path params

    variable type Description Required
    userId Long 히스토리 조회 유저 아이디 O

Response

  • success response

    {
  "status": 200,
  "success": true,
  "message": "회원 프로필 조회 완료",
  "data": {
    "userId": 2,
    "isMine": false,
    "userName": "민호",
    "like": 0,
    "dislike": 0,
    "intro": "안녕하세요2",
    "category": [
        "농구",
        "축구"
    ],
    "city": "종로구"
  }
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 200 O
    success boolean 성공 여부 true O
    message String 성공 메세지 O
    data 회원 프로필 데이터 O
    data.userId Long 회원 아이디 O
    data.isMine Boolean 내 프로필인지 여부 true, false O
    data.userName String 회원 닉네임 "짹짹" O
    data.like Long 회원 좋아요 수 53 O
    data.dislike Long 회원 싫어요 수 3 O
    data.intro String 회원 소개 O
    data.category String List 회원 관심 운동 종목 ["달리기", "축구", "배드민턴"] O
    data.city String 회원 주소 노원구 O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 사용자 조회 요청 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 사용자 조회 요청 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 프로필 조회 요청 시도되는 사용자가 유효하지 않은 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

View My History

내 프로필에서 히스토리 누를 경우

image

Request

  • url

    /v1/user/my-profile/history?type=continue

  • method

    GET

  • header

    method parameter Description Required
    Authorization {{token}} access token O

  • query params

    variable type Description Required
    type String 히스토리 타입(default: "continue"), 종류: "continue", "complete"

Response

  • success response

    • body

      {
    "status": 200,
    "success": true,
    "message": "히스토리 조회 성공",
    "type": "continue",
    "data": [
        {
            "isHost": false,
            "userName": "소연",
            "isContinue": false,
            "leftTime": "[D-329]",
            "boardInfo": {
                "boardId": 4,
                "hostId": 3,
                "hostName": "해민",
                "title": "제목4",
                "groupStatus": "모집 중",
                "exercise": "농구",
                "city": "중구",
                "isBookMark": true,
                "recruitNumber": 2,
                "recruitedNumber": 0,
                "time": "[D-329]"
            }
        },
        {
            "isHost": false,
            "userName": "소연",
            "isContinue": false,
            "leftTime": "[D-329]",
            "boardInfo": {
                "boardId": 5,
                "hostId": 3,
                "hostName": "해민",
                "title": "제목5",
                "groupStatus": "모집 중",
                "exercise": "테니스",
                "city": "용산구",
                "isBookMark": true,
                "recruitNumber": 2,
                "recruitedNumber": 1,
                "time": "[D-329]"
            }
        },
        ...
    ]
}
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      message String 게시판 조회 성공 메세지 O
      type String 히스토리 타입 "continue", "complete" O
      data List 히스토리 정보 리스트 O
      data.isHost Boolean 호스트 여부 true O
      data.userName String 내 닉네임 "짹짹" O
      data.isContinue Boolean 진행중 여부 true O
      data.leftTime String 날짜/남은 시간, 진행중 여부가 true일 경우는 남은 시간, false일 경우는 모임이 진행된 날짜 표시 "D-Day" O
      data.boardInfo 히스토리 게시판 정보 O
      data.boardInfo.boardId Long 히스토리 게시판 번호 1 O
      data.boardInfo.hostId Long 히스토리 게시판 번호 1 O
      data.boardInfo.hostName Long 히스토리 게시판 번호 1 O
      data.boardInfo.title String 게시판 제목 "같이 중랑천 달리실 분!" O
      data.boardInfo.groupStatus String 게시판 state "참여중" O
      data.boardInfo.exercise String 모집 운동 카테고리 "축구" O
      data.boardInfo.city String 모집 위치 "강남구" O
      data.boardInfo.recruitNumber Integer 모집 총 인원 5 O
      data.boardInfo.recruitedNumber Integer 승인 인원 3 O
      data.boardInfo.time String 날짜/남은 시간 --> 중복이라 나중에 고치겠습니다,,, 3 O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 히스토리 조회 요청 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 히스토리 조회 요청 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 히스토리 조회 요청 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

View Others History

Request

  • url

    /v1/user/{userId}/profile/history

  • method

    GET

  • header

    method parameter Description Required
    Authorization {{token}} access token O

  • path params

    variable type Description Required
    userId Long 히스토리 조회 유저 아이디 O

Response

  • success response

    • body

      {
    "status": 200,
    "success": true,
    "message": "히스토리 조회 성공",
    "type": "complete",
    "data": [
        {
            "isHost": false,
            "userName": "민호",
            "isContinue": true,
            "leftTime": "[9/19]",
            "boardInfo": {
                "boardId": 1,
                "hostId": 1,
                "hostName": "소연",
                "title": "제목1",
                "groupStatus": "활동 종료",
                "exercise": "축구",
                "city": "종로구",
                "isBookMark": true,
                "recruitNumber": 2,
                "recruitedNumber": 2,
                "time": "[9/19]"
            }
        },
        ...
    ]
}
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      message String 게시판 조회 성공 메세지 O
      type String 히스토리 타입 항상 "complete" O
      data List 히스토리 정보 리스트 O
      data.isHost Boolean 호스트 여부 true O
      data.userName String 상대방 닉네임 "짹짹" O
      data.isContinue Boolean 진행중 여부 항상 false O
      data.leftTime String 모임 진행 날짜 "10/11"
      data.boardInfo 히스토리 게시판 정보 O
      data.boardInfo.boardId Long 히스토리 게시판 번호 1 O
      data.boardInfo.hostId Long 히스토리 게시판 번호 1 O
      data.boardInfo.hostName String 히스토리 게시판 번호 1 O
      data.boardInfo.title String 게시판 제목 "같이 중랑천 달리실 분!" O
      data.boardInfo.groupStatus String 게시판 state 항상 "참여 완료" O
      data.boardInfo.exercise String 모집 운동 카테고리 "축구" O
      data.boardInfo.city String 모집 위치 "강남구" O
      data.boardInfo.recruitNumber Integer 모집 총 인원 5 O
      data.boardInfo.recruitedNumber Integer 승인 인원 3 O
      data.boardInfo.time String 모임 진행 날짜 --> 이것도 중복... O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 히스토리 조회 요청 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 히스토리 조회 요청 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 히스토리 조회 요청 시도되는 사용자가 데이터베이스에 없을 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

View My BookMarks

Request

  • url

    /v1/user/my-profile/bookmark

  • method

    GET

  • header

    method parameter Description Required
    Authorization {{token}} access token O

Response

  • success response

    • body

      {
    "status": 200,
    "success": true,
    "message": "북마크 조회 성공",
    "data": [
        {
            "boardId": 3,
            "hostId": 2,
            "hostName": "민호",
            "title": "제목3",
            "groupStatus": "활동 종료",
            "exercise": "농구",
            "city": "중구",
            "isBookMark": true,
            "recruitNumber": 2,
            "recruitedNumber": 2,
            "time": "[9/19]"
        },
        ...
    ]
}
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      message String 게시판 조회 성공 메세지 O
      data List 북마크 정보 리스트 O
      data.boardId Long 게시판 번호 1 O
      data.hostId Long 호스트 번호 1 O
      data.hostName String 호스트 닉네임 "짹짹" O
      data.title String 게시판 제목 "같이 중랑천 달리실 분!" O
      data.groupStatus String 게시판 state "모집중" O
      data.exercise String 모집 운동 카테고리 "축구" O
      data.city String 모집 위치 "강남구" O
      data.isBookMark Boolean 북마크 여부 true O
      data.recruitNumber Integer 총 모집 인원 수 3 O
      data.recruitedNumber Integer 참여 인원 수 3 O
      data.time String 시간 "10/11" O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 북마크 조회 요청 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 북마크 조회 요청 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 북마크 조회 요청 시도하는 사람이 데이터베이스에 없는 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

View Apply List

my-history의 진행중 탭에서 본인이 host일 경우 더보기 탭

Request

  • url

    /v1/user/my-profile/history/{boardId}/applied

  • method

    GET

  • header

    method parameter Description Required
    Authorization {{token}} access token O

  • path params

    variable type Description Required
    boardId Long 글 번호 O

Response

  • success response

    {
    "status": 200,
    "success": true,
    "message": "신청자 리스트 조회 성공",
    "data": [
        {
            "hostId": 1,
            "guestId": 3,
            "guestName": "해민",
            "isHost": false,
            "applyStatus": {
                "code": 2,
                "name": "참여중"
            },
            "chattingRoomId": 2
        },
        ...
    ]
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 200 O
    success boolean 성공 여부 true O
    message String 게시판 조회 성공 메세지 O
    data List 유저 신청 리스트 O
    data.hostId Long 호스트 번호 1 O
    data.guestId Long 게스트 번호 2 O
    data.guestName String 유저 닉네임 "짹짹" O
    data.isHost Boolean 호스트 여부 항상 false O
    data.applyStatus 유저 신청 상황 O
    data.applyStatus.code Integer 0, 1, 2 O
    data.applyStatus.name String "pending", "참여대기중", "참여" O
    data.chattingRoomId Long 채팅방 아이디 O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 신청 리스트 조회를 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 신청 리스트 조회를 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 신청 리스트 조회를 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "BOARD_NOT_FOUND" "게시글을 찾을 수 없습니다." 신청 리스트 조회에 연결된 게시글이 삭제된 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

View Evaluate List

my-history의 활동 완료 탭에서 평가하기 탭

Request

  • url

    /v1/user/my-profile/history/{boardId}/evaluate

  • method

    GET

  • header

    method parameter Description Required
    Authorization {{token}} access token O

  • path params

    variable type Description Required
    boardId Long 글 번호 O

Response

  • success response

    {
    "status": 200,
    "success": true,
    "message": "평가 리스트 조회 성공"
    "data": [
        {
            "userId": 1,
            "userName": "짹짹",
            "isHost": true,
            "isLike": false,
            "isDislike": false
        },
        {
            "userId": 2,
            "userName": "퐁퐁달퐁",
            "isHost": false,
            "isLike": false,
            "isDislike": false
          }
      ]
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 200 O
    success boolean 성공 여부 true O
    message String 게시판 조회 성공 메세지 O
    data List 유저 신청 리스트 O
    data.userId Long 유저 번호 1 O
    data.userName String 유저 닉네임 "짹짹" O
    data.isHost Boolean 호스트 여부 항상 false O
    data.isLike Boolean 좋아요 여부 O
    data.isDislike Boolean 싫어요 여부 O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 평가 리스트 조회를 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 평가 리스트 조회를 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 평가 리스트 조회를 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "EVALUATE_IMPOSSIBLE" "아직 평가를 진행할 수 없습니다." 경기가 끝나지 않아 평가 리스트 조회할 수 없는 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Evaluate Like/DisLike

Request

  • url

    /v1/user/my-profile/history/{boardId}/evaluate/{userId}?isLike=true

  • method

    PUT

  • header

    method parameter Description Required
    Authorization {{token}} access token O

  • path params

    variable type Description Required
    boardId Long 평가할 게시판 번호 O
    userId Long 평가할 유저 번호 O

  • query params

    variable type Description Required
    isLike Boolean 좋아요 여부(default:true), 종류: true, false

Response

  • success response

    • body

      {
    "status": 200,
    "success": true,
    "message": "평가가 정상적으로 저장 되었습니다."
}
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      message String 평가 저장 성공 메세지 O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 평가 작성을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 평가 작성을 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 평가 작성을 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "BOARD_NOT_FOUND" "게시글을 찾을 수 없습니다" 평가 게시글이 없는 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." PUT가 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Evaluate Report

Request

  • url

    /v1/user/my-profile/history/evaluate/report

  • method

    POST

  • header

    method parameter Description Required
    Authorization {{token}} access token O

  • request body

    {
    "userId": 1,
    "reportType": 7,
    "content": "그냥"
}
    Field Type Description Example Required
    userId Long 신고된 유저 번호 O
    reportType Long 신고 타입(기타일 경우 content 필수) O
    content String 신고 내용

Response

  • success response

    • body

      {
    "status": 200,
    "success": true,
    "message": "신고가 정상적으로 접수 되었습니다."
}
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      message String 평가 저장 성공 메세지 O

  • fail response

    {
    "status":{{Integer}},
    "success": {{Boolean}},
    "responseType": {{String}},
    "message": {{String}}
}
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 신고 작성을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 신고 작성을 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 신고 작성을 시도하는 사용자, 또는 신고 당하는 사용자가 데이터베이스에 없을 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." POST가 아닌 다른 메소드로 요청한 경우, request body가 올바르지 않은 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류
⚠️ **GitHub.com Fallback** ⚠️