修改信封中联系人信息

1.描述: 修改联系人信息

2.接口地址:

请求路径:/ws-rest/v1/users/{user-id}/envelopes/{envelope-id}/recipients

请求头:采用HMAC认证

请求体:

{
    "recipients": [
        {
            "recipientId": 1,
            "name": "zhang san",
            "contact": "[email protected]",
            "note": "private message",
            "recipientType": 1,
            "sequence": 1,
             "extraInfo": {
        "uniqueId": "签署人唯一标识"
      },
        },
        {
            "recipientId": 2,
            "name": "zhang san zhou",
            "contact": "[email protected]",
            "note": "private message",
            "recipientType": 2,
            "sequence": 1,
             "extraInfo": {
        "uniqueId": "签署人唯一标识"
      },
        }
    ]
}

3.请求方式

PUT

4.请求参数说明

a.请求示例

curl -X PUT\
--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 "{
\"recipients\": [
{
\"recipientId\":1,
\"name\": \"zhang san\",
\"contact\": \"[email protected]\",
\"note\": \"private message\",
\"recipientType\": 1,
\"sequence\": 0
},
{
\"recipientId\":2,
\"name\": \"zhang san zhou\",
\"contact\": \"[email protected]\",
\"note\": \"private message\",
\"recipientType\": 2,
\"sequence\": 0
}
]
}" 
 "http://10.10.10.120:8080/ws-rest/v1/users/146/envelopes/abcf4c56-fd97-407d-9684-78164b3f3025/recipients"

b.请求字段说明

字段 是否必填 类型 位置 长度 说明
user-id Long URL-PATH 用户id
envelope-id String URL-PATH 信封id
recipientId Long 请求体 接收者id
name String 请求体 接收者姓名
contact String 请求体 接收者联系方式
note String 请求体 当前接收者私人信息
sequence int 请求体 签名顺序
recipientType int 请求体 接收者类型(0-仅签名,1-仅接收,2-签名并接收文档)
extraInfo Object 请求体 签署人额外信息
uniqueId String 请求体 签署人唯一标识

5.响应参数说明

a.响应示例

  • 响应成功:
    {
    "resultStatusCode": "100600000",
    "resultCode": 0,
    "resultDesc": "操作成功",
    "resultData": "信封操作成功"
    }
    
  • 响应失败:
    {
    "resultStatusCode": "100600102",
    "resultCode": 1,
    "resultDesc": "空信封异常"
    }
    

b.响应字段说明

字段 必填 类型 位置 长度 说明
resultStatusCode string BODY 固定值 结果状态码
resultCode int BODY 固定值-0,1 结果码,0-成功,1-失败,具体含义见结果状态码
resultDesc string BODY 操作结果说明,见其包含信息

results matching ""

    No results matching ""