获取服务字段字典

接口说明

请求URL：http[s]://{网关地址}/minos-platform/service/getServiceColumnDict

请求方式： GET

请求内容类型： application/json

响应内容类型： application/json

响应说明

响应体

数据格式：JSON

字段名	类型	描述
errcode	String	返回码，0 成功
errmsg	String	返回码描述
data	ExServiceColumnDto	返回的对象的json串

ExServiceColumnDto

字段名	类型	描述
dealGuideColumnList	List<ExServiceColumn>	服务详情字段
baseColumnList	List<ExServiceColumn>	服务基础字段

ExServiceColumn

参数名	必填	类型	描述
wid	M	String	字段主键
columnName	M	String	字段名称
isRequired	M	int	字段是否必填 1 是 0 否
isRequired	M	int	字段是否必填 1 是 0 否
isEnabled	M	int	字段是否启用 1 是 0 否
columnDesc	M	String	字段描述

响应示例

{
  "errcode": "0",
  "errmsg": "success",
  "data": {
    "dealGuideColumnList": [
      {
        "wid": "DEAL_TIME_LIMIT",
        "columnName": "办理时限",
        "isRequired": 0,
        "isEnabled": 1,
        "requiredEditabled": 1,
        "columnDesc": "填写此服务的办理时间长度，可选择当场办结或填写需要办理的工作日天数",
        "columnValueList": []
      },
      {
        "wid": "PROCESS_FLOW",
        "columnName": "办理流程",
        "isRequired": 0,
        "isEnabled": 1,
        "requiredEditabled": 1,
        "columnDesc": "可填写服务办理的流程文字描述井上传一张流程图",
        "columnValueList": []
      },
      {
        "wid": "RELATED_MATERIALS",
        "columnName": "相关材料",
        "isRequired": 0,
        "isEnabled": 1,
        "requiredEditabled": 1,
        "columnDesc": "可上传与服务有关的说明或填写附件",
        "columnValueList": []
      },
      {
        "wid": "CONTACT_PHONE",
        "columnName": "咨询电话",
        "isRequired": 1,
        "isEnabled": 1,
        "requiredEditabled": 1,
        "columnDesc": "填写电话号码和针对具体号码的相应备注",
        "columnValueList": []
      },
      {
        "wid": "FAQS",
        "columnName": "常见问题",
        "isRequired": 0,
        "isEnabled": 1,
        "requiredEditabled": 1,
        "columnDesc": "填写关于此服务可能的常见问题及答案",
        "columnValueList": []
      }
    ],
    "baseColumnList": [
      {
        "wid": "DUTY_DEPT",
        "columnName": "责任部门",
        "isRequired": 0,
        "isEnabled": 1,
        "requiredEditabled": 1,
        "columnDesc": "为服务配置所属责任部门，此部门与应用不冲突",
        "columnValueList": []
      },
      {
        "wid": "MINI_PROGRAM_URL",
        "columnName": "小程序地址",
        "isRequired": 0,
        "isEnabled": 1,
        "requiredEditabled": 0,
        "columnDesc": "用于学校移动门户中包含小程序服务时进行配置",
        "columnValueList": []
      },
      {
        "wid": "DEAL_GUIDE",
        "columnName": "服务指南",
        "isRequired": 1,
        "isEnabled": 1,
        "requiredEditabled": 1,
        "columnDesc": "填写具体服务办理内容描述，不超过5000个字符",
        "columnValueList": []
      },
      {
        "wid": "SERVICE_OBJECT",
        "columnName": "服务对象",
        "isRequired": 0,
        "isEnabled": 1,
        "requiredEditabled": 1,
        "columnDesc": "可在服务对象中选择一个或多个，可在【系统配置-服务对象配置】中管理",
        "columnValueList": []
      },
      {
        "wid": "OUT_SCHOOL_VISIT",
        "columnName": "外部联系人访问限制",
        "isRequired": 0,
        "isEnabled": 1,
        "requiredEditabled": 0,
        "columnDesc": "检测当前访问用户的所在IP，限制用户对此服务的访问",
        "columnValueList": []
      }
    ]
  }
}

错误码

错误码	描述
111001	必填参数不能为空
999	统一错误码，详细描述信息参见接口返回

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID,APP_SECRET);
// 创建请求对象
GetServiceColumnDictRequest request = new GetServiceColumnDictRequest();
GetServiceColumnDictResponse response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
System.out.println(JSON.toJSONString(response));
//.....
}