본문으로 건너뛰기
버전: 개발 버전 (최신)

지원 사이트 API

개요​

지원 사이트 API는 사용자(환자)의 사이트(병원) 및 MD(처방의) 정보를 관리하는 기능을 제공합니다.

주요기능​

  • 사이트 정보 수정: 환자의 사이트(병원) 정보 수정
  • MD 정보 수정: 환자의 MD(처방의) 정보 수정
  • MD 정보 삭제: 환자의 MD(처방의) 정보 삭제
[PATCH] /sites/{siteId}/users/{userId} - 사이트 정보 수정

사이트 정보 수정

환자의 사이트(병원) 정보를 수정합니다.

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

Headers​

HeaderTypeDescriptionRequired
AuthorizationBearer {accessToken}사용자 인증을 통해 발급받은 액세스 토큰 입니다.✔

Path Parameters​

파라미터타입설명Required
siteIdnumber사이트 ID✔
userIdstring사용자 ID✔

Request Body​

N/A

Responses​

Http Status Code설명Error Code(s)
200 OK사이트 정보 수정 성공-
401 Unauthorized인증 실패-
404 Not Found사용자 또는 사이트를 찾을 수 없음-
200 OK - 성공
{
  "success": true
}
필드타입설명
successboolean성공 여부
401 Unauthorized - 인증 실패

예시: 토큰이 누락된 경우

{
  "status": 401,
  "code": 40100,
  "message": "Unauthorized",
  "detail": ""
}
404 Not Found - 찾을 수 없음

예시: 사용자 또는 사이트를 찾을 수 없는 경우

{
  "status": 404,
  "code": 40400,
  "message": "User or Site not found",
  "detail": ""
}
[PATCH] /sites/users/{userId}/md - MD 정보 수정

MD 정보 수정

환자의 MD(처방의) 정보를 수정합니다.

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

Headers​

HeaderTypeDescriptionRequired
AuthorizationBearer {accessToken}사용자 인증을 통해 발급받은 액세스 토큰 입니다.✔

Path Parameters​

파라미터타입설명Required
userIdstring사용자 ID✔

Request Body​

N/A

Responses​

Http Status Code설명Error Code(s)
200 OKMD 정보 수정 성공-
401 Unauthorized인증 실패-
404 Not Found사용자를 찾을 수 없음-
200 OK - 성공
{
  "success": true
}
필드타입설명
successboolean성공 여부
401 Unauthorized - 인증 실패

예시: 토큰이 누락된 경우

{
  "status": 401,
  "code": 40100,
  "message": "Unauthorized",
  "detail": ""
}
404 Not Found - 찾을 수 없음

예시: 사용자를 찾을 수 없는 경우

{
  "status": 404,
  "code": 40400,
  "message": "User not found",
  "detail": ""
}
[DELETE] /sites/users/{userId}/md - MD 정보 삭제

MD 정보 삭제

환자의 MD(처방의) 정보를 삭제합니다.

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

Headers​

HeaderTypeDescriptionRequired
AuthorizationBearer {accessToken}사용자 인증을 통해 발급받은 액세스 토큰 입니다.✔

Path Parameters​

파라미터타입설명Required
userIdstring사용자 ID✔

Request Body​

N/A

Responses​

Http Status Code설명Error Code(s)
200 OKMD 정보 삭제 성공-
401 Unauthorized인증 실패-
404 Not Found사용자를 찾을 수 없음-
200 OK - 성공
{
  "success": true
}
필드타입설명
successboolean성공 여부
401 Unauthorized - 인증 실패

예시: 토큰이 누락된 경우

{
  "status": 401,
  "code": 40100,
  "message": "Unauthorized",
  "detail": ""
}
404 Not Found - 찾을 수 없음

예시: 사용자를 찾을 수 없는 경우

{
  "status": 404,
  "code": 40400,
  "message": "User not found",
  "detail": ""
}