그룹 조회 API (Go)

참고: 이 문서에 설명된 모든 API는 dta-wir-medi-api 애플리케이션에 구현되어 있습니다. (Go)

개요

그룹 조회 API는 등록된 그룹 정보를 조회하는 기능을 제공합니다.

주요기능

• 그룹 목록 조회: 특정 사이트의 그룹 목록 조회

[GET] /v1/groups - 그룹 목록 조회

그룹 목록 조회

특정 사이트에 속한 그룹(환자 그룹 등) 목록을 조회합니다.

• HTTP Method: GET
• 인증: 액세스 토큰 (accessToken) 필요

Headers

Header	Type	Description	Required
Authorization	Bearer {accessToken}	사용자 인증을 통해 발급받은 액세스 토큰 입니다.	✔

Query Parameters

필드	타입	설명	Required
siteId	number	사이트 ID	✔

Request 예시

GET /v1/groups?siteId=1

Responses

Http Status Code	설명	Error Code(s)
200 OK	조회 성공	-
401 Unauthorized	인증 실패	UNAUTHORIZED (40100)
500 Internal Server Error	서버 내부 오류	INTERNAL_SERVER_ERROR (50000)

200 OK - 성공

{
  "data": [
    {
      "id": 1,
      "name": "patients",
      "description": "환자 그룹"
    },
    {
      "id": 2,
      "name": "researchers",
      "description": "연구자 그룹"
    }
  ]
}

필드	타입	설명
data	array	그룹 목록

data 배열의 각 항목:

필드	타입	설명
id	number	그룹 ID
name	string	그룹 이름
description	string	그룹 설명

401 Unauthorized - 인증 실패

{
  "status": 401,
  "code": 40100,
  "message": "UNAUTHORIZED"
}

500 Internal Server Error - 서버 내부 오류

{
  "status": 500,
  "code": 50000,
  "message": "INTERNAL_SERVER_ERROR"
}