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

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

μš”μ²­

HTTP μš”μ²­

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

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

  • ν•„μˆ˜

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

  • 선택
ν•„λ“œλͺ… νƒ€μž… μ„€λͺ…
location String μ‘°νšŒν•  μ½”μŠ€μ˜ 지역 기반 ν•„ν„°μ˜ 기쀀이 될 μ§€μ—­μž…λ‹ˆλ‹€. μœ νš¨ν•œ 지역은 도, κ΄‘μ—­/νŠΉλ³„μ‹œμ˜ 영문 λͺ…μΉ­μž…λ‹ˆλ‹€. (예: "incheon")
cursor String μ‘°νšŒν•  νŽ˜μ΄μ§€μ˜ μ»€μ„œμž…λ‹ˆλ‹€. λˆ„λ½λ  경우 결과의 첫 번째 νŽ˜μ΄μ§€λ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.

λ³Έλ¬Έ

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

응닡

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

HTTP/1.1 200 OK
Content-Type: application/json
{
  "next_cursor": String,
  "courses": {
    {
      "course_id": Integer,
      "name": String,
      "address_sg": String,
      "duration_hours": Integer,
      "save_date": Date,
      "stops": {
        "count": Integer,
        "items": {
          {
            "sequence": Integer,
            "stop_id": Integer,
            "name": String,
            "type": String,
            "category": String,
            "start_date": Date,
            "end_date": Date
          },
          ...
        }
      } 
    },
    ...
  }
}

속성

ν•„λ“œλͺ… νƒ€μž… μ„€λͺ…
next_cursor String λ‹€μŒ νŽ˜μ΄μ§€μ˜ μ»€μ„œμž…λ‹ˆλ‹€. null일 경우 더 이상 μ‘°νšŒν•  κ²°κ³Όκ°€ μ—†μŒμ„ μ˜λ―Έν•©λ‹ˆλ‹€.
courses List 필터링 쑰건에 λΆ€ν•©ν•˜λŠ” μ—¬ν–‰ μ½”μŠ€λ“€μ˜ λͺ©λ‘μž…λ‹ˆλ‹€.
course_id Integer ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€μ˜ IDμž…λ‹ˆλ‹€.
name String ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€μ˜ μ΄λ¦„μž…λ‹ˆλ‹€.
address.sg String μ‹œ + ꡬ ν˜•νƒœλ‘œ μ œκ³΅λ˜λŠ” ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€κ°€ 진행될 μ§€μ—­μž…λ‹ˆλ‹€.
duration_hours Integer ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€μ˜ 총 μ†Œμš” μ‹œκ°„μž…λ‹ˆλ‹€.
save_date Date ("yyyy-MM-dd") ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€κ°€ μ—¬ν–‰ μœ„μ‹œλ¦¬μŠ€νŠΈμ— μΆ”κ°€λœ λ‚ μ§œμž…λ‹ˆλ‹€.
stops ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” μš”μ†Œλ“€μ„ λ‚˜νƒ€λƒ…λ‹ˆλ‹€.
stops.count Integer ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ“€μ„ κ΅¬μ„±ν•˜λŠ” μš”μ†Œμ˜ 총 κ°œμˆ˜μž…λ‹ˆλ‹€.
stops.items List ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ“€μ„ κ΅¬μ„±ν•˜λŠ” μš”μ†Œλ“€μ˜ λͺ©λ‘μž…λ‹ˆλ‹€.
stops.items.sequence Integer ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” μš”μ†Œμ˜ μˆœλ²ˆμž…λ‹ˆλ‹€.
stops.items.stop_id Integer ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” μš”μ†Œμ˜ IDμž…λ‹ˆλ‹€.
stops.items.name String ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” μš”μ†Œμ˜ μ΄λ¦„μž…λ‹ˆλ‹€.
stops.items.type String ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” μš”μ†Œμ˜ λŒ€λΆ„λ₯˜μž…λ‹ˆλ‹€. (예: μž₯μ†Œ)
stops.items.category String ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” μš”μ†Œμ˜ μ†ŒλΆ„λ₯˜μž…λ‹ˆλ‹€. (예: 카페)
stops.items.start_date Date("yyyy-MM-dd") ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” ν–‰μ‚¬μ˜ μ‹œμž‘μΌμž…λ‹ˆλ‹€. stops.items.type = eventκ°€ 아닐 경우 nullμž…λ‹ˆλ‹€.
stops.items.end_date Date("yyyy-MM-dd") ν•΄λ‹Ή μ—¬ν–‰ μ½”μŠ€λ₯Ό κ΅¬μ„±ν•˜λŠ” ν–‰μ‚¬μ˜ μ’…λ£ŒμΌμž…λ‹ˆλ‹€. stops.items.type = eventκ°€ 아닐 경우 nullμž…λ‹ˆλ‹€.

였λ₯˜

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

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