智简魔方文档

PUT 保存前台导航

接口概览

项目内容
文档类型后台接口
请求方式PUT
接口地址/DIR_ADMIN/v1/menu/home
所属业务站点内容
来源模块/系统导航管理
认证方式Bearer Token(管理员令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

保存前台导航

请求体

json
正在加载示例…

请求参数

名称位置类型必选说明
bodybodyobject
menubody[object]菜单
menu.typebodystring菜单类型 system系统 plugin插件 custom自定义 module产品列表 embedded内嵌
menu.namebodystring名称
menu.languagebodyobject语言
menu.urlbodystring网址 菜单类型为自定义时需要传递
menu.second_reminderbodyinteger(int32)二次提醒 0否 1是 菜单类型为自定义时需要传递
menu.iconbodystring图标
menu.nav_idbodyinteger(int32)导航ID 菜单类型为系统或插件时需要传递
menu.modulebody[string]模块类型 菜单类型为产品列表时可以传递
menu.res_modulebody[string]res模块类型 菜单类型为产品列表时可以传递 云 whmcs_cloud mf_cloud mf_finance DCIM whmcs_dcim mf_dcim mf_finance_dcim 可以多选
menu.product_idbody[integer]商品ID 菜单类型为产品列表时需要传递
menu.is_cross_modulebodyinteger(int32)是否为跨模块列表 菜单类型为产品列表时可以传递
menu.select_fieldbody[string]选择字段 area=区域 product_name=商品名称 billing_cycle=计费方式 is_auto_renew=自动续费 base_info=基础信息 ip=IP os=OS active_time=开通时间 due_time=到期时间 status=状态 notes=备注 菜单类型为产品列表时可以传递
menu.childbody[object]子菜单
menu.child.typebodystring菜单类型 system系统 plugin插件 custom自定义 module产品列表 embedded内嵌
menu.child.namebodystring名称
menu.child.languagebodyobject语言
menu.child.urlbodystring网址 菜单类型为自定义时需要传递
menu.child.second_reminderbodyinteger(int32)二次提醒 0否 1是 菜单类型为自定义时需要传递
menu.child.iconbodystring图标
menu.child.nav_idbodyinteger(int32)导航ID 菜单类型为系统或插件时需要传递
menu.child.modulebody[string]模块类型 菜单类型为产品列表时可以传递
menu.child.res_modulebody[string]res模块类型 菜单类型为产品列表时可以传递
menu.child.product_idbody[integer]商品ID 菜单类型为产品列表时需要传递
menu.child.is_cross_modulebodyinteger(int32)是否为跨模块列表 菜单类型为产品列表时可以传递
menu.child.select_fieldbody[string]选择字段 area=区域 product_name=商品名称 billing_cycle=计费方式 is_auto_renew=自动续费 base_info=基础信息 ip=IP os=OS active_time=开通时间 due_time=到期时间 status=状态 notes=备注 菜单类型为产品列表时可以传递

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束说明
statusinteger(int32)状态码
msgstring提示信息
dataobject源码未声明稳定业务字段

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束说明
statusinteger(int32)错误状态码
msgstring错误提示