合作企业名录数据
接口说明
该接口用于获取合作企业名录数据,接口将返回大于指定version值的增量数据,返回结果将按数据的version字段进行升序排序,每次查询最多返回200条数据。
接口地址
/dw/basic/companies/v2?start=0&limit=200&cooperationType=1
接口类型
Http
请求方式
GET
内容类型
application/json
鉴权策略
参见《Open-API鉴权协议》
请求参数
| 参数名称 | 说明 |
|---|---|
| start | 本次请求所要获取的增量数据的version起始值,客户端需要缓存接口返回的数据集合中最后一条数据的version值 |
| limit | 返回指定的数据条数 上限为200条 0 < limit <= 200 |
| cooperationType | 企业类型 见附录 合作关系类型 |
响应报文
"data": [
{
"id": 1,
"name": "公司",
"nameEn": "null",
"shortName": "公司简名",
"creditCode": "123",
"cooperationTypes": 1,
"registeredCapital": 100.00,
"legalPersonName": "法人",
"businessScope": "业务范围",
"companyProperty": "公司属性",
"contactPersonName": "个人姓名",
"contactPersonPosition": "1123",
"phoneNumber": "null",
"address": "null",
"originalId": "null",
"createdAt": 1548138574904,
"updatedAt": 1548138574904,
"isRemoved": false,
"version": 123455
}
响应状态码
| 字段名称 | 数据类型 |
|---|---|
| 200 | 成功 |
| 400 | 用户请求头中Authorization值的格式不对,错误码:InvalidArgument。 |
| 403 | AccessId不存在或被禁用 错误码:InvalidAccessId |
| 500 | 非法参数或接口执行异常 |
响应数据结构
| 字段名称 | 数据类型 | 是否可以为空 | 字段描述 |
|---|---|---|---|
| id | long | 否 | 公司ID |
| name | string | 否 | 公司中文名称 |
| nameEn | string | 是 | 公司英文名称 |
| shortName | string | 否 | 短名称 |
| creditCode | string | 否 | 社会信用统一代码 |
| cooperationTypes | long | 否 | 合作关系类型见附录 合作关系类型 |
| registeredCapital | double | 是 | 注册资本金(万元) |
| legalPersonName | string | 是 | 法人姓名 |
| businessScope | string | 是 | 经营范围 |
| companyProperty | string | 是 | 企业性质 |
| contactPersonName | string | 是 | 联系人姓名 |
| contactPersonPosition | string | 是 | 联系人职务 |
| phoneNumber | string | 是 | 联系电话 |
| address | string | 是 | 联系地址 |
| originalId | string | 是 | 原始数据公司ID |
| createdAt | long | 否 | 创建时间 |
| updatedAt | long | 否 | 修改时间 |
| isRemoved | Boolean | 否 | 是否删除 |
| version | long | 否 | 数据版本 |