场景管理相关接口文档说明

说明

1. 本系统所有接口均为HTTP请求

2. 用户登录验证成功后，系统将返回Token，后续访问其他接口时，前端需要通过token查询参数携带Token。

3. 接口URL中`:`说明：如果接口中包含冒号，则说明其后的字段为一个参数。例如接口URL： /user/idencode/:telphone 中的`telphone`则表示为一个参数，在实际使用此接口时需要将其替换为具体的内容。

4. 不需要登录的接口如下：

    注册
    登录
    获取验证码

5. 参数字段中包含`?`的说明：如果参数字段以`?`结尾，那么说明此参数为可选参数。

场景相关

新增/更新场景

接口
    /freeserver-ocelot/scene/upsert

请求方式
    POST

参数类型
    application/json

参数
    {
        pid?: string,
        name: string,
        detail?: Object,
        share?:boolean
    }

    pid: 更新的场景的pid，不传则新建一个场景。

    name: 场景名字。
    
    detail:场景其他信息。
    
    share:是否公开，默认false不公开

返回结果
    
    正常：
        {"stat":0,"msg":"成功","val":pid}
    
    异常：
        {"stat":非0数字，"msg"："对应错误信息"}

查询单个场景的详细信息

接口
    /freeserver-ocelot/scene/getone/:pid

请求方式
    GET

参数 
    无

返回结果
    正常：
        {"stat":0, "msg":"成功", val:{pid, name, userid, createTime}}
    
    错误：
        {"stat":非0数字, "msg":"错误信息"}

获取全部场景

接口
     /freeserver-ocelot/scene/getall

请求方式
    POST

参数 
    {
        keyword?: string,
        offset?: number,
        pagecount: number，
        share?: boolean
    }

    keyword:获取包含关键字的所有场景（关键字根据name获取）

    offset: 分页的偏移量。其值为：(页数-1)*每页个数。默认值0.

    pagecount: 每页数量。默认值20
    
    share:true获取公开的场景，false获取非公开的场景，不传获取所有场景

返回结果
    正常：
        {"stat":0, "msg":"成功", val:[]}
    
    错误：
        {"stat":非0数字, "msg":"错误信息"}

获取全部场景个数

接口
     /freeserver-ocelot/scene/count

请求方式
    POST

参数 
    {
        keyword?: string
    }

    keyword： 搜索的关键字

返回结果
    正常：
        {"stat":0, "msg":"成功", val:场景个数}
    
    错误：
        {"stat":非0数字, "msg":"错误信息"}

删除一个场景

接口
     /freeserver-ocelot/scene/remove/:pid

请求方式
    GET

参数 
    无

返回结果
    正常：
        {"stat":0, "msg":"成功"}
    
    错误：
        {"stat":非0数字, "msg":"错误信息"}

获取accesskey分享后的url

接口
     /freeserver-ocelot/scene/getcapaurl
请求方式
    POST

参数 
    {
        pid: string,
        accesskey:string
    }

返回结果
    正常：
        {"stat":0, "msg":"成功", val:url}
    
    错误：
        {"stat":非0数字, "msg":"错误信息"}