Skip to content

Provider user detail

GET v1/ad/provider/user/:provider_id/:user_id

Request

namenecessarytypedefaultdescribe

Response data struct

namenecessarytypedefaultdescribe
codetrueint-错误码(error code)
messagetruestring-错误信息(error message)
causetruestring-错误原因(error cause)
detailstrueobject-详情(details)
-user_idtrueint-用户id(user id)
-first_nametruestring-名(first name)
-last_nametruestring-姓(last name)
-full_nametruestring-姓名(full name)
-avatartruestring-头像(avatar)
-area_codetruestring-国际区号(area code)
-phonetruestring-手机(phone)
-emailtruestring-邮箱(email)
-sextrueint-性别:1男,2女(sex:1 man, 2 woman)
-birthtruestring-出生日期(birth date)
-heighttrueint-身高(height)
-height_unittruestring-身高单位(height uint)
-weighttrueint-体重(weight)
-weight_unittruestring-体重单位(weight uint))
-bmitruefloat-BMI(BMI)
-bmi_typetrueint-BMI类型:1偏瘦,2正常,3超重,4偏胖,5肥胖,6极重度肥胖(BMI type: 1 is underweight, 2 is normal, 3 is overweight, 4 is overweight, 5 is obese, 6 is extremely obese)
statusfalseint-性状态:0禁用,1正常(status: 0 disabled, 1 normal)
-is_complete_datatrueint-是否完善资料:0为否,1为是(Whether the information is complete: 0 no, 1 yes)
-created_attruedatetime-创建时间(creation time)-注册时间
-updated_attruedatetime-更新时间(update time)
-user_settingtrueobject-用户-设置(user setting)
--idtrueint-用户详情id(user detail id)
--user_idtrueint-用户id(user id)
--system_notification_permissiontrueint-系统通知权限:0已关闭,1开启中(system notification permission:0 is off, 1 is on)
--doctor_pushtrueint-医生推送:0已关闭,1开启中(doctor push:0 is off, 1 is on)
--system_pushtrueint-系统推送:0已关闭,1开启中(System push:0 is off, 1 is on)
--length_unittruestring-长度单位(length unit)
--weight_unittruestring-重量单位(weight unit)
--languagetruestring-语言(language:en_us,zh_cn)
--timezonetruestring-时区(timezone)
--created_attruestring-创建时间(creation time)
--updated_attruestring-更新时间(update time)
-user_device_infotrueobject-用户-设备信息(user device info)
--idtrueint-用户详情id(user detail id)
--user_idtrueint-用户id(user id)
--device_nametruestring-设备名称(device name)-设备
--device_numtruestring-设备号(device No)-设备编号
--device_sntruestring-设备sn(device Sn)
--firmware_version_numtruestring-固件版本号(firmware version number)
--upper_device_advancementtruestring-上牙滴定值(upper device advancement)
--lower_device_advancementtruestring-下牙滴定值(lower device advancement)
--created_attruestring-创建时间(creation time)
--updated_attruestring-更新时间(update time)
-user_detailtrueobject-用户-详情(user detail)
--idtrueint-用户详情id(user detail id)
--user_idtrueint-用户id(user id)
--wear_daytrueint-佩戴天数(wear day)
--last_login_timetruestring-最后登录时间(last login time)-最近登录时间
--last_data_sync_timetruestring-最近数据同步时间(last data sync time)
--last_use_timetruestring-最后使用时间(last use time)
--created_attruestring-创建时间(creation time)
--updated_attruestring-更新时间(update time)
-user_doctortruearray-用户-医生(user-doctor))
--idtrueint-id(id)
--user_idtrueint-用户id(user id)
--provider_owner_idtrueint-机构所有者id(provider owner id)
--provider_idtruestring-机构id(provider id)
--admin_idtrueint-管理员id(admin id)
--created_attruestring-创建时间(creation time)
--updated_attruestring-更新时间(update time)
--admintruestring-管理员(admin)
---admin_idtrueint-管理员id(admin id)
---avatartruestring-头像(avatar)
---first_nametruestring-名(first name)-所属医生名
---last_nametruestring-姓(last name)所属医生姓
---emailtruestring-邮箱(email)
---provider_owner_idtrueint-机构所有者id(provider owner id)
---provider_idtruestring-机构id(provider id)
---typetrueint-类型:1平台账号,2机构账号(type: 1 platform account, 2 provider account)
---phonetruestring-电话号码(phone)
---area_codetruestring-国际区号(area code)
---sextrueint-性别:1男,2女(sex:1 man,2 woman)
---statustrueint-状态:0禁用,1正常(status: 0 disabled, 1 normal)
---created_attruestring-创建时间(creation time)
---updated_attruestring-更新时间(update time)
--providertruestring-机构(provider)
---idtrueint-id(id)
---provider_owner_idtrueint-机构所有者id(provider owner id)
---provider_idtruestring-机构id(provider id)
---nametruestring-名称(name)-所属机构
---descriptiontruestring-描述(description)
---statustrueint-状态:0禁用,1正常(status: 0 disabled, 1 normal)
---created_attruestring-创建时间(creation time)
---updated_attruestring-更新时间(update time)

Example

  • Url params: v1/ad/provider/user/20221129213412veTbeU2i/54

  • Header:

keyvalue
x-api-keyyour's key value
  • Response body:
json
{
    "code": 0,
    "message": "Success",
    "cause": "",
    "details": {
        "user_id": 1,
        "first_name": "Demo",
        "last_name": "Patient",
        "full_name": "Demo Patient",
        "avatar": "",
        "area_code": "",
        "phone": "",
        "email": "4-xxx@test.com",
        "sex": 0,
        "birth": "",
        "height": 0,
        "height_unit": "",
        "weight": 0,
        "weight_unit": "",
        "is_complete_data": 0,
        "bmi": 0,
        "bmi_type": 0,
        "is_virtual_user": true,
        "status": 1,
        "registered_at": "0001-01-01T00:00:00Z",
        "created_at": "2023-03-03T02:04:39+08:00",
        "updated_at": "2023-03-03T02:04:39+08:00",
        "user_setting": {
            "id": 1,
            "user_id": 1,
            "system_notification_permission": 0,
            "doctor_push": 0,
            "system_push": 0,
            "length_unit": "mm",
            "weight_unit": "g",
            "language": "en_us",
            "timezone": "",
            "created_at": "2023-03-03T02:04:39+08:00",
            "updated_at": "2023-03-03T02:04:39+08:00"
        },
        "user_device_info": {
            "id": 1,
            "user_id": 1,
            "device_name": "",
            "device_num": "",
            "device_sn": "",
            "firmware_version_num": "",
            "lower_device_advancement": "",
            "upper_device_advancement": "",
            "created_at": "2023-03-03T02:04:39+08:00",
            "updated_at": "2023-03-03T02:04:39+08:00"
        },
        "user_detail": {
            "id": 1,
            "user_id": 1,
            "wear_day": 0,
            "last_login_time": "0001-01-01T00:00:00Z",
            "last_data_sync_time": "0001-01-01T00:00:00Z",
            "last_use_time": null,
            "created_at": "2023-03-03T02:04:39+08:00",
            "updated_at": "2023-03-03T02:04:39+08:00"
        },
        "doctor": []
    }
}
{
    "code": 0,
    "message": "Success",
    "cause": "",
    "details": {
        "user_id": 1,
        "first_name": "Demo",
        "last_name": "Patient",
        "full_name": "Demo Patient",
        "avatar": "",
        "area_code": "",
        "phone": "",
        "email": "4-xxx@test.com",
        "sex": 0,
        "birth": "",
        "height": 0,
        "height_unit": "",
        "weight": 0,
        "weight_unit": "",
        "is_complete_data": 0,
        "bmi": 0,
        "bmi_type": 0,
        "is_virtual_user": true,
        "status": 1,
        "registered_at": "0001-01-01T00:00:00Z",
        "created_at": "2023-03-03T02:04:39+08:00",
        "updated_at": "2023-03-03T02:04:39+08:00",
        "user_setting": {
            "id": 1,
            "user_id": 1,
            "system_notification_permission": 0,
            "doctor_push": 0,
            "system_push": 0,
            "length_unit": "mm",
            "weight_unit": "g",
            "language": "en_us",
            "timezone": "",
            "created_at": "2023-03-03T02:04:39+08:00",
            "updated_at": "2023-03-03T02:04:39+08:00"
        },
        "user_device_info": {
            "id": 1,
            "user_id": 1,
            "device_name": "",
            "device_num": "",
            "device_sn": "",
            "firmware_version_num": "",
            "lower_device_advancement": "",
            "upper_device_advancement": "",
            "created_at": "2023-03-03T02:04:39+08:00",
            "updated_at": "2023-03-03T02:04:39+08:00"
        },
        "user_detail": {
            "id": 1,
            "user_id": 1,
            "wear_day": 0,
            "last_login_time": "0001-01-01T00:00:00Z",
            "last_data_sync_time": "0001-01-01T00:00:00Z",
            "last_use_time": null,
            "created_at": "2023-03-03T02:04:39+08:00",
            "updated_at": "2023-03-03T02:04:39+08:00"
        },
        "doctor": []
    }
}