resources.md 14.4 KB

Raw Blame History Permalink



资源位接口定义


查询资源


/resources/query


入参


参数名
必填
类型
示例值
描述


name
否
string
男首页
资源名称


sortId
否
int
2
分类编号


platformId
否
int
1
平台编号


page
否
int
1
页数


返回

{
    "code": 200,
    "data": {
        "list": [],
        "page": 2,
        "plat_list": [
            {
                "createTime": 1430300615,
                "platformFlag": "iphone",
                "platformId": 1,
                "platformName": "yohoApp",
                "status": 0
            }
        ],
        "resources_list": [
            {
                "code": "02568b6042510e4be739cc688dc7d6ae",
                "createTime": 1444448085,
                "id": 279,
                "name": "逛.pc网站首页右侧广告位（创意生活）",
                "platformId": 5,
                "platformName": "web",
                "sortId": 4,
                "sortName": "逛列表页"
            }
        ],
        "size": 10,
        "sort_id": 4,
        "sort_list": [
            {
                "createTime": 1430304722,
                "platformId": 1,
                "sortId": 2,
                "sortName": "男首",
                "status": 1
            }
        ],
        "total": 15,
        "totalPage": 2
    },
    "md5": "c88f34a1ec20168782345b0c6754b83d",
    "message": "操作成功"
}


-----------------------------
|参数名     |描述           |
|------     |----           |
|total      |总条数         |
|totalPage  |总页数         |
|size       |每页显示条数|
|page       |当前所在页码|
|sort_id    |入参传递的sortId|
|plat_id    |入参传递的platformId|
|sort_id    |入参传递的sortId|
|resources_list|资源列表|
|plat_list|平台列表|
|sort_list|分类列表|

resources_list:

    |id         |资源编号       |
    |name       |资源名称       |
    |sortId     |分类编号       |
    |sortName   |分类名称       |
    |platformId |平台编号       |
    |platformName|平台名称      |
    |matchCode  |配对码         |
    |createTime |创建时间       |

plat_list：    
    -----------------------------
    |参数名     |描述           |
    |------     |----           |
    |platformId |平台编号       |
    |platformName|平台名称      |
    |platformFlag|平台标识      |
    |createTime |创建时间       |
    |status     |状态码         |
sort_list：
    -----------------------------
    |参数名     |描述           |
    |------     |----           |
    |platformId |平台编号       |
    |sortName|分类名称|      |
    |sortId|分类Id      |
    |createTime |创建时间       |
    |status     |状态码         |


###资源管理编辑页面


'/resources/resourcesEditPage'


###入参


参数名
必填
类型
示例值
描述


id
是
int
8
资源id


###返回
{
    "code": 200,
    "data": {
        "plat_list": [
            {
                "createTime": 1430300615,
                "platformFlag": "iphone",
                "platformId": 1,
                "platformName": "yohoApp",
                "status": 1
            }
        ],
        "row": {
            "code": "201504091403001",
            "createTime": 1430378310,
            "id": 8,
            "matchCode": "",
            "name": "男首页",

        "platformId": 1,

    },
    "sort_list": [
        {
            "createTime": 1430304722,
            "platformId": 1,
            "sortId": 2,
            "sortName": "男首",
            "status": 1
        }
    ]
},
"md5": "1a6475d5d666454d1db9c1749e3511e0",
"message": "操作成功"


}

plat_list：    
    -----------------------------
    |参数名     |描述           |
    |------     |----           |
    |platformId |平台编号       |
    |platformName|平台名称      |
    |platformFlag|平台标识      |
    |createTime |创建时间       |
    |status     |状态码         |
sort_list：
    -----------------------------
    |参数名     |描述           |
    |------     |----           |
    |platformId |平台编号       |
    |sortName|分类名称|      |
    |sortId|分类Id      |
    |createTime |创建时间       |
    |status     |状态码         |
row:
    |id         |资源编号       |
    |name       |资源名称       |
    |sortId     |分类编号       |
    |platformId |平台编号       |
    |matchCode  |配对码         |
    |createTime |创建时间       |


###资源新增页面


'/resources/resourcesAddPage'


###返回
{
    "code": 200,
    "data": {
        "plat_list": [
            {
                "createTime": 1430300615,
                "platformFlag": "iphone",
                "platformId": 1,
                "platformName": "yohoApp",
                "status": 1
            }
        ],
        "sort_list": [
            {
                "createTime": 1430304722,
                "platformId": 1,
                "sortId": 2,
                "sortName": "男首",
                "status": 1
            }
        ]
    },
    "md5": "1a6475d5d666454d1db9c1749e3511e0",
    "message": "操作成功"
}

plat_list：    
    -----------------------------
    |参数名     |描述           |
    |------     |----           |
    |platformId |平台编号       |
    |platformName|平台名称      |
    |platformFlag|平台标识      |
    |createTime |创建时间       |
    |status     |状态码         |
sort_list：
    -----------------------------
    |参数名     |描述           |
    |------     |----           |
    |platformId |平台编号       |
    |sortName|分类名称|      |
    |sortId|分类Id      |
    |createTime |创建时间       |
    |status     |状态码         |


###通过id删除资源
    >'resources/deleteResourceById'
    ####入参
    -----------------------------------------------------------
    |参数名     |必填 |类型       |示例值     |描述           |
    |------     |---- |----       |------     |----           |
    |id     |是   |int         |614         |资源id      |
    ####返回
    {
        "code": 200,
        "data": [],
        "md5": "d751713988987e9331980363e24189ce",
        "message": "删除成功."
    }

###新增/修改资源
    >'/resources/saveResource'
    ####入参
    -----------------------------------------------------------
    |参数名     |必填 |类型       |示例值     |描述           |
    |id         |否   |int        |-1         |如果为空或者小于0为新增，否则为修改操作
    |name       |是   |string     |男首页     |资源名称       |
    |sortId     |是   |int        |2          |分类编号       |
    |platformId |是   |int        |1          |平台编号       |
    |matchCode  |否   |String        |1          |页数           |

####返回
{
    "code": 200,
    "message": "资源添加成功!"
}


查询所有的资源分类

> `/resources/sorts`

#### 返回

``` json
{
    "code": 200,
    "data": [
    {
        "createTime": 1457505339,
        "platformId": 1,
        "sortId": 56,
        "sortName": "灰度测试2",
        "status": 1
    }
    ],
    "md5": "8909cda6f96b76b94b60451c4931fc94",
    "message": "操作成功"
}

```
-----------------------------
|参数名     |描述           |
|------     |----           |
|sortId     |分类编号       |
|sortName   |分类名称       |
|platformId |平台编号       |
|createTime |创建时间       |
|status     |状态码         |


###新增资源分类
    >'/resources/addResourcesSort'
    ####入参
    -------------------------
    |属性名称|类型|例子|说明| 
    |--------|----|----|----|
    |sortName|String|ipad|资源分类名称 必传|
    |platformId|int|5|平台id 必传|
    |status|byte|1|是否启用|
    #####返回
    {
        "code": 200,
        "data": [],
        "md5": "d751713988987e9331980363e24189ce",
        "message": "添加成功."
    }

###通过资源分类id获取编辑页面需要的信息（List 和 ResourcesSort）
    >'/resources/getResourcesSortEditViewById'
    ###入参
    |属性名称|类型|例子|说明| 
    |--------|----|----|----|
    |sortId|int|11|平台id 必传|
    ####返回
    {
        "code": 200,
        "data": {
        "
        platformResult": [
            {
            "createTime": 1430300615,
            "platformFlag": "iphone",
            "platformId": 1,
            "platformName": "yohoApp",
            "status": 1
            },
            {
            "createTime": 1430735334,
            "platformId": 5,
            "platformName": "web",
            "status": 1
            }
        ],
        "result": {
            "createTime": 1431502682,
            "platformId": 1,
            "sortId": 10,
            "sortName": "test",
            "status": 0
        }
        },
        "md5": "02a6f8de8401b8b835223ae0f441e7e2",
        "message": "操作成功"
    }

 返回platformResult     result
platformResult：   
    -----------------------------
    |参数名     |描述           |
    |------     |----           |
    |platformId |平台编号       |
    |platformName|平台名称      |
    |platformFlag|平台标识      |
    |createTime |创建时间       |
    |status     |状态码         |
result：
    -----------------------------
    |参数名     |描述           |
    |------     |----           |
    |platformId |平台编号       |
    |sortName|分类名称|      |
    |sortId|分类Id      |
    |createTime |创建时间       |
    |status     |状态码         |


###查询资源分类首页列表
    >'/resources/resourcesSortIndex'
    入参：无
    返回：
    {
        "code": 200,
        "data": {
        "platform": [
            {
            "createTime": 1430300615,
            "platformFlag": "iphone",
            "platformId": 1,
            "platformName": "yohoApp",
            "status": 1
            }
        ],
        "result": [
            {
            "createTime": 1430304722,
            "platformId": 1,
            "sortId": 2,
            "sortName": "男首",
            "status": 1
            }
        ]
        },
        "md5": "ff6d0788a93de7a134aee28e3798eb17",
        "message": "操作成功"
    }

    platform： 
        -----------------------------
        |参数名     |描述           |
        |------     |----           |
        |platformId |平台编号       |
        |platformName|平台名称      |
        |platformFlag|平台标识      |
        |createTime |创建时间       |
        |status     |状态码         |
    result：
        -----------------------------
        |参数名     |描述           |
        |------     |----           |
        |platformId |平台编号       |
        |sortName|分类名称|      |
        |sortId|分类Id      |
        |createTime |创建时间       |
        |status     |状态码         |


###修改资源分类
    >'/resources/updateResourcesSort'
    ####入参
    |属性名称|类型|例子|说明| 
    |--------|----|----|----|
    |sortId|int|7|平台id 必传|
    |sortName|String|ipad|资源分类名称 必传|
    |platformId|int|5|平台id 必传|
    |status|byte|1|是否启用|

#####返回
{
    "code": 200,
    "data": [],
    "md5": "d751713988987e9331980363e24189ce",
    "message": "修改成功."
}


###删除分类
    >'/resources/deleteResourcesSort'
    ####入参
    |属性名称|类型|例子|说明| 
    |--------|----|----|----|
    |sortId|int|11|平台id 必传|
    ####返回
   {
    "code": 200,
    "data": [],
    "md5": "d751713988987e9331980363e24189ce",
    "message": "删除成功."
}


查询所有的平台

>  `/resources/platforms`

#### 入参

#### 返回

``` json
{
"code": 200,
"data": [
    {
        "createTime": 1430300615,
        "platformFlag": "iphone",
        "platformId": 1,
        "platformName": "yohoApp",
        "status": 1
    }
],
"md5": "b01118ada14ad7204d1182c3fa75563a",
"message": "操作成功"


}

```
-----------------------------
|参数名     |描述           |
|------     |----           |
|platformId |平台编号       |
|platformName|平台名称      |
|platformFlag|平台标识      |
|createTime |创建时间       |
|status     |状态码         |


###根据id查询平台
    >'/resources/getPlatformById'
    ####入参
        |属性名称|类型|例子|说明| 
        ||platformId|int|11|平台|

####返回
{
"code": 200,
"data": {
    "createTime": 1457587192,
    "platformFlag": "xxsdas",
    "platformId": 11,
    "platformName": "windows",
    "status": 1
},
"md5": "ebbcef62c9233fafd1d9cc357b72aef3",
"message": "操作成功"


}

-----------------------------
|参数名     |描述           |
|------     |----           |
|platformId |平台编号       |
|platformName|平台名称      |
|platformFlag|平台标识      |
|createTime |创建时间       |
|status     |状态码         |


###添加平台
    >'/resources/addPlatform'
    ####入参
        |属性名称|类型|例子|说明| 
        |--------|----|----|----|
        |platformName|String|ipad|平台名称 必传|
        |platformFlag|String|ipad|平台标识|
        |status|byte|1|是否启用 必传|
    ####返回

{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "添加成功."


}

###通过id更新平台
    >'resources/updatePlatform'
    ####入参
        |属性名称|类型|例子|说明| 
        |--------|----|----|----|
        |platformId|int|ipad|平台名称 必传|
        |platformName|String|ipad|平台名称 必传|
        |platformFlag|String|ipad|平台标识|
        |status|byte|1|是否启用 必传|
    ####返回
    {
    "code": 200,
    "data": [],
    "md5": "d751713988987e9331980363e24189ce",
    "message": "修改成功."
    }

###通过id删除平台
    >'resources/deletePlatform'
    ####入参
        |属性名称|类型|例子|说明| 
        |--------|----|----|----|
        |platformId|int|ipad|平台名称 必传|

    ####返回
    {
    "code": 200,
    "data": [],
    "md5": "d751713988987e9331980363e24189ce",
    "message": "删除成功."
    }