获取服务信息 3.3.2+

接口说明

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

请求方式： POST

请求内容类型： application/json

响应内容类型： application/json

请求说明

请求体

字段名	参数名	必填	类型	描述
服务wid	serviceWid	M	String	服务的wid

请求示例

{
    "serviceWid":"994300417510477824"
}

响应说明

响应体

字段名	类型	描述
errcode	String	返回码，0 成功
errmsg	String	返回码描述
data	ExServiceBase	服务信息

ExServiceBase

参数名	类型	描述
wid	String	主键
appWid	String	应用wid
serviceName	String	服务默认名称
serviceNameLangKey	String	服务名称多语言标识
serviceNameLangKeys	List<ExMultiLangData>	服务名称多语言List
serviceDesc	String	服务默认说明
serviceDescLangKey	String	服务说明多语言ID
serviceDescLangKeys	List<ExMultiLangData>	服务说明多语言List
serviceType	Integer	服务类型 0：手工 1：接入 2：单体
serviceStation	Integer	服务平台 0：pc 1：移动 2：pc+移动 99： 纯线下办理
pcIconUrl	String	PC图标URL
pcIconPath	String	PC图标目录
pcIconName	String	PC图标名称
mobileIconUrl	String	移动图标URL
mobileIconPath	String	移动图标目录
mobileIconName	String	移动图标名称
pcUrl	String	pc地址
mobileUrl	String	移动地址
guestVisibility	String	登录前可见性 0 可见 1 不可见
loginVisibility	String	登陆后可见性 0 所有人可见 1 可用即可见 2 所有人不可见
serviceGrantInfos	List<ExServiceGrant>	应用授权信息集合
servPeriods3.5.4.Beta3+	List<ExServicePeriodInfo>	要配置的服务周期列表。
servPeriodEnabled3.5.4.Beta3+	String	是否启用服务周期 0：关闭 1：开启。
outPeriodVisibility3.6.1.SP6+	Integer	服务周期外可见性， 0：不可见 1：可见 若选择可见，即使当前月份非服务的周期，也可以在门户中查看到该服务
auditStatus3.8.2.Beta2+	Integer	审核状态 0 无审核 1 待审核 2 审核中 3 审核退回
outSchoolVisit3.8.2.Beta2+	Integer	外部联系人访问限制 0 禁用 1 启用
serviceEnabled3.8.2.Beta2+	Integer	服务上下架状态 1 上架 0 下架 2 草稿
linkType3.8.2.Beta2+	Integer	关联的数据类别 1：第三方链接地址 2:办理须知
linkedExtraService3.8.2.Beta2+	ExLinkedExtraService	关联的数据
dealGuideColumnList3.8.2.Beta2+	List<ExServiceColumn>	办事指南字段
qywxMobileUrl3.8.2.Beta2+	String	企业微信移动端地址
roleList3.8.2.Beta2+	List<ExServiceRoleInfo>	服务对象
miniProgramUrl3.8.2.Beta2+	String	小程序地址
miniProgramUrlDesc3.8.2.Beta2+	String	小程序地址描述
miniUrlDescLangKeys3.8.2.Beta2+	List<ExMultiLangData>	小程序地址描述多语言
dutyDeptWid3.8.2.Beta2+	String	责任部门wid
contactsAccount3.8.2.Beta2+	String	服务责任人
serviceGuide3.8.2.Beta2+	String	服务指南
serviceGuideLangKeys3.8.2.Beta2+	List<ExMultiLangData>	服务指南多语言
prompt3.9.1+	String	服务提示词

ExServiceRoleInfo

参数名	必填	类型	描述
wid	M	String	服务对象wid
roleName	M	String	服务对象名称

ExServiceColumn

参数名	必填	类型	描述
wid	M	String	字段主键
columnValueList	M	List<ExServiceColumnValue>	字段值

ExServiceColumnValue

参数名	必填	类型	描述
columnWid	M	String	字段主键
columnValue	M	Object	字段值（中文，具体类型见示例）
columnValueMultiLang	M	List<ExMultiLangData>	字段值多语言，必须有中文数据(langCountry为 zh_CN 的数据)

ExLinkedExtraService

参数名	必填	类型	描述
relativeLinkType	M	String	支持的类型，固定 1,2
linkUrl	M	String	第三方系统PC访问地址 当linkType为1时必填
linkMobileUrl	M	String	第三方系统移动访问地址 当linkType为1时必填
buttonName	M	String	第三方链接地址按钮名称 当linkType为1时必填
instructionsButtonName	M	String	办理须知按钮名称 当linkType为2时必填
instructions	M	List<ExMultiLangData>	办理须知内容 当linkType为2时必填 必须有中文数据(langCountry为 zh_CN 的数据)

ExMultiLangData

参数名	必填	类型	描述
langValue	M	String	属性值
langCountry	M	String	语言类型

ExServiceGrant

字段名	必填	类型	描述
grantType	M	String	1：用户组 （只可授权给用户组）
grantWid	M	String	对应的用户组wid

ExServicePeriodInfo

字段名	必填	类型	描述
servOnlineDay	*M	String	服务上线日，yyyy-MM-dd。取值与repeatUnit相关。repeatUnit为0时，年月日均不可置null；为1时，年值置null；为2时，年值、月值均置null；为3时，值为空
servOfflineDay	*M	String	服务下线日，yyyy-MM-dd。取值与repeatUnit相关。repeatUnit为0时，年月日均不可置null；为1时，年值置null；为2时，年值、月值均置null；为3时，值为空
servOnlineDayTime3.7.4.SP2+	*M	String	服务上线时分，HH:mm。取值与repeatUnit相关，当repeatUnit为3时必填
servOfflineDayTime3.7.4.SP2+	*M	String	服务下线时分，HH:mm。取值与repeatUnit相关，当repeatUnit为3时必填
repeatUnit	M	String	服务周期，0为不重复，1为按年重复，2为按月重复，3为按天重复（3.7.4.SP2+）

响应示例

{
    "data": {
        "appWid": "1240714452991864832",
        "guestVisibility": "0",
        "loginVisibility": "0",
        "outPeriodVisibility": 0,
        "pcIconName": "serviceIcon_OpenV2Api_1267423247595737088pc.png",
        "pcIconPath": "2024-07-29",
        "pcIconUrl": "https://wechattest.wisedu.com/oss/serviceIcon/2024-07-29/serviceIcon_OpenV2Api_1267423247595737088pc.png?sign=Xr4bigZLO18jXHRilkXJx2aCY-C9HWdFJ4zzD4ficKsolvek2-WGrgP4i3ECYhWSjRyq0fs3WK3271M5fkPbfw",
        "pcUrl": "/a",
        "prompt": "",
        "servPeriodEnabled": "1",
        "servPeriods": [
            {
                "repeatUnit": "1",
                "servOfflineDay": "null-06-09",
                "servOnlineDay": "null-05-09"
            }
        ],
        "serviceDescLangKey": "1266429416192606208",
        "serviceGrantInfos": [
            {
                "grantType": "1",
                "grantWid": "1266059229438275584"
            },
            {
                "grantType": "0",
                "grantWid": "1265342215279210496"
            }
        ],
        "serviceName": "service002",
        "serviceNameLangKey": "1266429416150663168",
        "serviceNameLangKeys": [
            {
                "langCountry": "en",
                "langValue": "english name 001"
            },
            {
                "langCountry": "zh_CN",
                "langValue": "service002"
            }
        ],
        "serviceStation": 0,
        "serviceType": 3,
        "wid": "1266429415970308096"
    },
    "errcode": "0",
    "errmsg": "success",
    "success": true
}

错误码

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

Demo

java

// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
ServiceGetRequest request = new ServiceGetRequest();
request.setServiceWid("1266429415970308096");

BaseResponse response = client.execute(request);
//调用成功，则处理业务逻辑
if (response.isSuccess()) {
	//.....
}