合同列表
更新时间：2023-05-05
获取合同列表
接口描述
本接口用于获取已创建或签署完成的合同列表信息。
请求结构
POST /saas/openapi/econtract/v1/contract/list HTTP/1.1
Host: xuper.baidu.com
Content-Type: application/json;charset=utf-8
X_BXEO_APP_ID: ak string
X_BXEO_NONCE: nonce string
X_BXEO_SIGN: sign string
X_BXEO_TIMESTAMP: new time string
X_BXEO_CONTENTMD5: body md5 string
X_BXEO_SIGNTYPE: HMAC-SHA256
{
"bxeoContent": {
"address":"g1DZKxN2w5r72k6u7hpq7KGKQY8RFjSFL",
"status": 1,
"econtract_name":"BD",
"econtract_id":"BD",
"start_time":1661844663,
"end_time":1661844663，
"page": 1,
"size": 10
}
}请求头域
- 除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| bxeoContent | Object | 是 | RequestBody参数 | body共用字段头。 |
| +address | String | 是 | RequestBody参数 | BEXO系统中用户唯一身份标识。 |
| +status | int | 是 | RequestBody参数 | 合同状态：1:待我签署2:待他人签署3:已完成4:已终止 |
| +page | int | 否 | RequestBody参数 | 页码，默认第一页 |
| +size | int | 否 | RequestBody参数 | 每页显示数量，默认显示10条 |
| +econtract_name | int | 否 | RequestBody参数 | 合同名称模糊查询：xxxx% |
| +econtract_id | int | 否 | RequestBody参数 | 合同ID模糊查询：xxxx% |
| +start_time | int | 否 | RequestBody参数 | 查询合同创建时间开始时间-时间戳（与结束时间同时存在） |
| +end_time | String | 否 | RequestBody参数 | 查询合同创建结束开始时间-时间戳 （与开始时间同时存在） |
| +econtract_type | int | 否 | RequestBody参数 | 合同类型：1：单方签署，2：多方签署 |
响应头域
- 除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 0为成功，其他可参考常用错误码 |
| data | Object | 接口返回的具体业务信息均在data下，所有接口通用。 |
| +count | String | 当前列表总条数 |
| +list | Object | 当前列表数据 |
| ++econtract_id | String | 合同ID |
| ++address | String | BEXO系统中用户唯一身份标识 |
| ++creator_name | String | 创建者姓名 |
| ++econtract_name | String | 合同名称 |
| ++econtract_status | String | 合同状态：0:进行中,1:成功,2:失败 |
| ++deadline_time | String | 过期时间 |
| ++create_time | String | 创建时间 |
| ++finish_time | String | 签署完成或终止时间 |
| ++evidence_status | String | 存证状态： 0:等待存证,1:存证成功,2:存证失败,3:存证中 |
| ++econtract_type | String | 合同类型：1：单方；2：多方 |
| ++refuse_reason | String | 拒绝或取消原因 |
| ++signatory_info | Object | 签署人列表 |
| +++econtract_id | String | 合同ID |
| +++sing_address | String | 签署人唯一身份标识 |
| +++is_creator | String | 当前合同身份：1：创建者；0：参与者 |
| +++sign_status | String | 签署状态: 0:待签署,1:签署成功,2:签署处理中,3:签署失败,4:拒绝签署,5:超时未签署,6:取消签署 |
| +++sign_user_name | String | 签署人名称 |
请求示例
POST /saas/openapi/econtract/v1/contract/list HTTP/1.1
Host: xuper.baidu.com
Content-Type: application/json;charset=utf-8
X_BXEO_APP_ID: lf2a69d4dff7dc9f3a462719da8bb942
X_BXEO_NONCE: 12333312111
X_BXEO_SIGN: lf2a69d4dff7dc9f3a462719da8bb942
X_BXEO_TIMESTAMP: 1660733105
X_BXEO_CONTENTMD5: asdaxasdsasdasdasdas
X_BXEO_SIGNTYPE: HMAC-SHA256
{
"bxeoContent": {
"address":"g1DZKxN2w5r72k6u7hpq7KGKQY8RFjSFL",
"status": 1,
"econtract_name":"BD",
"econtract_id":"BD",
"start_time":1661844663,
"end_time":1661844663，
"page": 1,
"size": 1
}
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 18 Apr 2022 03:28:11 GMT
{
"code": 0,
"msg": "Success",
"data": {
"count": "28",
"list": [
{
"econtract_id": "BD238B2201646938",
"address": "Y1kFzB3whd9ESEL6WwUojoVEg99XVnCyo",
"creator_name": "xxx",
"econtract_name": "zzz",
"econtract_status": "0",
"deadline_time": "1759818729",
"create_time": "1662001646",
"evidence_status": "0",
"finish_time": "0",
"econtract_type": "2",
"refuse_reason": "",
"signatory_info": [
{
"econtract_id": "BD238B2201646938",
"sing_address": "Y1kFzB3whd9ESEL6WwUojoVEg99XVnCyo",
"is_creator": "1",
"sign_status": "0",
"sign_user_name": "xxx"
},
{
"econtract_id": "BD238B2201646938",
"sing_address": "aL7twrxpVq4FuhgC6dqiKoXn2b8Z2bZwi",
"is_creator": "0",
"sign_status": "0",
"sign_user_name": "天真"
}
]
}
]
}
}