Skip to content

Provider list

GET v1/ad/provider/list

Request

namenecessarytypedefaultdescribeui
namefalseint-机构名称(provider name)
statusfalseint-状态:0禁用,1正常(status: 0 disabled, 1 normal)

Response data struct

namenecessarytypedefaultdescribeui
codetrueint-错误码(error code)
messagetruestring-错误信息(error message)
causetruestring-错误原因(error cause)
detailstrueobject-详情(details)
-total_sizetrueint-总条数(total size)
-listtruearray-列表(list)
--idtrueint-id(id)
--admin_idtrueint-管理员id(admin id)
--provider_owner_idtrueint-机构所有者id(provider owner id)
--provider_idtruestring-机构id(provider id)
--statustrueint-状态:0禁用,1正常,2未加入(status:0disabled,1normal,2not joined)
--created_attruestring-创建时间(creation time)
--updated_attruestring-更新时间(update time)
--provider_detailtrueobject-机构-详情(provider detail)
---idtrueint-id(id)
---provider_owner_idtrueint-机构所有者id(provider owner id)
---provider_idtruestring-机构id(provider id)
---logotruestring-logo(logo)
---nametruestring-机构名称(provider name)
---emailtruestring-机构邮箱(provider email)
---area_codetruestring-国际区号(area code)
---phonetruestring-手机号码(phone)
---countrytruestring-国家(country)
---statetruestring-州(state)
---citytruestring-城市(city)
---post_codetruestring-邮编(post code)
---addresstruestring-机构地址(address)
---address_secondtruestring-机构地址第二行(address second)
---specialty_fieldtruestring-专业领域(specialty field)
---tax_numbertruestring-税号(tax number)
---descriptiontruestring-描述(description)
---statustrueint-状态:0禁用,1正常(status: 0 disabled, 1 normal)
---created_attruestring-创建时间(creation time)
---updated_attruestring-更新时间(update time
---provider_detailtrueobject-机构-详情(provider detail)
----idtrueint-id(id)
----provider_owner_idtrueint-机构所有者id(provider owner id)
----provider_idtruestring-机构id(provider id))
----provider_member_numintstring-机构成员人数(provider member number)
----user_numtrueint-患者人数(patient nunber)
----created_attruestring-创建时间(creation time)
----updated_attruestring-更新时间(update time)

Example

  • Header:
keyvalue
x-api-keyyour's key value
  • Response body:
json
{
    "code": 0,
    "message": "Success",
    "cause": "",
    "details": {
        "list": [
            {
                "id": 1,
                "admin_id": 2,
                "provider_owner_id": 2,
                "provider_id": "20230216145524XLdMBFpy",
                "status": 1,
                "created_at": "2023-02-16T14:55:28+08:00",
                "updated_at": "2023-02-16T14:55:28+08:00",
                "provide": {
                    "id": 1,
                    "provider_owner_id": 2,
                    "provider_id": "20230216145524XLdMBFpy",
                    "logo": "",
                    "name": "test 1",
                    "email": "user@email.com",
                    "area_code": "+86",
                    "phone": "",
                    "country": "usa",
                    "state": "",
                    "city": "",
                    "post_code": "",
                    "address": "test address",
                    "address_second": "test address second",
                    "specialty_field": "sleep",
                    "tax_number": "122e44ds",
                    "description": "desc 1",
                    "status": 1,
                    "created_at": "2023-02-16T14:55:26+08:00",
                    "updated_at": "2023-02-16T16:12:17+08:00"
                },
                "provider_detail": {
                    "id": 1,
                    "provider_owner_id": 2,
                    "provider_id": "20230216145524XLdMBFpy",
                    "provider_member_num": 1,
                    "user_num": 0,
                    "created_at": "2023-02-16T14:55:27+08:00",
                    "updated_at": "2023-02-16T14:55:35+08:00"
                }
            }
        ],
        "total_size": 1
    }
}
{
    "code": 0,
    "message": "Success",
    "cause": "",
    "details": {
        "list": [
            {
                "id": 1,
                "admin_id": 2,
                "provider_owner_id": 2,
                "provider_id": "20230216145524XLdMBFpy",
                "status": 1,
                "created_at": "2023-02-16T14:55:28+08:00",
                "updated_at": "2023-02-16T14:55:28+08:00",
                "provide": {
                    "id": 1,
                    "provider_owner_id": 2,
                    "provider_id": "20230216145524XLdMBFpy",
                    "logo": "",
                    "name": "test 1",
                    "email": "user@email.com",
                    "area_code": "+86",
                    "phone": "",
                    "country": "usa",
                    "state": "",
                    "city": "",
                    "post_code": "",
                    "address": "test address",
                    "address_second": "test address second",
                    "specialty_field": "sleep",
                    "tax_number": "122e44ds",
                    "description": "desc 1",
                    "status": 1,
                    "created_at": "2023-02-16T14:55:26+08:00",
                    "updated_at": "2023-02-16T16:12:17+08:00"
                },
                "provider_detail": {
                    "id": 1,
                    "provider_owner_id": 2,
                    "provider_id": "20230216145524XLdMBFpy",
                    "provider_member_num": 1,
                    "user_num": 0,
                    "created_at": "2023-02-16T14:55:27+08:00",
                    "updated_at": "2023-02-16T14:55:35+08:00"
                }
            }
        ],
        "total_size": 1
    }
}