公共异常响应

⚠️注意

所有异常响应的响应体格式都为

字段名	数据类型	说明
code	Integer	异常代码
message	String	异常信息

{
  "code": 100,
  "message": "BAD_PARAMS"
}

其中，对于未特殊说明、且问题出现在客户端的异常，返回的 Http 状态码都为 400 Bad Request。

若出现了非上述格式的异常响应体，或出现了 Http 状态码为 500 Internal Server Error 的响应，请携异常响应本身和大体的复现步骤联系本人。

异常大全

参数错误 Code: 100

参数错误

当客户端发送的参数不符合服务端要求时抛出该异常。

{
  "code": 100,
  "message": "Unknown fetcher name: foobar"
}

未找到结果 Code: 104

未找到结果

当客户端指定的资源无法被找到时抛出该异常，通常情况下 message 字段会返回未找到的资源类型名，如 place 或 announcement。

当该响应的 Http 状态码为 404 Not Found 时，说明客户端请求的路径不存在接口。

{
  "code": 104,
  "message": "place"
}

指定参数对应多个结果 Code: 105

指定参数对应多个结果

当客户端查询的应具有唯一性的资源的查询结果不唯一时抛出该异常。

该异常的 message 字段为该查询请求对应的所有资源的 JSON 字符串，该 JSON 为 查询地点详情 接口查询地点别名（即 queryType=forAliases ）时返回的 JSON 对象结构所构成的列表，如：

GET: /place/安徽省合肥市/包河?queryType=common

{
    "code": 105,
    "message": "[{\"id\":197,\"name\":\"润宝梦想潮玩合肥包河大融城店\",\"aliases\":[{\"id\":326,\"name\":\"润\"},{\"id\":327,\"name\":\"大融城\"}]},{\"id\":120,\"name\":\"城市星空合肥包河店\",\"aliases\":[{\"id\":98,\"name\":\"城市星空\"},{\"id\":99,\"name\":\"城星\"},{\"id\":102,\"name\":\"方\"},{\"id\":101,\"name\":\"方圆荟\"},{\"id\":100,\"name\":\"橙星\"},{\"id\":322,\"name\":\"城\"}]},{\"id\":6,\"name\":\"大玩家合肥包河万达店\",\"aliases\":[{\"id\":9,\"name\":\"dwj\"},{\"id\":320,\"name\":\"w\"},{\"id\":321,\"name\":\"j\"},{\"id\":325,\"name\":\"dw\"}]},{\"id\":153,\"name\":\"卡迪龙合肥包河漫乐城店\",\"aliases\":[{\"id\":235,\"name\":\"龙\"}]}]"
}

未认证 HttpStatus: 401 Code: 300

未认证

当客户端向服务端发送请求没有携带有效的 X-MaiJ-Token 请求头时抛出该异常。

{
  "code": 300,
  "message": "Invalid token"
}

无权访问 HttpStatus: 403 Code: 301

无权访问

当客户端无访问所请求的资源的权限时抛出该异常。如果对于自己的 MaiJ API Token 所持有的权限有任何异议的话，请携相关信息和缘由联系本人。

{
  "code": 301,
  "message": "you don't have permission to access this resource"
}

服务端异常 HttpStatus: 500 Code: 999

服务端异常

当服务端出现未知错误时抛出该异常。

如果出现该异常响应，请携异常响应本身和大体的复现步骤联系本人。

{
  "code": 999,
  "message": "exception id: 3a6f0022-30ee-450c-b2a8-5513ca48fe93, please report it to the maintainer."
}