사이트 API
개요
사이트 API는 사이트(병원) 목록을 조회하는 기능을 제공합니다.
주요기능
- 사이트 목록 조회: 전체 사이트(병원) 목록 조회
[GET] /sites - 사이트 목록 조회
사이트 목록 조회
사이트(병원) 목록을 조회합니다.
- HTTP Method:
GET - 인증: 액세스 토큰 (
accessToken) 필요
Headers
| Header | Type | Description | Required |
|---|---|---|---|
| Authorization | Bearer {accessToken} | 사용자 인증을 통해 발급받은 액세스 토큰 입니다. | ✔ |
Request Body
N/A
Responses
| Http Status Code | 설명 | Error Code(s) |
|---|---|---|
200 OK | 조회 성공 | - |
401 Unauthorized | 인증 실패 | - |
200 OK - 성공
{
"data": [
{
"id": 1,
"name": "웰트병원",
"code": "3942303984",
"count": 10
}
]
}
| 필드 | 타입 | 설명 |
|---|---|---|
| data | array | 사이트 목록 |
| data[].id | number | 사이트 ID |
| data[].name | string | 사이트 이름 |
| data[].code | string | 사이트 코드 |
| data[].count | number | 해당 사이트의 환자 수 |
401 Unauthorized - 인증 실패
예시: 토큰이 누락된 경우
{
"status": 401,
"code": 40100,
"message": "Unauthorized",
"detail": ""
}