响应消息
有关“验证应用程序接口(API)”返回的各种错误和响应消息的信息。
HTTP 状态码指示操作是否成功。 在向 Verify API 发送请求并获取响应时,可能会返回以下类型的错误:
- 2xx success
- 指示操作的成功状态。
- 4xx client errors
- 指示客户机应用程序提交的请求存在问题。 解决请求中的问题,再重新提交请求。
- 5xx server errors
- 指示服务器存在问题。 重新提交或重试该请求,直至成功。
messageId) 和翻译为请求者本地语言的文本 (messageDescription)。| HTTP 状态码 | 描述 |
|---|---|
| 200 | 成功检索对象 |
| 201 | 成功创建对象 |
| 202 | 已接受但未完成(异步操作)请求。 |
| 204 | 所请求的操作(例如,更新或删除对象)成功。 |
| 207 | 多个状态 - 已返回混合结果。 在执行 PATCH 和批量操作时,可能出现此状态。 |
| 400 | 错误请求。 请求格式不正确或无法处理。 输入参数可能包含无效值。 |
| 401 | 客户机未经认证。 例如,所使用的访问令牌无效。 |
| 403 | 禁止访问。 例如,访问令牌不允许访问所请求的资源。 |
| 404 | 找不到资源。 请求的信息不存在。 |
| 405 | 请求中所指定的 HTTP 方法不受资源支持。 |
| 406 | 资源无法生成请求的 Accept 头中指定的表示法。 |
| 409 | 此信息存在。 |
| 415 | 资源无法使用请求的 Content-Type 头中指定的表示法。 |
| 429 | 请求太多 |
| 500 | 处理请求时发生内部服务器错误。 |
| 501 | 请求的方法已禁用。 |
| 502 | 未发送通知。 |
如果在
PATCH 操作期间所有操作都成功,那么204状态将返回。 如果有一个或多个失败,那么将返回 207 状态,并且客户机可以解析结果。如果在批量管理操作(如
POST 或 DELETE)期间所有操作均成功,则201状态将返回。 如果有一个或多个失败,那么将返回 207 状态,并且客户机可以解析结果。对于错误处理,请使用错误响应主体中的 HTTP 响应代码 messageId。 messageDescription 将仅用于参考,并且会发生更改。 任何此类更改都不会构成对 API 语义的更改。