Skip to content

API Docs ‐ Reservation(admin)

Jump to bottom
6suhyeon edited this page Jul 28, 2024 · 6 revisions

API Documentation

Endpoints

1. Get Reservation All

- 메뉴 전체조회`

- type -정렬기준 : "reserve" 또는 "cancel" 또는 "complete"

  • Endpoint: /admin/reservation/{type}/booth/{boothId}

  • Method: GET

  • Request: None

  • Response:

    • success : Boolean
    • message : String
    • reservationInfo (totalNum, isReservation, reservationList)
      • totalNum: Integer
      • isReservation: Boolean
      • reservationList(reservationNum, reservationId, userName, personCount, phoneNum, updateAt)
        • reservationNum : Integer
        • reservationId : UUID
        • userName : String
        • personCount : Integer
        • phoneNum : String
        • updateAt : LocalDateTime

  • Response Example:

  • 성공

{
    "reservationInfo": {
        "totalNum": 9,
        "isReservation": true,
        "reservationList": [
            {
                "reservationNum": 1,
                "reservationId": "2b46fb7b-7720-4f2e-8051-ba930f1db4dd",
                "userName": "dd2",
                "personCount": 22,
                "phoneNum": "13231231212",
                "updateAt": "2024-07-14T13:10:17.991527",
                "isCancel": false
            },
            {
                "reservationNum": 2,
                "reservationId": "104ddc20-21b6-43be-9c01-d5aeb94d0b4e",
                "userName": "이희연",
                "personCount": 3,
                "phoneNum": "01011111111",
                "updateAt": "2024-07-17T16:18:09.00781",
                "isCancel": false
            },
           "..."
        ]
    },
    "success": true,
    "message": "예약 전체조회 성공"
}
  • 실패
{
    "reservationInfo": null,
    "success": false,
    "message": "예약 전체조회 시 DAO 검색 실패"
}

2. Delete Reservation

- 예약 삭제

  • Endpoint: /admin/reservation
  • Method: DELETE
  • Request:
    • boothId : UUID
    • reservationId : UUID
    • reservationType : ReservationEnum
  • Request Example:
{
    "boothId" : "4c0fdc4d-4a3d-4ba7-acc3-0d5d46d7f6f1"
    "reservationId" : "af0f93f8-60ec-41d9-b041-3de8f3d67f8a"
    "reservationType" : "RESERVE"
}
  • Response:
    • success : Boolean
    • message : String
    • deleteInfo (reservationId, reservationType, messageStatus)
      • reservationId: UUID (unique)
      • reservationType: reservationEnum
      • messageStatus: String
  • Response Example:
  • 성공
{
    "deleteInfo": {
        "reservationId": "295e9a70-2614-48a2-829d-471ed418047b",
        "reservationType": "CANCEL",
        "messageStatus": "SEND_SUCCESS"
    },
    "success": true,
    "message": "예약 삭제 성공"
}
  • 실패
{
    "success": false,
    "message": "에약 삭제 시 DAO 저장 실패",
    "deleteInfo": null
}

3. Update Reservation Complete

- 예약 완료

  • Endpoint: /admin/reservation/complete
  • Method: PUT
  • Request:
    • boothId : UUID
    • reservationId : UUID
    • reservationType : ReservationEnum
  • Request Example:
{
    "boothId" : "4c0fdc4d-4a3d-4ba7-acc3-0d5d46d7f6f1"
    "reservationId" : "af0f93f8-60ec-41d9-b041-3de8f3d67f8a"
    "reservationType" : "RESERVE"
}
  • Response:
    • success : Boolean
    • message : String
    • deleteInfo (reservationId, reservationType, messageStatus)
      • reservationId: UUID (unique)
      • reservationType: ReservationEnum
      • messageStatus: String
  • Response Example:
  • 성공
{
    "success": true,
    "message": "예약 완료 성공",
    "completeInfo": {
        "reservationId": "e65ec911-547a-4204-8db6-1e02923c7cbb",
        "reservationType": "COMPLETE"
        "messageStatus": "SEND_SUCCESS"
    }
}
  • 실패
{
    "success": false,
    "message": "에약 완료 시 DAO 저장 실패",
    "completeInfo": null
}

4. Update Reservation Restore

- 예약 복구

  • Endpoint: /admin/reservation/restore
  • Method: PUT
  • Request:
    • boothId : UUID
    • reservationId : UUID
    • reservationType : ReservationEnum
  • Request Example:
{
    "boothId" : "4c0fdc4d-4a3d-4ba7-acc3-0d5d46d7f6f1"
    "reservationId" : "af0f93f8-60ec-41d9-b041-3de8f3d67f8a"
    "reservationType" : "CANCEL"
}
  • Response:
    • success : Boolean
    • message : String
    • restoreInfo (reservationId, reservationType)
      • reservationId: UUID
      • reservationType: ReservationEnum
  • Response Example:
  • 성공
{
    "success": true,
    "restoreInfo": {
        "reservationId": "e65ec911-547a-4204-8db6-1e02923c7cbb",
        "reservationType": "RESERVE"
    },
    "message": "예약 복구 성공"
}
  • 실패
{
    "success": false,
    "message": "에약 복구 중 DAO 저장 실패",
    "restoreInfo": null
}

5. Update Reservation

- 예약 가능여부 수정

  • Endpoint: /admin/reservation
  • Method: PUT
  • Request:
    • boothId : UUID
    • isReservation : Boolean
  • Request Example:
{
    "boothId" : "4c0fdc4d-4a3d-4ba7-acc3-0d5d46d7f6f1"
    "isReservation" : true
}
  • Response:
    • success : Boolean
    • message : String
    • reservationInfo (boothId, isReservation)
      • boothId: UUID (unique)
      • isReservation: Boolean
  • Response Example:
  • 성공
{
    "reservationInfo": {
        "boothId": "4c0fdc4d-4a3d-4ba7-acc3-0d5d46d7f6f1",
        "isReservation": false
    },
    "success": true,
    "message": "예약 가능여부 수정 성공"
}
  • 실패
{
    "reservationInfo": null,
    "success": false,
    "message": "예약 가능여부 수정 시 DAO 저장 실패"
}

Clone this wiki locally