Migration 가이드

1. Version 1.0 to 2.0

v2.0에서는 각각 새로운 버전의 Get Single Session과 Callback으로 업데이트 되었습니다. 주요 변경 사항으로는 필드명 변경, 구체적인 세션 상태값 추가, callback request body 변경입니다.

1.1 Get Single Session

1.1.1 Response 포맷 변경

Get Single Session API v3가 새롭게 추가되었습니다. 각 필드에 대한 자세한 내용은 Get Single Session에서 확인할 수 있습니다.

변경 사항

  • v3 API에서는 기존의 v2 API에 있던 validity 대신 peculiarities라는 새로운 필드로 변경되었습니다.
    더불어 세션의 다양한 분석 상태를 알리는 값들이 추가 되었습니다.
v2 validityv3 peculiarities
IN_PROGRESS
INVALID:TOO_MANY_DEFECTS_IN_SLEEP_STAGES
INVALID:TOO_MANY_DEFECTS_IN_OSA_STAGES
VALID
IN_PROGRESS
NEVER_SLEPT
TOO_SHORT_FOR_ANALYSIS
TOO_LONG_FOR_ANALYSIS
TOO_MANY_DEFECTS_IN_SLEEP_STAGES
NO_BREATHING_STABILITY
NO_REALTIME_POLLING
  • missing_data_ratio가 추가되었습니다.
  • estimated_ahi가 breathing_index로 필드명이 변경되었습니다. 값은 동일합니다.
  • osa_stages가 breath_stages로 필드명이 변경되었습니다. 값은 동일합니다.
  • breathing_pattern에 라벨 값들이 변경되었습니다.
v2 breathing_patternv3 breathing_pattern
VERY_STABLE,
STABLE,
UNSTABLE,
VERY_UNSTABLE
STABLE_BREATH,
MILDLY_UNSTABLE_BREATH,
MODERATELY_UNSTABLE_BREATH,
SEVERELY_UNSTABLE_BREATH

1.2 Callback

1.2.1 Request Body 포맷 변경

새로운 SDK v2 SDK Migration Guide부터 callback request body 포맷이 아래와 같이 변경되었습니다.

변경 사항

  • INFERENCE_COMPLETE
    • stage_list가 sleep_stages로, osa_stage_list가 breath_stages로 변경되었습니다.
  • SESSION_COMPLETE
    • callback_data의 포맷이 Get Single Session을 똑같이 사용하도록 변경되었습니다. 세부적인 변경사항은 위의 Get Single Session 변경사항과 같습니다.