Skip to content

CMS_API

foxueyuan edited this page Aug 24, 2018 · 16 revisions

CMS API

目录

  1. 问答库
  2. 主题
  3. 知识库

问答库&知识库 线上资源对象结构

{
    "_id": "",
    "title": "",
    "topic": [],
    "question": [],
    "answer": ""
}

接口定义

content management system api

法律问题相关API


添加问题

  • 请求方式:

POST

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/questions

  • Header:
参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明
topic array 问题领域
title string 问题标题
question array 问题
answer string 答案

返回参数: 参数 是否必须 类型 说明 errcode 是 int 有结果返回0,非0则没有结果返回 errmsg 是 string errcode为0时返回ok,其他情况返回异常信息

请求示例:

{
    "questions": [
        {
            "topic": ["刑事辩护","民事诉讼"],
            "title": "故意杀人罪.我想知道他们能判多少年?",
            "question": ["我的朋友几个人喝了酒打架把人打死现在自首一个被抓一个其他都在逃,我想知道他们能判多少年","喝了酒打架把人打死能判多少年"],
            "answer": "故意杀人的,处死刑、无期徒刑或者十年以上有期徒刑;情节较轻的,处三年以上十年以下有期徒刑"  
        },
        {
            "topic": ["刑事辩护"],
            "title": "盗窃罪五万左右判多久",
            "question": ["盗窃罪五万左右判多久"],
            "answer": "再无其他犯罪情形的情况下,三年以上七年以下,五万元当在5-6年左右。"  
        }
    ]
}

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

查询问题

  • 请求方式:

GET

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/questions?topic=<topic_string>&title=<title_string>&question=<question_string>&answer=<answer_string>&scroll_id=<scroll_id>

  • 说明 分页为深分页,由于条数过多浅分页会造成OOM,深分页不能回退。分页参数scroll_id,默认分页是20,目前不开放修改 分页数据缓存10分钟,10分钟之后重新缓存,在10分钟之内编辑的数据不能被查询到。
  1. step1 初始化 获取到 scroll_id
  2. step2 查询 传入scroll_id
  3. step3 查询到最后返回[] 并销毁 scroll_id
  • Header:
参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明
topic string 问题类型
title string 问题标题
question string 问题问句
answer string 问题答案
scroll_id string 用作ES分页,第一次请求时不需要加此参数,下一页开始每次都需要加上该属性

请求示例:

1.初始化: http://dev-foai.foschool.cn/cms/v1/questions?topic=刑事辩护

返回示例:

{
    "questions": [
        {
            "_id": "AWIyyRtn7YT7ZlJSzG5h",
            "topic": ["刑事辩护"],
            "title": "故意杀人罪.我想知道他们能判多少年?",
            "question": ["我的朋友几个人喝了酒打架把人打死现在自首一个被抓一个其他都在逃,我想知道他们能判多少年?"],
            "answer": "故意杀人的,处死刑、无期徒刑或者十年以上有期徒刑;情节较轻的,处三年以上十年以下有期徒刑"  
        },
        {
            "_id": "AWIyyRtn7YT7ZlJSzG5m",
            "topic": ["刑事辩护"],
            "title": "盗窃罪五万左右判多久",
            "question": ["盗窃罪五万左右判多久"],
            "answer": "再无其他犯罪情形的情况下,三年以上七年以下,五万元当在5-6年左右。"  
        }
    ],
    "scroll_id": "DnF1ZXJ5VGhlbkZldGNoBgAAAAAAAt15FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdehZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3XsWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAAAt18FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdfRZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3X4WWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQ==",
    "total": 8058
}

2.下一页: http://dev-foai.foschool.cn/cms/v1/questions?topic=刑事辩护&scroll_id=DnF1ZXJ5VGhlbkZldGNoBgAAAAAAAt15FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdehZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3XsWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAAAt18FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdfRZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3X4WWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQ==

返回示例:

{
    "questions": [
        {
            "_id": "AWIyyRtn7YT7ZlJSzG5h",
            "topic": ["刑事辩护"],
            "title": "故意杀人罪.我想知道他们能判多少年?",
            "question": ["我的朋友几个人喝了酒打架把人打死现在自首一个被抓一个其他都在逃,我想知道他们能判多少年?"],
            "answer": "故意杀人的,处死刑、无期徒刑或者十年以上有期徒刑;情节较轻的,处三年以上十年以下有期徒刑"  
        },
        {
            "_id": "AWIyyRtn7YT7ZlJSzG5m",
            "topic": ["刑事辩护"],
            "title": "盗窃罪五万左右判多久",
            "question": ["盗窃罪五万左右判多久"],
            "answer": "再无其他犯罪情形的情况下,三年以上七年以下,五万元当在5-6年左右。"  
        }
    ],
    "scroll_id": "DnF1ZXJ5VGhlbkZldGNoBgAAAAAAAt15FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdehZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3XsWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAAAt18FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdfRZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3X4WWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQ==",
    "total": 8058
}

3.结束: http://dev-foai.foschool.cn/cms/v1/questions?topic=刑事辩护&scroll_id=DnF1ZXJ5VGhlbkZldGNoBgAAAAAAAt15FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdehZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3XsWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAAAt18FlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAALdfRZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAC3X4WWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQ==

返回示例:

{
    "questions": [],
    "scroll_id": "",
    "total": 8058
}

通过ID查询问题

  • 请求方式:

GET

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/questions/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息
data dict errcode为0时返回查询结果
  • data说明:
参数 是否必须 类型 说明
_id string 返回结果ID
answer string answer
question array question
title string title
topic array topic

请求示例:http://dev-foai.foschool.cn/cms/v1/questions/AWTk052eH5zGG77qDcj8

返回示例:

{
    "data": {
            "_id": "AWThU-NhH5zGG77qCt8W",
            "answer": "可以让对方起诉。",
            "question": ["您好!在2011年2月份前妻按揭买了一套新住房,户名是她,首付是岳父给的钱,办理银行贷款时我也签了字。在当年4月份她提出离婚,我同意离了婚,当时在离婚协议书上说明房子是属于她父亲的。就一直没有联系,直到前几天,她说要卖掉房子要我去签字,我没去理她,她就说去法院起诉我。不知道我有没有法律义务去给她卖房签字,如我一直不理睬可要承担什么法律责任?"],
            "title": "房产纠纷起诉怎么办?",
            "topic": ["房产纠纷"]
    },
    "errcode": 0,
    "errmsg": "ok"
}

修改问题

  • 请求方式:

POST(**HTTPS**)

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/questions/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • body:
参数 是否必须 类型 说明
topic array 问题领域
title string 问题标题
question array 问题
answer string 答案
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息

请求示例: http://dev-foai.foschool.cn/cms/v1/questions/AWIyuqeG7YT7ZlJSzFnD

{
      "answer": "根据合同约定处理,发生争议不能协商解决,可以申请劳动仲裁。"
}

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

删除问题

  • 请求方式:

DELETE(**HTTPS**)

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/questions/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • body:
参数 是否必须 类型 说明
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息

请求示例: http://dev-foai.foschool.cn/cms/v1/questions/AWIyuqeG7YT7ZlJSzFnD

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

问答库主题API


添加主题

  • 请求方式:

POST

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/topics

  • Header:
参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明
topic string 问题领域

返回参数: 参数 是否必须 类型 说明 errcode 是 int 有结果返回0,非0则没有结果返回 errmsg 是 string errcode为0时返回ok,其他情况返回异常信息

请求示例: POST http://dev-foai.foschool.cn/cms/v1/topics

{
    "topics": [
        {
            "topic": "婚姻家事"
        },{
            "topic": "员工纠纷"
        },{
            "topic": "交通事故"
        },{
            "topic": "企业人事"
        },{
            "topic": "民间借贷"
        },{
            "topic": "公司财税"
        },{
            "topic": "房产纠纷"
        },{
            "topic": "知识产权"
        },{
            "topic": "刑事犯罪"
        },{
            "topic": "消费维权"
        }
    ]
}

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

列出所有问题主题

  • 请求方式:

GET

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/topics

  • Header:
参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明

请求示例:GET http://dev-foai.foschool.cn/cms/v1/topics

返回示例:

[
    {
        "_id": "AWVOQmoWH5zGG77qDgM6",
        "topic": "知识产权"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgM0",
        "topic": "员工纠纷"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgM1",
        "topic": "交通事故"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgMz",
        "topic": "婚姻家事"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgM2",
        "topic": "企业人事"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgM4",
        "topic": "公司财税"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgM3",
        "topic": "民间借贷"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgM5",
        "topic": "房产纠纷"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgM7",
        "topic": "刑事犯罪"
    },
    {
        "_id": "AWVOQmoWH5zGG77qDgM8",
        "topic": "消费维权"
    }
]

通过ID查询主题

  • 请求方式:

GET

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/topics/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息
data dict errcode为0时返回查询结果
  • data说明:
参数 是否必须 类型 说明
_id string 返回结果ID
topic string 返回主题

请求示例:http://dev-foai.foschool.cn/cms/v1/topics/AWVOQmoWH5zGG77qDgM0

返回示例:

{
    "data": {
        "_id": "AWVOQmoWH5zGG77qDgM0",
        "topic": "员工纠纷"
    },
    "errcode": 0,
    "errmsg": "ok"
}

修改主题

  • 请求方式:

POST(**HTTPS**)

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/topics/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • body:
参数 是否必须 类型 说明
topic string 问题领域
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息

请求示例: POST http://dev-foai.foschool.cn/cms/v1/topics/AWIyuqeG7YT7ZlJSzFnD

{
      "topic": "婚姻问题"
}

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

删除主题

  • 请求方式:

DELETE(**HTTPS**)

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/topics/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • body:
参数 是否必须 类型 说明
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息

请求示例: DELETE http://dev-foai.foschool.cn/cms/v1/topics/AWIyuqeG7YT7ZlJSzFnD

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

知识库相关API


增加法律问题

  • 请求方式:

POST

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/laws

  • Header:
参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明
title string 问题标题
question array 问题 example:["问题1","问题2"]
answer string 答案
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息

请求示例:

{
    "questions": [
       {
            "answer": "离婚后,男女双方自愿恢复夫妻关系的,必须到婚姻登记机关进行复婚登记。",
            "question": ["你知道婚姻法第三十五条吗"],
            "title":"你知道婚姻法第三十五条吗"
        },
        {
            "answer": "离婚后,一方抚养的子女,另一方应负担必要的生活费和教育费的一部或全部,负担费用的多少和期限的长短,由双方协议;协议不成时,由人民法院判决。关于子女生活费和教育费的协议或判决,不妨碍子女在必要时向父母任何一方提出超过协议或判决原定数额的合理要求。",
            "question": ["你想知道婚姻法第三十七条是什么"]
            "title":"你想知道婚姻法第三十七条是什么"
        },
    ]
}

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

查询法律问题

  • 请求方式:

GET

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/laws?title=<title_string>&question=<question_string>&answer=<answer_string>&scroll_id=<scroll_id>

  • 说明 分页为深分页,由于条数过多浅分页会造成OOM,深分页不能回退。分页参数scroll_id,默认分页单页条数是20,目前不开放修改,缓存失效5分钟 获取数据步骤和问答库相同

  • Header:

参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明
title string 问题标题
question array 问题 example:["问题1","问题2"]
answer string 答案
scroll_id string 用作ES分页,第一次请求时不需要加此参数,下一页开始每次都需要加上该属性

请求示例:

1.初始化: http://dev-foai.foschool.cn/cms/v1/laws?question=婚姻法

返回示例:

{
    "questions": [
        {
            "_id": "AWTxME6ZH5zGG77qDeYv",
            "answer": "对简单的民事案件,原告可以口头起诉。当事人双方可以同时到基层人民法院或者它派出的法庭,请求解决纠纷。基层人民法院或者它派出的法庭可以当即审理,也可以另定日期审理。",
            "question": ["民事诉讼法第一百五十八条","民事诉讼法第一百五十八条是什么","讲一下民事诉讼法第一百五十八条"]
            "title":"民事诉讼法第一百五十八条"
        },
        {
            "_id": "AWTxME6ZH5zGG77qDeYz",
            "answer": "基层人民法院和它派出的法庭审理符合本法第一百五十七条第一款规定的简单的民事案件,标的额为各省、自治区、直辖市上年度就业人员年平均工资百分之三十以下的,实行一审终审。",
            "question": ["民事诉讼法第一百六十二条","民事诉讼法第一百六十二条是什么","讲一下民事诉讼法第一百六十二条"]
            "title":"民事诉讼法第一百六十二条"
        }
    ],
    "scroll_id": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAALpbrFlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAC6W7RZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAuluwWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAALpbuFlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAC6W7xZaRi0zc0JTRFRVLUViemNQa2pEalVB",
    "total": 160
}

2.下一页: http://dev-foai.foschool.cn/cms/v1/laws?question=婚姻法&scroll_id=DnF1ZXJ5VGhlbkZldGNoBQAAAAAALpbrFlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAC6W7RZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAuluwWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAALpbuFlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAC6W7xZaRi0zc0JTRFRVLUViemNQa2pEalVB

返回示例:

{
    "questions": [
         {
            "_id": "AWTxME6ZH5zGG77qDeXy",
            "answer": "调解达成协议,人民法院应当制作调解书。调解书应当写明诉讼请求、案件的事实和调解结果。调解书由审判人员、书记员署名,加盖人民法院印章,送达双方当事人。调解书经双方当事人签收后,即具有法律效力。",
            "question": ["民事诉讼法第九十七条","民事诉讼法第九十七条是什么","讲一下民事诉讼法第九十七条"],
            "title": "民事诉讼法第九十七条"
        },
        {
            "_id": "AWTxME6ZH5zGG77qDeX0",
            "answer": "调解未达成协议或者调解书送达前一方反悔的,人民法院应当及时判决。",
            "question": ["民事诉讼法第九十九条","民事诉讼法第九十九条是什么","讲一下民事诉讼法第九十九条"],
            "title":"民事诉讼法第九十九条"
        }
    ],
    "scroll_id": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAALpbrFlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAC6W7RZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAuluwWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAALpbuFlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAC6W7xZaRi0zc0JTRFRVLUViemNQa2pEalVB",
    "total": 160
}

3.结束: http://dev-foai.foschool.cn/cms/v1/laws?question=婚姻法&scroll_id=DnF1ZXJ5VGhlbkZldGNoBQAAAAAALpbrFlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAC6W7RZaRi0zc0JTRFRVLUViemNQa2pEalVBAAAAAAAuluwWWkYtM3NCU0RUVS1FYnpjUGtqRGpVQQAAAAAALpbuFlpGLTNzQlNEVFUtRWJ6Y1BrakRqVUEAAAAAAC6W7xZaRi0zc0JTRFRVLUViemNQa2pEalVB

返回示例:

{
    "questions": [],
    "scroll_id": ",
    "total": 160
}

通过ID查询法律问题

  • 请求方式:

GET

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/laws/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • 请求参数:
参数 是否必须 类型 说明
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息
data dict errcode为0时返回查询结果
  • data说明:
参数 是否必须 类型 说明
_id string 返回结果ID
answer string answer
question array question example:["婚姻法是什么","婚姻法"]
title string title
请求示例:http://dev-foai.foschool.cn/cms/v1/laws/AWTxMFAIH5zGG77qDewp

返回示例:

{
    "data": {
        "_id": "AWTxMFAIH5zGG77qDewp",
        "answer": "《中华人民共和国婚姻法 》全文共分为6章,包括总则、结婚、 家庭关系、离婚、救助措施与法律责任、附则,共51条。",
        "question": ["婚姻法是什么","婚姻法","说一说婚姻法","讲一下婚姻法"],
        "title":"婚姻法是什么"
    },
    "errcode": 0,
    "errmsg": "ok"
}

修改法律条文

  • 请求方式:

POST(**HTTPS**)

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/laws/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • body:
参数 是否必须 类型 说明
title string 问题标题
question array 问题 example: ["婚姻法是什么","婚姻法"]
answer string 答案
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息

请求示例: http://dev-foai.foschool.cn/cms/v1/law/AWTk052eH5zGG77qDcj8

{
     "answer": "人民法院审理民事案件,必须以事实为根据,以法律为准绳。",
     "question": "民事诉讼法第七条",
     "title":"民事诉讼法第七条"
}

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

删除法律条文

  • 请求方式:

DELETE(**HTTPS**)

  • 请求地址:

http://dev-foai.foschool.cn/cms/v1/laws/<_id>

  • Header:
参数 是否必须
Content-Type application/json
  • body:
参数 是否必须 类型 说明
  • 返回参数:
参数 是否必须 类型 说明
errcode int 有结果返回0,非0则没有结果返回
errmsg string errcode为0时返回ok,其他情况返回异常信息

请求示例: http://dev-foai.foschool.cn/cms/v1/law/AWTk052eH5zGG77qDcj8

返回示例:

{
    "errcode": 0,
    "errmsg": "ok"
}

Clone this wiki locally