75 lines
1.5 KiB
Markdown
75 lines
1.5 KiB
Markdown
# RegionProvinceService
|
||
> 省份相关服务
|
||
|
||
---
|
||
|
||
## findAllRegionProvinces
|
||
> 查找所有国家|地区的所有省份
|
||
|
||
- 角色：`admin`, `user`
|
||
- HTTP：`POST https://backend.dooki.cloud/RegionProvinceService/findAllRegionProvinces`
|
||
- RPC：`rpc findAllRegionProvinces(FindAllRegionProvincesRequest) returns (FindAllRegionProvincesResponse);`
|
||
|
||
**请求对象 (`FindAllRegionProvincesRequest`)**
|
||
|
||
```json
|
||
{}
|
||
```
|
||
|
||
**响应对象 (`FindAllRegionProvincesResponse`)**
|
||
|
||
```json
|
||
{
|
||
"regionProvinces": "[]RegionProvince // 省份列表"
|
||
}
|
||
```
|
||
|
||
**调用示例**
|
||
|
||
```bash
|
||
curl -X POST "https://backend.dooki.cloud/RegionProvinceService/findAllRegionProvinces" \
|
||
-H "Content-Type: application/json" \
|
||
-H "X-Edge-Access-Token: <YOUR_TOKEN>" \
|
||
-d '{
|
||
...
|
||
}'
|
||
```
|
||
|
||
---
|
||
|
||
## updateRegionProvinceCustom
|
||
> 修改国家/地区定制信息
|
||
|
||
- 角色：`admin`
|
||
- HTTP：`POST https://backend.dooki.cloud/RegionProvinceService/updateRegionProvinceCustom`
|
||
- RPC：`rpc updateRegionProvinceCustom(UpdateRegionProvinceCustomRequest) returns (RPCSuccess);`
|
||
|
||
**请求对象 (`UpdateRegionProvinceCustomRequest`)**
|
||
|
||
```json
|
||
{
|
||
"regionProvinceId": "int64 // 省份ID",
|
||
"customName": "string // 自定义名称",
|
||
"customCodes": "[]string // 自定义代号"
|
||
}
|
||
```
|
||
|
||
**响应对象 (`RPCSuccess`)**
|
||
|
||
```json
|
||
{}
|
||
```
|
||
|
||
**调用示例**
|
||
|
||
```bash
|
||
curl -X POST "https://backend.dooki.cloud/RegionProvinceService/updateRegionProvinceCustom" \
|
||
-H "Content-Type: application/json" \
|
||
-H "X-Edge-Access-Token: <YOUR_TOKEN>" \
|
||
-d '{
|
||
...
|
||
}'
|
||
```
|
||
|
||
---
|