freearch/get
目录 |
1.接口说明
1.1接口描述
获取单个自由项信息
1.2适用版本
支持U8V12.0 及更高版本
2.使用场景
基础数据同步或前端展示
3.接口调用说明
3.1请求说明
| url | https://api.yonyouup.com/api/freearch/get |
| 格式 | JSON |
| https请求方式 | GET |
| 编码类型 | UTF-8 |
3.2url参数说明
| 参数 | 是否必填 | 类型 | 描述 |
|---|---|---|---|
| from_account | 是 | string | 调用方id |
| to_account | 是 | string | 提供方id |
| app_key | 是 | string | 应用编码 |
| token | 是 | string | 全局访问唯一识别码 |
| ds_sequence | 否 | number | 数据源序号（默认取应用的第一个数据源） |
| id | 是 | string | 自定义项标识，格式“cfree?”?=[1-10] |
3.3请求示例
GET https://api.yonyouup.com/api/freearch/get?from_account=openapi_dev&to_account=openapi_ent&app_key=opa6fdd4bea98b95ad7&token=843d03f66e6544e19707ccec11030296&id=0000000017&ds_sequence=1
3.4返回参数说明
| 参数说明 | 类型 | 参数路径 | 描述 |
|---|---|---|---|
| errcode | string | 错误码，0 为正常。 | |
| errmsg | string | 错误信息。 | |
| item | string | 自由项名 | |
| item_name | string | 定义的自由项名 | |
| field_name | string | 字段名 | |
| value | string | 自定义项或自由项值 | |
| alias | string | 代码 |
3.5正确返回示例
JSON示例:
application/json;charset=UTF-8
{
"errmsg":"",
"errcode":"0",
"freearch":[
{
"field_name":"cFree9",
"alias":"04",
"item_name":"颜色",
"item":"自由项9",
"value":"black"
},
{
"field_name":"cFree9",
"alias":"01",
"item_name":"颜色",
"item":"自由项9",
"value":"白色"
}
]
}
3.6错误返回示例
application/json;charset=UTF-8
{
"errcode" : "30021",
"errmsg" : "此应用未上线"
}