获取指定类型字典数据

接口描述:

根据类型代码获取指定类型字典数据

接口地址:

请求方式:

  • GET

请求头:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
X-App-Id 客户端 clientId header true string

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
accessToken 接口访问凭证 query true string
dictType 数据字典类型编码 query true string

响应状态

状态码 说明 schema
200 OK ApiRestResponse«List«DictCodeVO»»

其他状态码参见:全局状态码

响应示例:

正确时返回:

{
    "code": 200,
    "status": "success",
    "message": "请求成功",
    "data": [
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "1",
            "mc": "居民身份证"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "2",
            "mc": "军官证"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "3",
            "mc": "士兵证"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "4",
            "mc": "文职干部证"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "6",
            "mc": "香港特区护照/身份证明"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "7",
            "mc": "澳门特区护照/身份证明"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "8",
            "mc": "台湾居民来往大陆通行证"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "9",
            "mc": "境外永久居住证"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "A",
            "mc": "护照"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "B",
            "mc": "户口薄"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "5",
            "mc": "部队离退休证"
        },
        {
            "dictTypeId": "8",
            "dictType": "sfzjlxm",
            "dm": "Z",
            "mc": "其他"
        }
    ]
}

错误时返回:

{
    "code": 500,
    "data": {},
    "message": "成功或异常消息",
    "status": "fail"
}

响应参数:

参数名称 参数说明 类型 schema
code 成功或异常编码 integer(int32) integer(int32)
data 成功或异常数据 array AppVO
message 成功或异常消息 string
status 旧接口成功、失败或异常辅助判断标记:success、fail、error,可用值:success,fail,error string
Schema 属性:

DictTypeVO

参数名称 参数说明 类型 schema
dictTypeId 数据字典类型数据子类表ID integer(int64)
dictType 数据字典类型 string
dm 数据字典代码集代码 string
mc 数据字典代码集代码名称 string

调用示例:

NodeJs - Axios:

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api_server_url/dict/list?accessToken=AT-3-fDNa-D-Jb4gao58FOMB8okLmc1-iOYSR&dictType=sfzjlxm',
  headers: {
    'X-App-Id': '1'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Java - OkHttp 示例:

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://api_server_url/dict/list?accessToken=AT-3-fDNa-D-Jb4gao58FOMB8okLmc1-iOYSR&dictType=sfzjlxm")
  .method("GET", null)
  .addHeader("X-App-Id", "1")
  .build();
Response response = client.newCall(request).execute();
作者:杭州天音  创建时间:2022-07-27 18:02
最后编辑:杭州天音  更新时间:2025-08-22 15:44