delete

概览

  • API URL:/api/v1/zoloz/privacyinfo/delete
  • API 描述:该接口用于删除隐私信息,例如证件或人脸图片、OCR或输入信息。

说明:该接口支持重复调用,即符合幂等性。

请求参数

字段名称

数据类型

最大长度

是否必填

描述

示例值

transactionId

String

64

事务ID,事务的唯一标识,用于追踪业务。

"G006600001FFS20190914000000000000010021"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

API请求结果,包含结果状态、结果码和结果消息。

{

"resultCode":"SUCCESS", "resultStatus":"S", "resultMessage":"success"

}

Result字段说明

字段名称

数据类型

必须返回

描述

示例值

resultCode

String

结果码。

  • PARAM_ILLEGAL:transactionId为null或空字符串。
  • SUCCESS:删除成功。
  • SYSTEM_ERROR:其他内部错误。

"SUCCESS"

resultStatus

String

结果状态。

"S"

resultMessage

String

结果信息。

"success"

代码示例

请求示例

copy
POST https://ip:port/api/v1/zoloz/privacyinfo/delete HTTP/1.1

Content-Type: application/json; charset=UTF-8
Client-Id: 5X67656YXXXXXX
Request-Time: 2019-04-04T12:08:56+05:30
Signature: algorithm=RSA256, signature=xxxxxxxxxxxx

{
  "transactionId": "G006600001FFS20190914000000000000010021"
}

返回示例

copy
HTTP/1.1 200 OK

Content-Type: application/json; charset=UTF-8
Response-Time: 2019-11-19T21:56:15-0800
Signature: algorithm=RSA256, signature=xxxxxxxxxxxxxxxxxx

{
  "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"success"
  }
}