新版文轩API文档首页 >> 通用说明

通用说明

通用参数说明

以下说明在每个API请求中都可包含的参数.

|参数|意义|备注| |:-----|:-----|:-----| |format|返回值格式默认值为JSON|通过该参数，你可改变返回值的格式，目前支持的返回值暂只支持JSON| |page |返回多个元素时，起始页的下标|下标从1开始，默认值1| |size |每页最大结果数|除非特别说明，size的最大值为50，参数值超过50将只返回50个结果，默认值为20| |method|HTTP请求方法重载参数|如果第三方应用不能完整支持PUT、DELETE操作时，可通过POST加请求参数_method=put的方式发送请求，服务将自动转换POST请求为PUT请求|

返回状态说明

文轩网API通过HTTP Status Code来说明API请求是否成功，下面的表格中展示了可能的HTTP Status Code以及其含义

|状态码|描述| |:------|:-----| |200 OK |请求成功 | |201 CREATED|创建成功 | |202 ACCEPTED|更新成功 | |400 BAD REQUEST|请求的地址不存在或者包含不支持的参数| |401 UNAUTHORIZED|未授权 | |403 FORBIDDEN|被禁止的访问| |404 NOT FOUND|请求的资源不存在| |500 INTERNAL SERVER ERROR|内部错误 |

通用返回值说明

公共返回参数如下，其余返回参数由各个API自行决定，请参考具体API返回值说明

|参数名称|描述| |:-------|:-----| |state |通用状态对象，用于描述请求返回状态信息| |state.code|状态码，系统内部的状态标识，通常正常返回值0，请参考具体API的返回值说明| |state.msg|状态描述信息，与状态码相对应，通常正常返回值为"",请参考具体API的返回值| |state.details|详细描述信息，正常不返回此值，当API调用发生错误或业务不支持的操作时，返回此值| |pagination|当集合类的API请求返回时返回此对象，此对象包含分页的相关信息| |pagination.pageSize|每页所包含记录数| |pagination.count|总记录数 | |pagination.pageCount|总页数 | |pagination.currentPage|当前页 |

新版文轩API文档首页 >> 通用说明