文 档 中 心 / Document Center
搜索 管理中心
壹川接口文档V3
获取管辖机构列表
更新时间:2018-04-12 16:52:29   更新人员:叶洋   文档状态:完成 #79    测试接口
摘要
获取管辖机构列表
  1. 接口基本信息
    接口名称:获取组织机构列表
    请求方法:GET
    接口地址:company
    登录验证:是
  2. 请求参数
    参数名 参数 数据类型 是否必须 示例值 说明
    page 分页 int 数据分页
    pid 上级组织 int 上级组织id
    name 名称 string 模糊匹配组织名称
    initials 拼音首字母 string 使用拼音首字母模糊查询
    status 状态 int 筛选状态 1为正常 0为禁用
    join_type 加入类型 int 加入类型
    row 每页数量 int 不传时默认为15
  3. 响应数据参数
    参数名 参数 数据类型 示例值 说明
    page 当前分页 int
    row 每页数量 int
    count 当前页数量 int
    total_count 数据总量 int
    total_page 总页数 int
    lists[] 列表数据 array 获取到的数据列表
    ├ com_id ├ 组织机构id int 2 组织机构ID
    ├ code ├ 组织机构代码 string 组织机构代码
    ├ merch_credential ├ 引入商户 string 通过哪个商户引入的机构
    ├ join_type ├ 加入类型 int 加入类型
    ├ pid ├ 上级组织id string 上级组织机构id
    ├ status ├ 状态 int 当前状态1正常0禁用
    ├ create_time ├ 创建时间 string 创建时间
    ├ create_by{} ├ 创建人 object
    │ ├ uid │ ├ 用户uid string
    │ ├ code │ ├ 用户code string
    │ ├ username │ ├ 用户名 string
    │ ├ nickname │ ├ 用户昵称 string
    │ └ realname │ └ 用户真实姓名 string
    ├ update_time ├ 更新时间 string
    ├ update_by{} ├ 更新人 object 更新人id
    │ ├ uid │ ├ 用户uid string
    │ ├ code │ ├ 用户code string
    │ ├ username │ ├ 用户名 string
    │ ├ nickname │ ├ 用户昵称 string
    │ └ realname │ └ 用户真实姓名 string
    ├ runin_time ├ 加入生效时间 int 加盟生效可使用的开始时间
    ├ runout_time ├ 失效时间 int 失效过期的时间
    ├ country_id ├ 所在国 int 1 所在国id
    ├ province_id ├ 所在省id int 2502 组织所在省份
    ├ city_id ├ 城市id int 2548 所在城市id
    ├ district_id ├ 地区id int 2554 所在地区id
    ├ village_id ├ 小区id int 所在小区id
    ├ lng ├ 经度 float 104.056283 地理位置经度
    ├ lat ├ 纬度 float 30.538562 地理纬度
    ├ address ├ 详细地址 string
    ├ joining_fee ├ 加入费 float 加入费用
    ├ name ├ 组织名称 string 组织机构名称、公司名称、网点名称
    ├ initials ├ 拼音首字母 string 名称对应的拼音首字母
    ├ english_name ├ 英文名 string 组织机构的英文名
    ├ contacts ├ 联系人 string 联系人姓名
    ├ mobile ├ 联系人手机 phone 联系人的手机
    ├ tel ├ 电话 tel 组织机构的电话号码
    ├ fax ├ 传真 tel 组织机构的传真号码
    ├ cover ├ 封面照片 string 封面照片的hash值
    ├ picture_list ├ 图片列表 string 图片列表的hash值
    ├ img_business_license ├ 营业执照照片 string 营业执照照片hash值
    ├ img_transport_license ├ 运输许可证照片 string 运输许可证照片hash值
    ├ img_corporation_idcard ├ 公司法人身份证照 string 公司法人身份证照hash值
    ├ description ├ 企业描述 string 企业一般描述
    └ remark └ 备注信息 string
  4. 请求示例
    请求例子:
     
    apirq('company', {
        urlparams: [
            "name"
        ]
    }) 
    
    返回数据结果:
     
    {
        "code": 0,
        "msg": "ok",
        "time": "1523522194",
        "data": {
            "page": 1,
            "row": 15,
            "count": 4,
            "total_count": 4,
            "total_page": 1,
            "lists": [
                {
                    "com_id": "05d48fa8743570b0",
                    "code": "C57732",
                    "merch_credential": "c17ec996d3ffc85f",
                    "join_type": 1,
                    "pid": "",
                    "status": 1,
                    "create_time": "2018-03-27 13:27:06",
                    "create_by": {
                        "uid": "0000000000000101",
                        "code": "U4219695",
                        "username": "admin@cw",
                        "nickname": "系统内建财务员",
                        "realname": "系统内建财务员"
                    },
                    "update_time": "2018-03-27 14:51:10",
                    "update_by": {
                        "uid": "0000000000000101",
                        "code": "U4219695",
                        "username": "admin@cw",
                        "nickname": "系统内建财务员",
                        "realname": "系统内建财务员"
                    },
                    "delete_time": null,
                    "runin_time": "-",
                    "runout_time": "-",
                    "country_id": 1,
                    "province_id": 0,
                    "city_id": 0,
                    "district_id": 0,
                    "street_id": 0,
                    "lng": "104.062087",
                    "lat": "30.665243",
                    "joining_fee": "0.00",
                    "name": "天天向上2",
                    "initials": "ttxs",
                    "english_name": "The day is up 2",
                    "address": "四川省成都市青羊区西御河街道大树拐街15号五福街56号院",
                    "contacts": "李白",
                    "mobile": "13212345678",
                    "tel": "0281324567",
                    "fax": "0281234564",
                    "email": "",
                    "cover": "",
                    "picture_list": "",
                    "img_business_license": "",
                    "img_transport_license": "",
                    "img_corporation_idcard": "",
                    "description": "中国人民伙历地有",
                    "remark": ""
                },
                // ......
            ]
        }
    } 
    
本书创建于 2018-03-30 12:03:13 ?如有疑问,请联系技术人员