Skip to content

Anniversary

songz1 edited this page Jan 7, 2019 · 13 revisions

Anniversary

기념일 전체 목록 조회

메소드 경로 설명
GET /anniversary 기념일 전체 목록 조회

요청헤더

Content-Type :application/json 
Authorization: token

응답 바디

기념일 전체 목록 조회 성공

{
    "status": 200,
    "message": "기념일 조회 성공",
    "data": [
        {
            "anniversaryIdx": 1,
            "content": "지은 생일",
            "date": "1996-09-09T00:00:00",
            "anniversaryType": 0,
            "groupIdx": 2
        },
        {
            "anniversaryIdx": 2,
            "content": "늦둥이 생일",
            "date": "2018-12-09T00:00:00",
            "anniversaryType": 0,
            "groupIdx": 2
        }
    ]
}
Parameters
필드 타입 필수여부 설명
anniversaryIdx Int Required 기념일 고유 번호
content String Required 기념일 내용
date LocalDateTime Required 기념일 날짜
anniversaryType Int Required 기념일 타입
기본정보 생일 0 / 추가 생일 1 /
결혼기념일 2 / 기타 3
groupIdx Int Required 그룹 고유 번호

유효하지 않은 회원

{
    "status": 404,
    "message": "회원을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

기념일 추가

메소드 경로 설명
POST /anniversary/{anniversaryType} 기념일 추가
Parameters
필드 타입 필수여부 설명
anniversaryType Int Required 기념일 타입
추가 생일 1 / 결혼기념일 2 / 기타 3

요청헤더

Content-Type :application/json 
Authorization: token

요청 바디

  • 결혼기념일의 경우 content 생략
{
    "content": "댕댕이 생일",
    "dateStr": "2015-09-01T00:00:00"
}
필드 타입 필수여부 설명
content String Required 기념일 내용
dateStr String Required 기념일 날짜

응답 바디

기념일 추가 성공

{
    "status": 200,
    "message": "기념일 추가 성공",
    "data": null
}

잘못된 기념일 타입

{
    "status": 404,
    "message": "잘못된 기념일 타입입니다.",
    "data": null
}

유효하지 않은 회원의 접근

{
    "status": 404,
    "message": "회원을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

기념일 수정

메소드 경로 설명
PUT /anniversary/{anniversaryIdx} 기념일 수정
Parameters
필드 타입 필수여부 설명
anniversaryIdx Int Required 기념일 고유 번호

요청헤더

Content-Type :application/json 
Authorization: token

요청 바디

{
    "dateStr": "2017-09-01T00:00:00"
}
Parameters
필드 타입 필수여부 설명
dateStr String Required 기념일 날짜

응답 바디

기념일 수정 성공

{
    "status": 200,
    "message": "기념일 수정 성공",
    "data": null
}

잘못된 기념일 타입

{
    "status": 404,
    "message": "잘못된 기념일 타입입니다.",
    "data": null
}

존재하지 않는 기념일

{
    "status": 404,
    "message": "기념일을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

기념일 삭제

메소드 경로 설명
DELETE /anniversary 기념일 삭제

요청헤더

Content-Type :application/json 
Authorization: token

요청 바디

{
	"anniversaryIdx": [8, 12, 15]
}
Parameters
필드 타입 필수여부 설명
anniversaryIdx Int[] Required 기념일 고유 번호 배열

응답 바디

기념일 삭제 성공

{
    "status": 200,
    "message": "기념일 삭제 성공",
    "data": null
}

잘못된 기념일 타입

{
    "status": 404,
    "message": "잘못된 기념일 타입입니다.",
    "data": null
}

존재하지 않는 기념일

{
    "status": 404,
    "message": "기념일을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}