cn.gtmap.gtc.utilclient.common.client.rest

接口 RegionManagerClient

@FeignClient(name="util-center")
 @RequestMapping(value="/util/rest/config/region")
public interface RegionManagerClient

版本:

1.0.2018/8/3

作者:

yangyang

方法概要

限定符和类型	方法和说明
RegionDTO	createRegion(RegionDTO RegionDTO)
boolean	deleteRegion(String id)
boolean	disableRegion(String id)
boolean	enableRegion(String id)
List<RegionDTO>	findJuniorRegions(String id)
List<RegionDTO>	findJuniorRegionsEnabled(String id)
RegionDTO	findRegionByCode(String code)
RegionDTO	findRegionById(String id)
RegionDTO	findRegionByName(String name)
List<RegionDTO>	findRegionsByLevel(int level)
List<RegionDTO>	findRootRegions()
List<RegionDTO>	findRootRegionsEnabled()
ProvinceCityCountyDTO	getProCityCounty(String id)
boolean	importRegions(List<RegionDTO> RegionDTOs)
RegionDTO	updateRegion(RegionDTO RegionDTO)
boolean	validOnlyCode(String id, String code)

方法详细资料

createRegion

@PostMapping
RegionDTO createRegion(@RequestBody
                                     RegionDTO RegionDTO)

参数:

RegionDTO - 行政区划详情

返回:

importRegions

@PostMapping(value="/import")
boolean importRegions(@RequestBody
                                                     List<RegionDTO> RegionDTOs)

参数:

RegionDTOs - 行政区划详情

返回:

updateRegion

@PutMapping
RegionDTO updateRegion(@RequestBody
                                    RegionDTO RegionDTO)

参数:

RegionDTO - 行政区划详情

返回:

deleteRegion

@DeleteMapping(value="/{id}")
boolean deleteRegion(@PathVariable(name="id")
                                                    String id)

参数:

id - 行政区划id

返回:

disableRegion

@PostMapping(value="/{id}/disable")
boolean disableRegion(@PathVariable(name="id")
                                                           String id)

参数:

id - 行政区划id

返回:

enableRegion

@PostMapping(value="/{id}/enable")
boolean enableRegion(@PathVariable(name="id")
                                                         String id)

参数:

id - 行政区划id

返回:

findRegionsByLevel

@GetMapping(value="/level")
List<RegionDTO> findRegionsByLevel(@RequestParam(name="level")
                                                                int level)

参数:

level - 行政区划等级（1：省级；2：市；3：区县）

返回:

findRegionByCode

@GetMapping(value="/code")
RegionDTO findRegionByCode(@RequestParam(name="code")
                                                       String code)

参数:

code - 行政区划编码

返回:

findRegionByName

@GetMapping(value="/name")
RegionDTO findRegionByName(@RequestParam(name="name")
                                                       String name)

参数:

name - 行政区划名称

返回:

validOnlyCode

@GetMapping(value="/{code}/code-only")
boolean validOnlyCode(@RequestParam(name="id",required=false)
                                                              String id,
                                                              @PathVariable(name="code")
                                                              String code)

参数:

id - 行政区划id

code - 行政区划编码

返回:

findRegionById

@GetMapping(value="/{id}")
RegionDTO findRegionById(@PathVariable(name="id")
                                                     String id)

参数:

id - 行政区划id

返回:

getProCityCounty

@GetMapping(value="/{id}/province-city-county")
ProvinceCityCountyDTO getProCityCounty(@PathVariable(name="id")
                                                                                        String id)

参数:

id - 行政区划id

返回:

findRootRegions

@GetMapping(value="/root")
List<RegionDTO> findRootRegions()

参数:

-

返回:

findRootRegionsEnabled

@GetMapping(value="/root/enabled")
List<RegionDTO> findRootRegionsEnabled()

参数:

-

返回:

findJuniorRegions

@GetMapping(value="/{id}/junior")
List<RegionDTO> findJuniorRegions(@PathVariable(name="id")
                                                                     String id)

参数:

id - 行政区划id

返回:

findJuniorRegionsEnabled

@GetMapping(value="/{id}/junior/enabled")
List<RegionDTO> findJuniorRegionsEnabled(@PathVariable(name="id")
                                                                                    String id)

参数:

id - 行政区划id

返回: