OkayAPI Docs


API Path: /api/App/Guest_Set/GetList

API Description: 游客获取用户集合里的元素列表

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
uuidStringOptaionMIN: 32;MAX: 32UUID,全局唯一用户ID
tokenStringOptaionMIN: 64;MAX: 64会话凭证
other_uuidStringRequiredMIN: 32;MAX: 32游客针对的UUID,全局唯一用户ID
keyStringRequiredMIN: 1;MAX: 64集合名称
pageIntOptaion1MIN: 1第几页
perpageIntOptaion10MIN: 1;MAX: 1000分页数量
sortStringOptaion1MIN: 1;MAX: 6排序,1创建时间顺序,2创建时间逆序, 3权重顺序,4权重逆序,5更新时间顺序,6更新时间逆序;通过字符串拼接可组合排序,如41表示:权重逆序,创建时间顺序

API Debug

KEYREQUIREDVALUE
app_key *Required
uuid Option
token Option
other_uuid *Required
key *Required
page Option
perpage Option
sort Option

API Response

KEYTypeDescription
err_codeInt操作码,0获取成功
err_msgString错误提示信息,err_code非0时参考此提示信息
itemsArray元素列表
items[].idInt元素ID
items[].keyString键名
items[].dataObject条目数据
items[].keywordString关键字
items[].weightInt权重
items[].add_timeString添加时间,格式为:Y-m-d H:i:s
items[].update_timeString最后更新时间,格式为:Y-m-d H:i:s,若从未更新则为空
totalInt元素总数
pageInt当前第几页
perpageInt每页多少个

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error