(平台)基础主数据管理

节假日管理API

初始化年度节假日数据

基本信息

Path： /api/base/v1/holiday/init

Method： GET

接口描述：

简要描述

初始化年度节假日数据

请求URL

/api/base/v1/holiday/init?year=2021
GET

参数

参数名	必选	类型	说明
year	是	Integer	仅支持2019年以后到明年的日期，初始化明年时，需要在本年的12月份才可执行

响应示例

{
  "success": true,
  "errorCode": "",
  "errorMessage": "",
  "showType": 1,
  "traceId": "b290302c55061a6ed81e877b2cece2d6"
}

请求参数

Query

参数名称	是否必须	示例	备注
year	是	2022	初始化年Integer

返回数据

名称	类型	是否必须	默认值	备注	其他信息

按年按月按日节假日查询

基本信息

Path： /api/base/v1/holiday/list

Method： GET

接口描述：

简要描述

节假日信息查询

请求URL

/api/base/v1/export/holiday?date=2021-01-01
GET

参数

参数名	必选	类型	说明
date	否	String	1.date= 表示查询当天的信息， 2.date=yyyy 表示查询当年全部数据， 3.date=yyyy-mm 表示查询当年当月的全部数据， 4.date=yyyy-mm-dd表示查询指定年月日的数据

响应示例

{
  "success": true,
  "data": [
    {
      "date": "2022-02-06",
      "info": "节假日",
      "cnweekday": "星期日",
      "name": "春节",
      "wage": 1
    }
  ],
  "traceId": "18651c7e87d910417302468bed92c8b6",
  "total": 1
}

请求参数

Query

参数名称	是否必须	示例	备注
date	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息

区域管理API

区下拉列表查询

基本信息

Path： /api/base/v1/areaselect/area/find

Method： GET

接口描述：

简要描述

区下拉列表查询

请求URL

/api/base/v1/areaselect/area/find?cityCode=210200
GET

参数

参数名	必选	类型	说明
cityCode	是	String	市code

响应示例

{
    "errCode": null,
    "errMessage": null,
    "total": 0,
    "data": [
        {
            "name": "中山区",
            "code": "210202"
        },
        {
            "name": "西岗区",
            "code": "210203"
        },
        {
            "name": "沙河口区",
            "code": "210204"
        },
        {
            "name": "甘井子区",
            "code": "210211"
        },
        {
            "name": "旅顺口区",
            "code": "210212"
        },
        {
            "name": "金州区",
            "code": "210213"
        },
        {
            "name": "普兰店区",
            "code": "210214"
        },
        {
            "name": "长海县",
            "code": "210224"
        },
        {
            "name": "瓦房店市",
            "code": "210281"
        },
        {
            "name": "庄河市",
            "code": "210283"
        }
    ],
    "success": true
}

请求参数

Query

参数名称	是否必须	示例	备注
cityCode	是	210200	市编码

市下拉列表查询

基本信息

Path： /api/base/v1/areaselect/city/find

Method： GET

接口描述：

简要描述

市下拉列表

请求URL

/api/base/v1/areaselect/city/find?provinceCode=210000
GET

参数

参数名	必选	类型	说明
provinceCode	是	String	省code

响应示例

{
    "errCode": null,
    "errMessage": null,
    "total": 0,
    "data": [
        {
            "name": "沈阳市",
            "code": "210100"
        },
        {
            "name": "大连市",
            "code": "210200"
        },
        {
            "name": "鞍山市",
            "code": "210300"
        },
        {
            "name": "抚顺市",
            "code": "210400"
        },
        {
            "name": "本溪市",
            "code": "210500"
        },
        {
            "name": "丹东市",
            "code": "210600"
        },
        {
            "name": "锦州市",
            "code": "210700"
        },
        {
            "name": "营口市",
            "code": "210800"
        },
        {
            "name": "阜新市",
            "code": "210900"
        },
        {
            "name": "辽阳市",
            "code": "211000"
        },
        {
            "name": "盘锦市",
            "code": "211100"
        },
        {
            "name": "铁岭市",
            "code": "211200"
        },
        {
            "name": "朝阳市",
            "code": "211300"
        },
        {
            "name": "葫芦岛市",
            "code": "211400"
        }
    ],
    "success": true
}

请求参数

Query

参数名称	是否必须	示例	备注
provinceCode	是	210000	省编码

省下拉列表查询

基本信息

Path： /api/base/v1/areaselect/province/find

Method： GET

接口描述：

简要描述

省下拉列表查询

请求URL

/api/base/v1/areaselect/province/find
GET

响应示例

{
    "errCode": null,
    "errMessage": null,
    "total": 0,
    "data": [
        {
            "name": "北京市",
            "code": "110000"
        },
        {
            "name": "天津市",
            "code": "120000"
        },
        {
            "name": "河北省",
            "code": "130000"
        },
        {
            "name": "山西省",
            "code": "140000"
        },
        {
            "name": "内蒙古自治区",
            "code": "150000"
        },
        {
            "name": "辽宁省",
            "code": "210000"
        },
        {
            "name": "吉林省",
            "code": "220000"
        },
        {
            "name": "黑龙江省",
            "code": "230000"
        },
        {
            "name": "上海市",
            "code": "310000"
        },
        {
            "name": "江苏省",
            "code": "320000"
        },
        {
            "name": "浙江省",
            "code": "330000"
        },
        {
            "name": "安徽省",
            "code": "340000"
        },
        {
            "name": "福建省",
            "code": "350000"
        },
        {
            "name": "江西省",
            "code": "360000"
        },
        {
            "name": "山东省",
            "code": "370000"
        },
        {
            "name": "河南省",
            "code": "410000"
        },
        {
            "name": "湖北省",
            "code": "420000"
        },
        {
            "name": "湖南省",
            "code": "430000"
        },
        {
            "name": "广东省",
            "code": "440000"
        },
        {
            "name": "广西壮族自治区",
            "code": "450000"
        },
        {
            "name": "海南省",
            "code": "460000"
        },
        {
            "name": "重庆市",
            "code": "500000"
        },
        {
            "name": "四川省",
            "code": "510000"
        },
        {
            "name": "贵州省",
            "code": "520000"
        },
        {
            "name": "云南省",
            "code": "530000"
        },
        {
            "name": "西藏自治区",
            "code": "540000"
        },
        {
            "name": "陕西省",
            "code": "610000"
        },
        {
            "name": "甘肃省",
            "code": "620000"
        },
        {
            "name": "青海省",
            "code": "630000"
        },
        {
            "name": "宁夏回族自治区",
            "code": "640000"
        },
        {
            "name": "新疆维吾尔自治区",
            "code": "650000"
        },
        {
            "name": "台湾省",
            "code": "710000"
        },
        {
            "name": "香港",
            "code": "810000"
        },
        {
            "name": "澳门",
            "code": "820000"
        },
        {
            "name": "苏鲁交界",
            "code": "990000"
        },
        {
            "name": "test0000000",
            "code": "test00000000"
        }
    ],
    "success": true
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Cookie	kat=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJmS0hncVRIcUdLUkVRT2lNaDAyMk1iSmlQeHZkVGRrN3VzWTBVR3BvelFQTnhPMVRYczFzWSIsImV4cCI6MTYzODMyODc2NCwiaWF0IjoxNjM4MzIxNTY0LCJpc3MiOiJzc28uZGV2Lms4cy5sb2NhbCIsIm5iZiI6MTYzODMyMTU2NCwic3ViIjoidU02RGNISTNwOWtzcXFxb2x4b1czb1FqQm0yTXR3UmtFYTByIiwibmFtIjoi6LSm5Y-35pi156ewMSIsImlkcyI6ImFMNjJLOE5GUEFKR0hHSSIsInVjbyI6IjExMTExMTExMTEiLCJ1bmEiOiLotbXmtYvor5UiLCJ0a2QiOiIwIiwidGNvIjoidEMzNHI3QUJ5NTFoOGl5UXVJRXJyZGtvIiwidG5hIjoi5rWL6K-V56ef5oi3IiwiYXBwIjoiMTAwMDAwMiIsImFwbiI6IueBtea0u-WvvOi0rTIiLCJha2QiOiIzIiwiZmx3IjoiZk9jQUFrNUVPOXZWS1Z0NzdDcWNJRGc0SDZoNkNkVm9KVURXZDJEb21NTk4wUTU3In0.kM06xd4o1C_skfO0sO9W6rDe6tf6W7j37Vp6Itgz7zJ9fHx344CXobAgNpL3-vj3eXqtnFyJrj3Me9fw0b9Etg; krt=fKHgqTHqGKREQOiMh022MbJiPxvdTdk7usY0UGpozQPNxO1TXs1sY_rNuuJKk36hbec8Z; BMAP_SECKEY=e7ccd76a71cca7384bc9d56993ddbed2e19bbff4744b85e39bb3d65be30e7613e76ae0b8689ae7f5bb14207898aef6950e69432a9314fa542a239fa64bfb5b459bc34d42bb935c590546fad01a6b526bcd2aa6ae2e04547df80dcffe06f8ea6c8fe8f3a4f1c8466f0f61d41f6c1c22c586b68f49e8fb9e7c444932147dab645a271737ab0c406e25bda4367a5090a7afff49254f8f138f211604b5d28e638e056eb1cc06ebb776f7051e0476336f46beff61d084c0263637fdf5c43f889e8fac7b63eab323d8dae3f29a4e4ac3b91b214f106f5b37bc3590f58c99aa771f19b7e34b20e52f77354d3cace3576122917c; SECKEY_CID=e639f5c479131f6397bf1f68e03d2b82d6048d4d	是

省市区模糊查询

基本信息

Path： /api/base/v1/areaselect/like/provicityarea

Method： GET

接口描述：

简要描述

省市区模糊查询导入验证

请求URL

/api/base/v1/areaselect/like/provicityarea?province=&city=&area=
GET

参数

参数名	必选	类型	说明
province	是	String	模糊省
city	是	String	模糊市
area	是	String	模糊区

响应示例

{
    "errCode": null,
    "errMessage": null,
    "data": {
        "province": "辽宁省",
        "provinceCode": "210000",
        "city": "大连市",
        "cityCode": "210200",
        "area": "甘井子区",
        "areaCode": "210211"
    },
    "success": true
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Cookie	kat=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJlbmJJdE5MS2xmUkNEZzFBTzMzUzA5blpNVzYyNXlrYVBBTko2QzdYcHlkMnNzbmJXV0l2YiIsImV4cCI6MTYzNjcxMjExMywiaWF0IjoxNjM2NzA0OTEzLCJpc3MiOiJzc28uZGV2Lms4cy5sb2NhbCIsIm5iZiI6MTYzNjcwNDkxMywic3ViIjoidU02RGNISTNwOWtzcXFxb2x4b1czb1FqQm0yTXR3UmtFYTByIiwibmFtIjoi6LSm5Y-35pi156ewMSIsImlkcyI6ImFMNjI4OEpGUEFKR0giLCJ1Y28iOiIxMTExMTExMTExIiwidW5hIjoi6LW15rWL6K-VIiwiYWtkIjoiMyIsImZsdyI6ImZPY0NGWUk4MzNaNmp1ZzFySDg5bWltUlhIZlBlcUM2ZEROdHF2Vk4yZ3YyUm9ZQSJ9.g5pIy_JgYStsqNqY3vfkf44Llow59EjLq9sVp_9OuL-VjqNekkFdEqjjtXPx9dfd7JxE82QtaD_ohHJAhgg6Sw; krt=enbItNLKlfRCDg1AO33S09nZMW625ykaPANJ6C7Xpyd2ssnbWWIvb_rKo4S1a33b3ASo6; BMAP_SECKEY=e7ccd76a71cca7384bc9d56993ddbed2e19bbff4744b85e39bb3d65be30e7613e76ae0b8689ae7f5bb14207898aef6950e69432a9314fa542a239fa64bfb5b459bc34d42bb935c590546fad01a6b526bcd2aa6ae2e04547df80dcffe06f8ea6c8fe8f3a4f1c8466f0f61d41f6c1c22c53bbc0cd11e3ffd26e72be2db7dd56ba2a22e02ef332b5cbf8c806ecd47c3c1bb0480a21f98d7213f8b75d2c153513dbf52dc9fda873e8c295dfb0dc80c46a60871bf4c7cb29dd0daef12ecb01503d3498a67af39cde0cf52a5a58b6efa565d83eb6d99a10d5190b557d993ab992878aec45ba5a32c71b50c494fa933bf73f039; SECKEY_CID=505c003aebc03dcf0b0591e6489922b907fab759	是

Query

参数名称	是否必须	示例	备注
province	否
city	否
area	否

镇下拉列表查询

基本信息

Path： /api/base/v1/areaselect/town/find

Method： GET

接口描述：

简要描述

镇下拉列表查询

请求URL

/api/base/v1/areaselect/town/find?areaCode=210211
GET

参数

参数名	必选	类型	说明
areaCode	是	String	区code

响应示例

{
    "errCode": null,
    "errMessage": null,
    "total": 0,
    "data": [
        {
            "name": "周水子街道",
            "code": "210211001"
        },
        {
            "name": "甘井子街道",
            "code": "210211004"
        },
        {
            "name": "南关岭街道",
            "code": "210211006"
        },
        {
            "name": "泡崖街道",
            "code": "210211007"
        },
        {
            "name": "机场街道",
            "code": "210211010"
        },
        {
            "name": "辛寨子街道",
            "code": "210211014"
        },
        {
            "name": "红旗街道",
            "code": "210211015"
        },
        {
            "name": "大连湾街道",
            "code": "210211017"
        },
        {
            "name": "椒金山街道",
            "code": "210211018"
        },
        {
            "name": "泉水街道",
            "code": "210211019"
        },
        {
            "name": "中华路街道",
            "code": "210211020"
        },
        {
            "name": "营城子街道",
            "code": "210211021"
        },
        {
            "name": "革镇堡街道",
            "code": "210211022"
        },
        {
            "name": "凌水街道",
            "code": "210211023"
        }
    ],
    "success": true
}

请求参数

Query

参数名称	是否必须	示例	备注
areaCode	否	210211	区编码

基础数据管理API

获取基础属性子分类列表

基本信息

Path： /api/base/v1/basedataApi/listBaseValueByCode

Method： GET

接口描述：

简要描述

获取基础属性子分类列表

请求URL

/api/base/v1/basedata/listBaseValueByCode?code=XXX

请求方式

参数

参数名	必选	类型	说明
code	是	String	参数分类code

响应示例

{
    "success": true,
    "data": [
        {
            "code": "PRODUCT_UNIT_1",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "ml",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_10",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "条",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_11",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "个",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_12",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "盒",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_13",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "袋",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_2",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "g",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_3",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "件",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_4",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "提",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_5",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "打",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_6",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "瓶",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_7",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "支",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_8",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "箱",
            "memo": null
        },
        {
            "code": "PRODUCT_UNIT_9",
            "mdCode": "PRODUCT_UNIT",
            "mdName": "商品单位",
            "name": "包",
            "memo": null
        }
    ],
    "traceId": "f81f0af135d9f73e221c4c1ccdd5e14c",
    "total": 13
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Cookie	login_flow=fOcL8mkT2B00KJyAYdzHkOHCKm5VyhdpOGtoc4jWRS3PUvzw; kat=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJUOG1rWFBBNXdXY05IOFhJVnQ3ZnRSOUMiLCJhdWQiOiIzVFJzTHdjUDZaZjkiLCJleHAiOjE2MzkzNjYzMzEsImlhdCI6MTYzOTM1OTEzMSwiaXNzIjoic3NvLmRldi5rOHMubG9jYWwiLCJuYmYiOjE2MzkzNTkxMzEsInN1YiI6InVNNkRjSEkzcDlrc3FxcW9seG9XM29RakJtMk10d1JrRWEwciIsIm5hbSI6Iui0puWPt-aYteensDEifQ.llZW5WMnv7zSsd_Vnqkel0Zpm2AKwm71-bq2w0cdr9jjU_eyPgGM8MmTlI1BFHbm_j1-w20Xq7zYT1jbbEPdrQ; krt=RT8mkXPA5wWcNH8XIVt7ftR9CPu5vadLxhI5x4ZbyozZC97; SECKEY_ABVK=rm+ZfkCO3e84K6daeZZPn4Ki2s5WG5L2ScC3HeOQoFo=; BMAP_SECKEY=e7ccd76a71cca7384bc9d56993ddbed2e19bbff4744b85e39bb3d65be30e7613e76ae0b8689ae7f5bb14207898aef6950e69432a9314fa542a239fa64bfb5b459bc34d42bb935c590546fad01a6b526bcd2aa6ae2e04547df80dcffe06f8ea6c8fe8f3a4f1c8466f0f61d41f6c1c22c5a89319b2df68bedbe997b9a91fe7cc79c7cd37fbe204f50d1755d971fabb8bf5675a71114566d0604d5c94e76914cb06242af72bb1e8bee9861cd73a056635c63277f4c3e0c5c51d6ad3c945cf7c8db542ddd4214a348c79351ba9d44462675a31b0a07d438d84e967e4858cd37d639f	是

Query

参数名称	是否必须	示例	备注
code	是	PRODUCT_UNIT	可以根据基础属性分类接口获取对应分类编码

获取基础属性子分类详情

基本信息

Path： /api/base/v1/basedataApi/getBaseValueByCode

Method： GET

接口描述：

简要描述

获取基础属性子分类详情

请求URL

/api/base/v1/basedata/getBaseValueByCode?code=XXX

请求方式

参数

参数名	必选	类型	说明
code	是	String	参数code

响应示例

{
    "success": true,
    "data": {
        "code": "PRODUCT_UNIT_1",
        "mdCode": "PRODUCT_UNIT",
        "mdName": "商品单位",
        "name": "ml",
        "memo": null
    },
    "traceId": "4c752a15cff69de1c614e08073ccae0b"
}

请求参数

Query

参数名称	是否必须	示例	备注
code	是	PRODUCT_UNIT_1

获取基础属性类别列表

基本信息

Path： /api/base/v1/basedataApi/listBaseCode

Method： GET

接口描述：

简要描述

获取基础属性类别列表

请求URL

/api/base/v1/basedata/listBaseCode

请求方式

响应示例

{
    "success": true,
    "data": [
        {
            "code": "PRODUCT_UNIT",
            "name": "商品单位",
            "memo": null
        },
        {
            "code": "TIME_UNIT",
            "name": "时间单位",
            "memo": null
        },
        {
            "code": "DATE_UNIT",
            "name": "日期单位",
            "memo": null
        },
        {
            "code": "EDUCATION_UNIT",
            "name": "学历",
            "memo": null
        },
        {
            "code": "MARITAL_STATUS",
            "name": "婚姻状态",
            "memo": null
        },
        {
            "code": "MONEY_UNIT",
            "name": "金额单位",
            "memo": null
        },
        {
            "code": "CITY_LEVEL",
            "name": "城市等级",
            "memo": null
        }
    ],
    "traceId": "37abf550953ae9abcf2cbb6595ac39c9",
    "total": 7
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Cookie	login_flow=fOcL8mkT2B00KJyAYdzHkOHCKm5VyhdpOGtoc4jWRS3PUvzw; kat=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJUOG1rWFBBNXdXY05IOFhJVnQ3ZnRSOUMiLCJhdWQiOiIzVFJzTHdjUDZaZjkiLCJleHAiOjE2MzkzNjYzMzEsImlhdCI6MTYzOTM1OTEzMSwiaXNzIjoic3NvLmRldi5rOHMubG9jYWwiLCJuYmYiOjE2MzkzNTkxMzEsInN1YiI6InVNNkRjSEkzcDlrc3FxcW9seG9XM29RakJtMk10d1JrRWEwciIsIm5hbSI6Iui0puWPt-aYteensDEifQ.llZW5WMnv7zSsd_Vnqkel0Zpm2AKwm71-bq2w0cdr9jjU_eyPgGM8MmTlI1BFHbm_j1-w20Xq7zYT1jbbEPdrQ; krt=RT8mkXPA5wWcNH8XIVt7ftR9CPu5vadLxhI5x4ZbyozZC97; SECKEY_ABVK=rm+ZfkCO3e84K6daeZZPn4Ki2s5WG5L2ScC3HeOQoFo=; BMAP_SECKEY=e7ccd76a71cca7384bc9d56993ddbed2e19bbff4744b85e39bb3d65be30e7613e76ae0b8689ae7f5bb14207898aef6950e69432a9314fa542a239fa64bfb5b459bc34d42bb935c590546fad01a6b526bcd2aa6ae2e04547df80dcffe06f8ea6c8fe8f3a4f1c8466f0f61d41f6c1c22c5a89319b2df68bedbe997b9a91fe7cc79c7cd37fbe204f50d1755d971fabb8bf5675a71114566d0604d5c94e76914cb06242af72bb1e8bee9861cd73a056635c63277f4c3e0c5c51d6ad3c945cf7c8db542ddd4214a348c79351ba9d44462675a31b0a07d438d84e967e4858cd37d639f	是

YAPI 接口文档

(平台)基础主数据管理

节假日管理API

初始化年度节假日数据

基本信息

简要描述

请求URL

参数

响应示例

请求参数

返回数据

按年按月按日节假日查询

基本信息

简要描述

请求URL

参数

响应示例

请求参数

返回数据

区域管理API

区下拉列表查询

基本信息

简要描述

请求URL

参数

响应示例

请求参数

市下拉列表查询

基本信息

简要描述

请求URL

参数

响应示例

请求参数

省下拉列表查询

基本信息

简要描述

请求URL

响应示例

请求参数

省市区模糊查询

基本信息

简要描述

请求URL

参数

响应示例

请求参数

镇下拉列表查询

基本信息

简要描述

请求URL

参数

响应示例

请求参数

基础数据管理API

获取基础属性子分类列表

基本信息

简要描述

请求URL

请求方式

参数

响应示例

请求参数

获取基础属性子分类详情

基本信息

简要描述

请求URL

请求方式

参数

响应示例

请求参数

获取基础属性类别列表

基本信息

简要描述

请求URL

请求方式

响应示例

请求参数