基本概述

• 基于HTTP协议的RESTful软件架构风格

• 基本语法 【domain】/【class】/【ResourceName】/limit=【LimitNum】&skip=【SkipNum】&filter-【ColumName】-【WhereType】-【ColumnType】=【value】&sort=【SortDesc】&field=【Field】&zip=【Zip】&distinct=【Field】

参数说明

参数名 含义 样例说明
domain 服务地址 zlink.genius.com.cn
Class 数据分类 Base
ResourceName 资源名称 STK_CHART_STK_TRD_STAT
LimitNum 记录总数(最大1000)若获取所有数据通过分页取值 zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/limit=5表示从STK_CHART_STK_TRD_STAT中取顺序前5条记录
SkipNum 开始位置(skip=0表示从第一条记录开始)

zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/limit=5&skip=5

表示从STK_CHART_STK_TRD_STAT中取顺序第6-10条记录

ColumnName 属性名(字段名称)

zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/filter-STK_CODE-str=603258&limit=5

表示从STK_CHART_STK_TRD_STAT中取STOCK_CODE值为603258的前5条记录

WhereType

筛选条件方式:

1. gt表示大于

2. lt表示小于

3. gte表示大于等于

4. lte表示小于等于

5. 不填表示等于(默认)

6. ne表示不等于

7. in表示属于指定集合

8. nin表示不属于指定集合

zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/filter-STK_CODE-str=603258&limit=5&filter-SELL_VALUE-gt-int=0

表示从STK_CHART_STK_TRD_STAT中取SELL_VALUE属性值大于0的前5条记录

ColumnType

属性类型

1. str 字符型

2. int 数值型

3. dt 日期型

4. float 浮点型

zlink.genius.com.cn/base/FND_NET_VAL/full=2&filter-FUNDCODE-str=000001&filter-ENDDATE-dt=2013-12-16

表示从FND_NET_VAL中取FUNDCODE属性等于000001 而且ENDDATE等于2013-12-16记录

日期格式如:2010-4-12 或者 2010-4-12 9:30:00

SortDesc

排序规则

1.升序(默认不用填)

2.desc 降序

zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/filter-STK_CODE-str=603258&sort=TRADEDATEdesc

表示从STK_CHART_STK_TRD_STAT中按照TRADEDATE为第一排序属性(降序)

full

1. 简单的js反写数据格式(默认)

2. 完整的js反写数据格式(full=1)

3. 完整的json数据(full=2)

4. xml数据(full=3)

完整的数据格式包含:

开始位置 offset

总记录数 total_rows

查询结果集 rows

查询耗时 millis (毫秒)

zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/full=2&limit=5

表示从STK_CHART_STK_TRD_STAT中取顺序前5条记录,返回json格式

field 指定返回结果的属性,多个属性以”,”符号分割

zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/full=4&limit=5&field=STK_INNER_CODE,RANK_NUM

表示从STK_CHART_STK_TRD_STAT中取顺序前5条记录,并且获取总记录数,只返回STK_INNER_CODE,RANK_NUM两个属性

Zip

指定数据是否需要进行二进制压缩传输,目前支持的Type有:

1. Zip=Gzip

zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/limit=5&zip=Gzip

表示从数据将用二进制Gzip方式压缩传输

Distinct

数据替重

1.当使用了Distinct属性后Field和limit以及Count不再起作用, 会进行全集合的输出

2.Distinct只支持一个字段的替重

zlink.genius.com.cn/base/STK_CHART_STK_TRD_STAT/distinct=STK_INNER_CODE

表示从STK_CHART_STK_TRD_STAT中取STK_INNER_CODE的所有结果集

File 调取静态文件数据

http://[domain]/[file]/filename

http://zlink.genius.com.cn/file/0000000000000i5g0r

服务状态码

基本说明:

Zlink遵循HTTP协议,完全兼容HTTP状态码,同时根据业务需要,自定义业务状态码。

HTTP协议状态码在HTTP协议头部体,自定义业务状态码在返回的数据体内。关键词[errorcode],[errorMessage]在实际的使用过程中,首先通过http状态码判断服务状态,其次通过反馈数据体中是否有errorcode来判断数据是否正常。

客服端模式:

系统级别错误码参照(http协议体头部)

错误码 说明
403 没有权限
400 URL不符合规则
200 正常

业务级别错误码参照:

错误码 说明
100451 该资源不存在
100551 查询资源失败,请联系管理员
100552 格式化结果失败,请联系管理员
100553 系统异常,请检查url是否错误
100554 请输入查询参数,例如:limit=1
100555 该请求无权限
100556 验证请求出现异常
100557 验证信息出错,请求次数超限,请联系客服
100558 计数出现异常

直接模式:

错误码 说明
100451 该资源不存在
100551 查询资源失败,请联系管理员
100552 格式化结果失败,请联系管理员
100553 系统异常,请检查url是否错误
100554 请输入查询参数,例如:limit=1
100555 该请求无权限
100556 验证请求出现异常
100557 验证信息出错,请求次数超限,请联系客服
100558 计数出现异常

服务器码样例: