Migration Guide
1. V1.0 to V2.0
In version 2.0, both Get Single Session and Callback have been updated with new versions. The key changes include field name modifications, the addition of specific session status values, and alterations to the callback request body.
1.1 Get Single Session
1.1.1 Response Format Change
The Get Single Session API v3 has been newly added. You can find detailed information about each field in the Get Single Session.
Changes
- In the v3 API, the previous "validity" field from the v2 API has been replaced with a new field called "peculiarities." Additionally, various new values have been added to indicate different analysis states of the session.
v2 validity | v3 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" has been added.
- The field name "estimated_ahi" has been changed to "breathing_index," but the values remain the same.
- The field name "osa_stages" has been changed to "breath_stages," but the values remain the same.
- The label values in the "breathing_pattern" field have been changed.
v2 breathing_pattern | v3 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 Format Change
The new SDK v2 (SDK Migration Guide) has changed the callback request body format as follows.
Changes
- INFERENCE_COMPLETE
- "stage_list" has been changed to "sleep_stages," and "osa_stage_list" has been changed to "breath_stages."
- SESSION_COMPLETE
- The format of "callback_data" has been changed to match that of Get Single Session. The specific changes are the same as those mentioned in the Get Single Session updates.
Updated 12 months ago