Skip to content

sections

Cupcakes33 edited this page Feb 17, 2026 · 1 revision

API: 수련부 (Section)

Domain: 수련부 관리
Base Path: /api/v1/sections

Note: 수련반(Division) 관리는 divisions.md를 참조하세요.


엔드포인트 목록

메서드 경로 설명 인증 필요
POST /sections 수련부 생성
GET /sections 수련부 목록 조회
PATCH /sections/{sectionId} 수련부 수정
DELETE /sections/{sectionId} 수련부 삭제
PATCH /sections/reorder 수련부 순서 변경

1. 수련부 생성

Endpoint: POST /api/v1/sections

설명: 새 수련부를 생성합니다.

Request:

POST /api/v1/sections?dojangId=0J5FX8XNCSRPS HTTP/1.1
Host: api.example.com
Cookie: accessToken=eyJhbGciOi...
Content-Type: application/json

{
  "name": "유소년부"
}

Query Parameters:

파라미터 타입 필수 설명
dojangId string 도장 ID

Request Body:

필드 타입 필수 설명
name string 수련부 이름

Response (200 OK):

{
  "id": "0J5GX1ABC1234",
  "name": "유소년부",
  "displayOrder": 1,
  "divisionCount": 0
}

2. 수련부 목록 조회

Endpoint: GET /api/v1/sections

설명: 도장의 수련부 목록을 displayOrder 순으로 조회합니다.

Request:

GET /api/v1/sections?dojangId=0J5FX8XNCSRPS HTTP/1.1
Host: api.example.com
Cookie: accessToken=eyJhbGciOi...

Query Parameters:

파라미터 타입 필수 설명
dojangId string 도장 ID

Response (200 OK):

{
  "sections": [
    {
      "id": "0J5GX1ABC1234",
      "name": "유소년부",
      "displayOrder": 1,
      "divisionCount": 3
    },
    {
      "id": "0J5GX2DEF5678",
      "name": "청소년부",
      "displayOrder": 2,
      "divisionCount": 2
    }
  ]
}

3. 수련부 수정

Endpoint: PATCH /api/v1/sections/{sectionId}

설명: 수련부 정보를 수정합니다.

Request:

PATCH /api/v1/sections/0J5GX1ABC1234?dojangId=0J5FX8XNCSRPS HTTP/1.1
Host: api.example.com
Cookie: accessToken=eyJhbGciOi...
Content-Type: application/json

{
  "name": "유소년부 (초등)"
}

Response (200 OK):

{
  "id": "0J5GX1ABC1234",
  "name": "유소년부 (초등)",
  "displayOrder": 1,
  "divisionCount": 3
}

4. 수련부 삭제

Endpoint: DELETE /api/v1/sections/{sectionId}

설명: 수련부를 삭제합니다.

Request:

DELETE /api/v1/sections/0J5GX1ABC1234?dojangId=0J5FX8XNCSRPS HTTP/1.1
Host: api.example.com
Cookie: accessToken=eyJhbGciOi...

Response (204 No Content): 본문 없음


5. 수련부 순서 변경

Endpoint: PATCH /api/v1/sections/reorder

설명: 수련부의 표시 순서를 변경합니다. 전달된 ID 목록의 순서대로 displayOrder가 부여됩니다.

Request:

PATCH /api/v1/sections/reorder?dojangId=0J5FX8XNCSRPS HTTP/1.1
Host: api.example.com
Cookie: accessToken=eyJhbGciOi...
Content-Type: application/json

{
  "sectionIds": ["0J5GX2DEF5678", "0J5GX1ABC1234"]
}

Request Body:

필드 타입 필수 설명
sectionIds string[] 수련부 ID 목록 (원하는 순서대로)

Response (204 No Content): 본문 없음

Clone this wiki locally