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

API λͺ…μ„Έ - μ—¬ν–‰ μœ„μ‹œλ¦¬μŠ€νŠΈμ— μΆ”κ°€ν•œ μ—¬ν–‰ μ½”μŠ€ 상세 쑰회 API

μš”μ²­

HTTP μš”μ²­

GET /api/v2/member/outing-wishlist/outing-courses/{outingCourseId}

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

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

경둜 λ³€μˆ˜

ν•„λ“œλͺ… μ„€λͺ…
outingCourseId μ‘°νšŒν•  μ—¬ν–‰ μ½”μŠ€μ˜ IDμž…λ‹ˆλ‹€.

λ³Έλ¬Έ

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

응닡

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

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

{
  "course_id": Integer,
  "name": String,
  "duration_hours": Integer,
  "stops": {
    "count": Integer,
    "items": {
      "sequence": Integer,
      "stop_id": Integer,
      "name": String,
      "type": String,
      "category": String,
      "coordinate": {
        "lat": Float,
        "lng": Float
      },
      "is_available": Boolean
    }
  }
}

속성

ν•„λ“œλͺ… μ„€λͺ…
course_id μ‘°νšŒν•  μ—¬ν–‰ μ½”μŠ€μ˜ IDμž…λ‹ˆλ‹€.
name ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€μ˜ μ΄λ¦„μž…λ‹ˆλ‹€.
duration_hours ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€μ˜ 총 μ†Œμš”μ‹œκ°„μž…λ‹ˆλ‹€.
stops ν•΄λ‹Ή μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” κ²½μœ μ§€λ“€μ„ λ‚˜νƒ€λƒ…λ‹ˆλ‹€.
stops.count ν•΄λ‹Ή μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” κ²½μœ μ§€μ˜ 총 κ°œμˆ˜μž…λ‹ˆλ‹€.
stops.items κ²½μœ μ§€λ“€μ˜ λͺ©λ‘μž…λ‹ˆλ‹€.
stops.items.sequence ν•΄λ‹Ή μ½”μŠ€μƒ ν•΄λ‹Ή κ²½μœ μ§€μ˜ μˆœλ²ˆμž…λ‹ˆλ‹€.
stops.items.stop_id ν•΄λ‹Ή κ²½μœ μ§€μ˜ IDμž…λ‹ˆλ‹€. μž₯μ†ŒμΈ 경우 μž₯μ†Œ ID, 행사인 경우 행사 IDλ₯Ό λ‚˜νƒ€λƒ…λ‹ˆλ‹€.
stops.items.name ν•΄λ‹Ή κ²½μœ μ§€μ˜ μ΄λ¦„μž…λ‹ˆλ‹€.
stops.items.type ν•΄λ‹Ή κ²½μœ μ§€μ˜ λΆ„λ₯˜μž…λ‹ˆλ‹€. place, event 쀑 ν•˜λ‚˜μž…λ‹ˆλ‹€.
stops.items.category ν•΄λ‹Ή κ²½μœ μ§€μ˜ μ„ΈλΆ€ λΆ„λ₯˜μž…λ‹ˆλ‹€.
stops.items.coordinate ν•΄λ‹Ή κ²½μœ μ§€κ°€ μœ„μΉ˜ν•œ 곳의 μ’Œν‘œ μ •λ³΄μž…λ‹ˆλ‹€.
stops.items.coordinate.lat ν•΄λ‹Ή κ²½μœ μ§€κ°€ μœ„μΉ˜ν•œ 곳의 μœ„λ„μž…λ‹ˆλ‹€.
stops.items.coordinate.lng ν•΄λ‹Ή κ²½μœ μ§€κ°€ μœ„μΉ˜ν•œ 곳의 κ²½λ„μž…λ‹ˆλ‹€.
stops.items.is_available ν•΄λ‹Ή κ²½μœ μ§€κ°€ ν˜„μž¬ 이용 κ°€λŠ₯ν•œμ§€μ˜ μ—¬λΆ€λ₯Ό λ‚˜νƒ€λƒ…λ‹ˆλ‹€.

였λ₯˜

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

μœ ν˜• 세뢀정보 μ„€λͺ…
401 INVALID_TOKEN μš”μ²­μ˜ Authorization ν—€λ”μ˜ Bearer 토큰이 μœ νš¨ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.
404 OUTING_COURSE_NOT_FOUND μš”μ²­μ—μ„œ 제곡된 μ—¬ν–‰ μ½”μŠ€ IDκ°€ μœ νš¨ν•˜λ‚˜ μ—¬ν–‰ μ½”μŠ€ IDκ°€ κ°€λ¦¬ν‚€λŠ” μ—¬ν–‰ μ½”μŠ€λ₯Ό 찾을 수 μ—†μŠ΅λ‹ˆλ‹€.
422 INVALID_OUTING_COURSE_ID μš”μ²­μ—μ„œ 제곡된 μ—¬ν–‰ μ½”μŠ€ IDκ°€ μœ νš¨ν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.