创建信封
1.描述: 创新一个空信封
2.接口地址:
请求路径:
/ws-rest/v1/users/{user-id}/envelopes
>
请求头:
采用HMAC认证
>
请求体:
{
"type": 0
}
3.请求方式
POST
4.请求参数说明
a.请求示例
curl -X POST \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Date: Wed, 02 Nov 2016 03:25:54 GMT" \
--header "User-Agent: SignIt RestAPI Client v1.0.0" \
--header "Host: api.signit.cn" \
--header "Authorization:HmacSHA512 a1S0H2-U0-v5I-0586-017-z6D-7B5-K0h-1o0-G0-9923G3Xm:53f7ae4a-937b-4ddc-8872-42dd094d56eb:NCMwvHfZS9ZzB2SgVbRzTuS/N5yDRM8Ak6tRvCavHD5T9nKjydc9ha+Rj48e0YIFC5V9IRtFL8Z1d0hvse7Ulg==" \
-d \
"{
\"type\": 0
}" "http://api.signit.cn/ws-rest/v1/users/1834/envelopes"
b.请求字段说明
字段 | 是否必填 | 类型 | 位置 | 长度 | 说明 |
---|---|---|---|---|---|
type | 是 | int | 请求体 | 固定长度 | 信封类型(0:本人签,1:多人签,2:他人签,3:自由签) |
5.响应参数说明
a.响应示例
- 响应成功:
{{
"resultStatusCode": "100600000",
"resultCode": 0,
"resultDesc": "信封操作成功",
"resultData": {
"envelopeId": "9ab2177e-9294-49fb-930e-0d1707d69510",
"link": {
"href": "/ws-rest/v1/users/1834/envelopes/9ab2177e-9294-49fb-930e-0d1707d69510",
"method": "GET"
},
"statusDatetime": 1494326121000,
"type": 0,
"status": 0
}
}
- 响应失败:
{
"resultStatusCode": "100600108",
"resultCode": 1,
"resultDesc": "信封类型错误"
}
b.响应字段说明
字段 | 必填 | 类型 | 位置 | 长度 | 说明 |
---|---|---|---|---|---|
resultStatusCode | 是 | string | BODY | 固定值 | 结果状态码 |
resultCode | 是 | int | BODY | 固定值0,1 | 结果码,0-成功,1-失败,具体含义见结果状态码 |
resultDesc | 是 | string | BODY | 无 | 操作结果说明,见其包含信息 |
envelopeId | 是 | String | BODY | 信封id | |
href | 是 | String | BODY | 当前信封资源链接 | |
method | 是 | String | BODY | 链接与服务器交互方法 | |
statusDatetime | 是 | Long | BODY | 信封状态时间 | |
type | 是 | int | BODY | 固定值 | 信封类型(0:本人签,1:多人签,2:他人签,3:自由签) |
status | 是 | int | BODY | 固定值 | 信封状态(0-草稿,1-已发送,2-已完成,3-拒签,4-撤销,5-超时,6-删除(发起者逻辑),10-作废(发起者执行),11-审核不通过,14-纠正) |