材料类别数据
接口说明
该接口用于材料类别数据，接口将返回大于指定version值的增量数据，返回结果将按数据的version字段进行升序排序，每次查询最多返回200条数据。
接口地址
/material/material-categories?start=12345&limit=200
接口类型
Http
请求方式
GET
内容类型
application/json
鉴权策略
参见《Open-API鉴权协议》
请求参数
| 参数名称 | 说明 |
|---|---|
| start | 本次请求所要获取的增量数据的version起始值，客户端需要缓存接口返回的数据集合中最后一条数据的version值 |
| limit | 返回指定的数据条数 上限为200条 0 < limit <= 200 |
响应报文
[
{
"id": 234234,
"categoryCode": "010101",
"orderCode": "1010",
"parentOrderCode": "10",
"name": "钢材",
"remark": "xxxx",
"level": 1,
"sort": 12,
"status": "active",
"createTime": "2017-01-19 12:11:30",
"updateTime": "2018-01-08 19:05:20",
"version": 2323232323,
"deleted": false
}
]
响应状态码
| 字段名称 | 数据类型 |
|---|---|
| 200 | 成功 |
| 400 | 用户请求头中Authorization值的格式不对，错误码：InvalidArgument。 |
| 403 | AccessId不存在或被禁用 错误码：InvalidAccessId |
| 500 | 非法参数或接口执行异常 |
响应数据结构
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| id | long | 材料类别ID |
| categoryCode | String | 材料类别编码 |
| orderCode | string | 材料类别层级规则编码 |
| parentOrderCode | string | 父材料类别层级规则编码 |
| name | string | 材料类别名称 |
| remark | string | 描述 |
| level | int | 级次 |
| sort | long | 排序 |
| status | String | 类别状态 见表1 |
| createTime | date | 数据创建时间 |
| updateTime | date | 数据修改时间 |
| version | long | 当前数据版本 |
| deleted | boolean | 逻辑删除标志位 见表2 |
表1 编码状态枚举值
| status | |
|---|---|
| disable | 禁用 |
| active | 正常 |
表2 是否逻辑删除标识
| deleted | |
|---|---|
| false | 未删除 |
| true | 已删除 |
材料字典数据
接口说明
该接口用于材料字典数据，接口将返回大于指定version值的增量数据，返回结果将按数据的version字段进行升序排序，每次查询最多返回200条数据。
接口地址
/material/materials?start=12345&limit=200
接口类型
Http
请求方式
GET
内容类型
application/json
请求参数
| 参数名称 | 说明 |
|---|---|
| start | 本次请求所要获取的增量数据的version起始值，客户端需要缓存接口返回的数据集合中最后一条数据的version值 |
| limit | 返回指定的数据条数 上限为200条 0 < limit <= 200 |
响应报文
[
{
"id": 213213123,
"categoryId": 454545,
"categoryCode":"2323232",
"code": "101010",
"name": "混凝土",
"specifications": "C35",
"model": "xxx",
"texture": "xxx",
"unit": "方",
"remark": "xxxx",
"conversion":[
{
"coefficient":2.4,
"unit":"吨",
}
],
"status": "active",
"createTime": "2017-01-19 12:11:30",
"updateTime": "2018-01-08 19:05:20",
"version": 2323232323,
"deleted": false
}
]
响应状态码
| 字段名称 | 数据类型 |
|---|---|
| 200 | 成功 |
| 400 | 用户请求头中Authorization值的格式不对，错误码：InvalidArgument。 |
| 403 | AccessId不存在或被禁用 错误码：InvalidAccessId |
| 500 | 非法参数或接口执行异常 |
响应数据结构
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| id | String | 材料ID |
| categoryId | string | 材料分类ID |
| categoryCode | string | 材料分类编码 |
| code | string | 材料编码 |
| name | string | 材料名称 |
| specifications | string | 规格 |
| model | string | 型号 |
| texture | string | 材质 |
| unit | string | 单位 |
| remark | string | 备注 |
| conversion | list | 单位换算 见表1 |
| status | string | 编码状态 见表2 |
| createTime | date | 数据创建时间 |
| updateTime | date | 数据修改时间 |
| version | long | 当前数据版本 |
| deleted | boolean | 逻辑删除标志位 见表3 |
表1 问题、整改结果、复查结果附件（照片）列表
| 字段名称 | 数据类型 | 字段描述 |
|---|---|---|
| coefficient | double | 换算系数 |
| unit | string | 换算单位 |
表2 编码状态枚举值
| status | |
|---|---|
| disable | 禁用 |
| active | 正常 |
表3 逻辑删除标志位
| deleted | |
|---|---|
| false | 未删除 |
| true | 已删除 |