기기

해당 페이지는 ADT 임상프로젝트와 관련된 API를 설명해놓은 페이지입니다.

소개

ADT 기기 API는 사용 기록 저장, 사용 기록 삭제, 사용 기록 내보내기 등의 임상과 관련된 작업을 수행하는 API들로 구성되어있습니다.

인증

모든 기기 API는 인증 토큰을 요구하지않습니다.

엔드포인트

기기 사용 기록 업로드

기기의 사용기록들을 업로드하는 기능입니다. 사용기록이 여러개 일 수 있기 때문에 배열로 받습니다.

Body Parameters

요청 예시

POST /api/v1/adt/device/devlog HTTPS
[
  {
    "unique_id": "string",
    "detail_data": {
      "treatment_date": "2024-12-05T14:06:47",
      "finish_flag": "2",
      "last_intensity": 2,
      "treatment_time": 416,
    },
    "intensity_record": [
        {
        "intensity": 2,
        },
        {
        "intensity": 12,
        },
        {
        "intensity": 22,
        }
    ]
    "log_file_id": 0
  } 
]

응답 예시

{
    "statusCode": 200,
    "message": "Devlog saved successfully"
}

{
    "detail": "Not Found Device"
}

기기 사용 기록 삭제

기기의 사용기록들을 모두 소프트 삭제하는 기능입니다. 주로 공장에서 테스트 과정으로 생긴 기록들을 모두 삭제하고 출고전에 사용하는 용도입니다.

Parameters

요청 예시

DELETE /api/v1/adt/device/devlog?unique_id=1 HTTPS

응답 예시

{
    "statusCode": 200,
    "message": "Deleted {지운 개수} device log(s) successfully"
}

{
    "detail": "Device Log not found"
}

기기 사용 기록 내보내기

기기의 사용기록들을 모두 엑셀 파일 형식으로 내보내는 기능입니다. 파일이름은 ADT_DEVICE_{unique_id}_{start_date}~{end_date}.xlsx 을 따릅니다.

Parameters

요청 예시

GET /api/v1/adt/device/devlog?unique_id=1&start_date=2025-05-01&end_date=2025-05-10 HTTPS

응답 예시

Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

{
    "detail": "Device Log not found"
}

기기 사용 기록 조회

분석 탭에서 캘린더 기록을 불러오는 API입니다. 파라미터의 기본값은 0으로 서버 기준 당일 날짜로 조회합니다. Figma 기획상 캘린더는 주 단위와 월 단위, 두 가지 기간만 존재하고 있습니다. (요청 예시 참고)

다만 추후 기획이 변경될 수 있기에 기간을 커스텀할 수 있습니다.

치료기록을 가져오는 조건은 다음과 같습니다.

1. 삭제되지않은 모든 기록

Parameters

요청 예시

1. 이번 주 기록 데이터 불러오기

GET /api/v1/adt/device/history?unique_id=1 HTTPS

설명: 이번 주의 데이터를 조회합니다.

2. 이번 달 기록 데이터 불러오기

GET /api/v1/adt/device/history?unique_id=1&select_mode=1 HTTPS

설명: 이번 달의 데이터를 조회합니다.

3. 커스텀 기간의 기록 데이터 불러오기

/api/v1/addnox/event/history?unique_id=1&select_mode=0&select_data=15 // 15번째 주의 데이터를 조회합니다.
/api/v1/addnox/event/history?unique_id=1&select_mode=1&select_data=5 // 5월 데이터를 조회합니다.
/api/v1/addnox/event/history?unique_id=1&select_mode=2&select_data=0 // 오늘 기준 분기를 조회합니다.
/api/v1/addnox/event/history?unique_id=1&select_mode=3 // 오늘 연도의 데이터를 조회합니다.

설명: 원하는 기간의 데이터를 조회합니다.

응답 예시

[
    {
        "date": "2024-12-01",
        "is_devlog": 1
    },
    {
        "date": "2024-12-03",
        "is_devlog": 1
    }
]

{
    "detail": "Invalid mode"
}

기기 사용 기록 상세 조회

해당 날짜의 기기 상세 사용 기록을 조회하는 API입니다.

Parameters

요청 예시

GET /api/v1/adt/device/detail?unique_id=1&event_date=2025-05-01 HTTPS

응답 예시

{
    "treatment_data": [
        {
            "treatment_date": "2000-01-01T20:48:00",
            "treatment_time": 3255,
            "last_intensity": 17
        },
        {
            "treatment_date": "2000-01-01T00:00:02",
            "treatment_time": 724,
            "last_intensity": 1
        }
    ]
}

{
    "detail": "Failed to read detail event"
}

공통 에러 처리

모든 엔드포인트에서 공통적으로 응답하는 에러코드입니다.

Error Response Example

• 401 Unauthorized: 토큰이 잘못되었습니다.

  {
    "detail": "Could not validate credentials" // 토큰이 잘못되었습니다.
  }
  
• 401 Unauthorized: 토큰이 만료되었습니다.

  {
    "detail": "Token is expired" // 토큰이 만료되었습니다.
  }
  
• 404 Not Found: 리소스를 찾을 수 없습니다. URI를 다시 확인해주세요.

  {
    "detail": "Resource not found"
  }
  
• 500 Internal Server Error: 서버 에러입니다.

  {
    "detail": "Internal server error. Please try again later."
  }