v2_apidocs_outingwishlist_readeventlist - 100-hours-a-week/KTB4-8th-BE GitHub Wiki

API λͺ…μ„Έ - μ—¬ν–‰ μœ„μ‹œλ¦¬μŠ€νŠΈμ— μΆ”κ°€ν•œ 행사 λͺ©λ‘ 쑰회 API

μš”μ²­

HTTP μš”μ²­

GET /api/v2/member/outing-wishlist/events

λ§€κ°œλ³€μˆ˜

  • ν•„μˆ˜

이 λ©”μ†Œλ“œλŠ” μš”μ²­ μ‹œ ν•„μˆ˜λ‘œ μš”κ΅¬ν•˜λŠ” νŒŒλΌλ―Έν„°κ°€ μ—†μŠ΅λ‹ˆλ‹€.

  • 선택
ν•„λ“œλͺ… νƒ€μž… μ„€λͺ…
ongoing Boolean ν˜„μž¬ 운영 쀑인 ν–‰μ‚¬λ§Œ μ‘°νšŒν•  μ§€μ˜ μ—¬λΆ€μž…λ‹ˆλ‹€.
cursor String μ‘°νšŒν•  νŽ˜μ΄μ§€μ˜ μ»€μ„œμž…λ‹ˆλ‹€. λˆ„λ½λ  경우 결과의 첫 번째 νŽ˜μ΄μ§€λ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.

λ³Έλ¬Έ

이 λ©”μ†Œλ“œλŠ” μš”μ²­ 본문을 λ”°λ‘œ ν•„μš”λ‘œ ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.

응닡

μš”μ²­μ— 성곡할 경우 이 λ©”μ†Œλ“œλŠ” λ‹€μŒκ³Ό 같은 ꡬ쑰의 응닡을 λ°˜ν™˜ν•©λ‹ˆλ‹€.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "next_cursor": String,
  "events": {
    {
      "event_id": Integer,
      "name": String,
      "category": String,
      "description": String,
      "start_date": Date,
      "end_date": Date,
      "place" : {
        "name": String,
        "address_sg": String
      }
    },
    ...
  }
}

속성

ν•„λ“œλͺ… νƒ€μž… μ„€λͺ…
next_cursor String λ‹€μŒ νŽ˜μ΄μ§€μ˜ μ»€μ„œμž…λ‹ˆλ‹€. null일 경우 더 이상 μ‘°νšŒν•  κ²°κ³Όκ°€ μ—†μŒμ„ μ˜λ―Έν•©λ‹ˆλ‹€.
events List 필터링 쑰건에 λΆ€ν•©ν•˜λŠ” ν–‰μ‚¬λ“€μ˜ λͺ©λ‘μž…λ‹ˆλ‹€.
event_id Integer ν•΄λ‹Ή ν–‰μ‚¬μ˜ IDμž…λ‹ˆλ‹€.
name String ν•΄λ‹Ή ν–‰μ‚¬μ˜ μ΄λ¦„μž…λ‹ˆλ‹€.
category String ν•΄λ‹Ή ν–‰μ‚¬μ˜ μ„ΈλΆ€ λΆ„λ₯˜μž…λ‹ˆλ‹€. 예) νŒμ—… μŠ€ν† μ–΄
description String AIκ°€ μ œκ³΅ν•˜λŠ” ν•΄λ‹Ή ν–‰μ‚¬μ˜ μš”μ•½ μ •λ³΄μž…λ‹ˆλ‹€.
start_date Date ("yyyy-MM-dd") ν•΄λ‹Ή 행사가 μ‹œμž‘ν•˜λŠ” λ‚ μ§œμž…λ‹ˆλ‹€.
end_date Date ("yyyy-MM-dd") ν•΄λ‹Ή 행사가 μ’…λ£Œν•˜λŠ” λ‚ μ§œμž…λ‹ˆλ‹€.
place ν•΄λ‹Ή 행사가 κ°œμ΅œλ˜λŠ” μž₯μ†Œλ₯Ό λ‚˜νƒ€λƒ…λ‹ˆλ‹€.
place.name String ν•΄λ‹Ή 행사가 κ°œμ΅œλ˜λŠ” μž₯μ†Œμ˜ μ΄λ¦„μž…λ‹ˆλ‹€.
place.address_sg String μ‹œ + ꡬ ν˜•νƒœλ‘œ μ œκ³΅λ˜λŠ” ν•΄λ‹Ή 행사가 κ°œμ΅œλ˜λŠ” μž₯μ†Œμ˜ μ£Όμ†Œμž…λ‹ˆλ‹€.

였λ₯˜

λ‹€μŒ ν‘œλŠ” 이 λ©”μ†Œλ“œμ— λŒ€ν•œ ν˜ΈμΆœμ— λŒ€ν•œ μ‘λ‹΅μœΌλ‘œ APIκ°€ λ°˜ν™˜ν•  수 μžˆλŠ” 였λ₯˜λ“€μ˜ μ •λ³΄μž…λ‹ˆλ‹€.

μœ ν˜• 세뢀정보 μ„€λͺ…
401 INVALID_TOKEN μš”μ²­μ˜ Authorization ν—€λ”μ˜ Bearer 토큰이 μœ νš¨ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.
404 PAGE_NOT_FOUND μš”μ²­μ—μ„œ μ œκ³΅ν•œ μ»€μ„œλŠ” μœ νš¨ν•˜λ‚˜ μ»€μ„œκ°€ κ°€λ¦¬ν‚€λŠ” 쑰회 κ²°κ³Ό νŽ˜μ΄μ§€λ₯Ό 찾을 수 μ—†μŠ΅λ‹ˆλ‹€.
422 INVALID_FILTER μš”μ²­μ—μ„œ μ œκ³΅ν•œ ν•„ν„° 쑰건이 μœ νš¨ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.
422 INVALID_CURSOR μš”μ²­μ—μ„œ μ œκ³΅ν•œ μ»€μ„œκ°€ μœ νš¨ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.