client/docs/initial/data.md

95 lines
1.8 KiB
Markdown
Raw Normal View History

2025-09-07 22:03:28 +08:00
# Data
initial-数据
- [/initial.Data/Country](#initialdatacountry)
2025-09-08 16:56:48 +08:00
- [/initial.Data/Areas](#initialdataareas)
2025-09-07 22:03:28 +08:00
- [/initial.Data/Datas](#initialdatadatas)
## /initial.Data/Country
### Request
```javascript
{}
```
### Reply
```javascript
{
countries: [{
id: 0, // type<uint32>
2025-09-08 16:56:48 +08:00
Iso2: "", // type<string>
Iso3: "", // type<string>
2025-09-07 22:03:28 +08:00
num_code: "", // type<string>
phone_code: "", // type<string>
2025-09-08 16:56:48 +08:00
currency: "", // type<string>
currency_symbol: "", // type<string>
region: "", // type<string>
timezones: "", // type<string>
translations: "", // type<string>
2025-09-07 22:03:28 +08:00
name: "", // type<string>
local_name: "", // type<string>
enabled: false, // type<bool>
sort_order: 0, // type<int32>
}], // list<CountryItem>
}
```
2025-09-08 16:56:48 +08:00
## /initial.Data/Areas
2025-09-07 22:03:28 +08:00
系统区域数据,默认级别:市
### Request
```javascript
{
// 国家ID默认中国 1
country_id: 0, // type<int32>
// 国家代码,默认:中国 CN
country_code: "", // type<string>
// 是否输出乡镇,默认:市级
show_town: false, // type<bool>
}
```
### Reply
```javascript
{
2025-09-08 16:56:48 +08:00
areas: [{
2025-09-07 22:03:28 +08:00
id: "", // type<string>
pid: "", // type<string>
deep: 0, // type<int32>
name: "", // type<string>
pinyin_prefix: "", // type<string>
pinyin: "", // type<string>
ext_id: "", // type<string>
ext_name: "", // type<string>
2025-09-08 16:56:48 +08:00
}], // list<AreasItem>
2025-09-07 22:03:28 +08:00
}
```
## /initial.Data/Datas
2025-09-08 16:56:48 +08:00
系统数据
2025-09-07 22:03:28 +08:00
### Request
```javascript
{}
```
### Reply
```javascript
{
datas: [{
id: "0", // type<int64>
data_type: "", // type<string>
key: "", // type<string>
title: "", // type<string>
remark: "", // type<string>
icon: "", // type<string>
}], // list<DatasItem>
}
```