home (1.0.0)

Download OpenAPI specification:Download

api server for Neofect Home

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

game

game Execution

Authorizations:

bearerAuth

Request Body schema: application/json

contentTrainingTypeId required	integer Id
motionTypeName	String Motion Type Name
targetSuccessCount required	integer Count
aromRatio required	number <double> Direction Control
adaptiveAromControl required	number <double> Adaptive Arom Control
level required	integer Level
totalPlayTime required	integer Play Time
maintainTime required	integer Holding Time
featureName required	string Feature Name
patientId	integer Patient Id
sessionId required	string Session Id
apiKey required	string Api Key
token required	string Token

Responses

Request samples

Payload

Content type

application/json

{"contentTrainingTypeId": 1,
"motionTypeName": "SHOULDER_VERTICAL",
"targetSuccessCount": 2,
"aromRatio": 0.1,
"adaptiveAromControl": 0,
"level": 3,
"totalPlayTime": 5,
"maintainTime": 3,
"featureName": "ROM",
"patientId": 0,
"sessionId": "string",
"apiKey": "string",
"token": "string"
}

Response samples

200

Content type

application/json

"string"

get Game List

Authorizations:

bearerAuth

path Parameters

device required	string (DeviceType) Enum: "SMART_GLOVE" "SMART_KIDS" "SMART_BOARD" Example: SMART_GLOVE device name
side required	string (SideType) Enum: "LEFT" "RIGHT" Example: LEFT OR RIGHT side name

Responses

Response samples

200

Content type

application/json

null

get Game List created by algorithm

Authorizations:

bearerAuth

path Parameters

device required	string (DeviceType) Enum: "SMART_GLOVE" "SMART_KIDS" "SMART_BOARD" Example: SMART_GLOVE device name
side required	string (SideType) Enum: "LEFT" "RIGHT" Example: LEFT OR RIGHT side name

query Parameters

userId	integer <int64> (TypeLong) Example: userId=103 User Id
contentIds	string contentId list

Responses

Response samples

200

Content type

application/json

null

get motion type List

Authorizations:

bearerAuth

path Parameters

device

required

string (DeviceType)

Enum: "SMART_GLOVE" "SMART_KIDS" "SMART_BOARD"

Example: SMART_GLOVE

device name

Responses

Response samples

200

Content type

application/json

[{"name": "Forearm",
"value": "FOREARM"
}
]

patient

get Patient Training Summary by id

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"isHomeUser": false,
"totalStarCount": 1200,
"todayPlayedTime": 90,
"todayStarCount": 23,
"last7DaysPlayedTime": 531,
"last7DaysStarCount": 107
}

get Session Detail

Authorizations:

bearerAuth

path Parameters

id

required

integer <int64> (TypeLong)

Example: 1343

Session Id

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"missions": [{"id": 0,
"name": "string",
"title": "string",
"lastTrainedDate": "2019-08-24T14:15:22Z",
"playedTime": 342343,
"starCount": 3,
"targetCount": 3,
"successCount": 3,
"level": 3
}
]
}

Create Stroke coach

Create Stroke coach Session

Authorizations:

bearerAuth

Request Body schema: application/json

userId	integer <int64> User Id
deviceType	string (DeviceType) Enum: "SMART_GLOVE" "SMART_KIDS" "SMART_BOARD"
sideType	string (SideType) Enum: "LEFT" "RIGHT"
	Array of objects (createMission) Game List

Responses

Request samples

Payload

Content type

application/json

{"userId": 0,
"deviceType": "SMART_GLOVE",
"sideType": "LEFT",
"games": [{"contentId": "string",
"level": 0
}
]
}

Response samples

200

Content type

application/json

0

report

get patient's Trained Times

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

{"playtimeAverage": 4,
"times": [{"date:"2019-01-01"": null,
"community:11570": null,
"content": 11334
}
]
}

get patient's Mission Log Lists

get patient's Mission Log List

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

[{"sessionName": "S49",
"sessionTypeName": "EVALUATION",
"deviceName": "SMART_GLOVE",
"missionName": "M1",
"contentName": "구해라 아기새",
"motionTypeName": "WRIST_FLEX_EXT_EG",
"missionTypeName": "ROM",
"targetSuccessCount": 49,
"successCount": 39,
"trainedTime": 65,
"trainedDate": "2020-09-01T00:00:00.000Z",
"createdTime": 204,
"achieveLevel": 11570
}
]

get patient's Trained Feature

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

[{"name": "COORDINATION",
"playedTime": 126,
"ratio": 35.67677
}
]

get patient's Evaluation List

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

[{"id": 129,
"date": "2019-01-01T11:22:21.000Z"
}
]

get patient's Session Summary List

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

{"assignedSessions": 5,
"completedSessions": 5,
"daysTrained": 5,
"averageTrainingTimePerSession": 5,
"TotalTrainingTime": 5,
"ActivityTolerance": 5
}

get patient's Sensor Summary List

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=iso date start date
endDate	string <date-time> (TypeDateTime) Example: endDate=iso date end date

Responses

Response samples

200

Content type

application/json

{"forearm": {"pronationReps": 0,
"pronationAverageRom": 0,
"supinaionReps": 0,
"supinaionAverageRom": 0
},
"whist": {"radialDeviationReps": 0,
"radialDeviationAverageRom": 0,
"ulnarDeviationReps": 0,
"ulnarDeviationAverageRom": 0,
"radialDeviationGravityEliminatedReps": 0,
"radialDeviationGravityEliminatedAverageRom": 0,
"ulnarDeviationGravityEliminatedReps": 0,
"ulnarDeviationGravityEliminatedAverageRom": 0,
"flexionReps": 0,
"flexionAverageRom": 0,
"extensionReps": 0,
"extensionAverageRom": 0,
"flexionGravityEliminatedReps": 0,
"flexionGravityEliminatedAverageRom": 0,
"extensionGravityEliminatedReps": 0,
"extensionGravityEliminatedAverageRom": 0
},
"finger": {"reps": 0,
"averageRom": 0
}
}

get patient's Trained Motion Type

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

[{"name": "FOREARM_SUP_PRONATION",
"playedTime": 126,
"ratio": 35.67677
}
]

get patient's Trained Arom

get patient's Arom

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=iso date start date
endDate	string <date-time> (TypeDateTime) Example: endDate=iso date end date

Responses

Response samples

200

Content type

application/json

{"dates": ["2019-01-01T00:00:00.000Z"
],
"motionMap": {"property1": [31.961862499999995
],
"property2": [31.961862499999995
]
}
}

get patient's Evaluation Detail

Authorizations:

bearerAuth

path Parameters

id

required

integer <int64> (TypeLong)

Example: 1343

Evaluation Id

Responses

Response samples

200

Content type

application/json

{"summary": {"property1": 0,
"property2": 0
},
"arom": {"property1": {"min": 0,
"max": 0
},
"property2": {"min": 0,
"max": 0
}
},
"prom": {"property1": {"min": 0,
"max": 0
},
"property2": {"min": 0,
"max": 0
}
}
}

get Board Movement History

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

{"movement": {"dates": ["2019-08-24"
],
"distances": [0
]
}
}

get Board Arom Area

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

{"first": {"date": "2019-08-24",
"ratio": 0,
"values": [0
]
},
"last": {"date": "2019-08-24",
"ratio": 0,
"values": [0
]
}
}

get Board Arom Range

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

{"horizontal": {"boardSize": 0,
"first": {"date": "string",
"min": 0,
"max": 0
},
"last": {"date": "string",
"min": 0,
"max": 0
}
},
"vertical": {"boardSize": 0,
"first": {"date": "string",
"min": 0,
"max": 0
},
"last": {"date": "string",
"min": 0,
"max": 0
}
}
}

get Board smoothness

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

{"first": {"date": "string",
"value": 0
},
"last": {"date": "string",
"value": 0
}
}

get Board similarity

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

{"first": {"date": "string",
"value": 0,
"count": 0
},
"last": {"date": "string",
"value": 0,
"count": 0
}
}

get patient's Evaluation Detail

Authorizations:

bearerAuth

path Parameters

id

required

integer <int64> (TypeLong)

Example: 1343

Evaluation Id

Responses

Response samples

200

Content type

application/json

{"freeExplore": {"standardScore": 0,
"rawScore": 0,
"areaRatio": 0,
"areaRatioPercentage": 0,
"meanRadialDistance": 0,
"meanRadialDistanceCenti": 0,
"speedIndex": 0,
"time": 0,
"imageUrl": "string",
"areaRatioOfSections": [0
]
},
"traceDraw": {"imageUrlCCW": "string",
"imageUrlCW": "string",
"standardScoreAvg": 0,
"traceDrawResultModelList": [{"standardScore": 0,
"rawScore": 0,
"pathFollowIndex": 0,
"pathFollowIndexPercentage": 0,
"circleIndex": 0,
"circleIndexPercentage": 0,
"timeScore": 0,
"time": 0,
"circleSize": "string",
"tracingDirection": "string"
}
]
},
"targetAchieve": {"standardScoreAvg": 0,
"imageUrl": "string",
"targetAchieveResultInner": {"targetScore": 0,
"rawScore": 0,
"errorScore": 0,
"errorScoreCenti": 0,
"timeScore": 0,
"time": 0,
"smoothnessScore": 0,
"smoothnessScorePercentage": 0
},
"targetAchieveResultOuter": {"targetScore": 0,
"rawScore": 0,
"errorScore": 0,
"errorScoreCenti": 0,
"timeScore": 0,
"time": 0,
"smoothnessScore": 0,
"smoothnessScorePercentage": 0
}
}
}

report v2

get patient's Trained whole Dates

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id

Responses

Response samples

200

Content type

application/json

{"dates": ["2019-01-01T00:00:00.000Z"
]
}

get patient's Evaluation Aroms

Authorizations:

bearerAuth

query Parameters

userId required	integer <int64> (TypeLong) Example: userId=1343 User Id
deviceId	integer <int64> (TypeLong) Example: deviceId=1343 device Id
startDate	string <date-time> (TypeDateTime) Example: startDate=1343 start date
endDate	string <date-time> (TypeDateTime) Example: endDate=1343 device Id

Responses

Response samples

200

Content type

application/json

{"dates": ["2019-01-01T00:00:00.000Z"
],
"evaluationMap": {"property1": [31.961862499999995
],
"property2": [31.961862499999995
]
}
}

rank

HOME BEST WARRIOR 랭킹산정 집계 api

이 API는 batch 연동용이기 때문에 개발용으로만 사용이됨.

Authorizations:

bearerAuth (role_admin)

path Parameters

yearMonth

string

Example: 2020-01

Year-Month ( YYYY-MM )

Responses

이달의 랭킹목록 TOP100을 반환.

Authorizations:

bearerAuth

path Parameters

yearMonth

string

Example: 2020-01

Year-Month ( YYYY-MM )

Responses

Response samples

200

Content type

application/json

{"year_month": "2020-01",
"rank_users": [{"patient_id": 0,
"user_name": "이름",
"rank": 0,
"rank_tier": "ORANGE|AMETHYST|EMERALD|TOPAZ|DIAMOND|PLATINUM|KING",
"total_score": 0
}
]
}

이달의 유저의 랭킹목록

Authorizations:

bearerAuth

path Parameters

yearMonth	string Example: 2020-01 yearMonth
patientId	integer <int64> (TypeLong) patientId

Responses

Response samples

200

Content type

application/json

{"patient_id": 0,
"user_name": "이름",
"rank": 0,
"rank_tier": "ORANGE|AMETHYST|EMERALD|TOPAZ|DIAMOND|PLATINUM|KING",
"total_score": 0,
"candy_point": 0,
"star_point": 0
}

contentId required	string <string> (TypeString) content Id
deviceType required	string <string> (TypeString) Example: SMART_KIDS device Type
localeCode required	string <string> (TypeString) Example: ko locale Code

home (1.0.0)

Authentication

bearerAuth

menu

get Main Category

Authorizations:

path Parameters

Responses

Response samples

get Middle Category

Authorizations:

Responses

Response samples

get Subclass

Authorizations:

path Parameters

Responses

Response samples

get Contents Info

Authorizations:

path Parameters

Responses

Response samples

game

game Execution

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

get Game List

Authorizations:

path Parameters

Responses

Response samples

get Game List created by algorithm

Authorizations:

path Parameters

query Parameters

Responses

Response samples

get motion type List

Authorizations:

path Parameters

Responses

Response samples

patient

get Patient Training Summary by id

Authorizations:

Responses

Response samples

get Session Detail

Authorizations:

path Parameters

Responses

Response samples

Create Stroke coach

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

report

get patient's Trained Times

Authorizations:

query Parameters

Responses

Response samples

get patient's Mission Log Lists

Authorizations:

query Parameters

Responses

Response samples

get patient's Trained Feature

Authorizations:

query Parameters

Responses

Response samples

get patient's Evaluation List

Authorizations: