cn.gtmap.gtc.clients

接口 RegionManagerClient

@FeignClient(name="account")
 @RequestMapping(value="/account/rest/v1/regions")
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)
RegionDto	findActRegion(String code)
List<RegionDto>	findJuniorRegions(String id)
List<RegionDto>	findJuniorRegionsEnabled(String id)
List<OrganizationDto>	findOrgsByRegion(String id)
RegionDto	findRegionByCode(String code)
RegionDto	findRegionById(String id)
RegionDto	findRegionByName(String name)
List<RegionDto>	findRegions(String id, Integer enabled) 根据id和启用状态查询所有行政区
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

返回:

findOrgsByRegion

@GetMapping(value="/{id}/orgs")
List<OrganizationDto> findOrgsByRegion(@PathVariable(name="id")
                                                                        String id)

参数:

id - 行政区划id

返回:

findActRegion

@GetMapping(value="/active")
RegionDto findActRegion(@RequestParam(name="code")
                                                      String code)

参数:

code - 行政区划

返回:

findRegions

@GetMapping(value="/all-regions")
List<RegionDto> findRegions(@RequestParam(name="id",required=false)
                                                               String id,
                                                               @RequestParam(name="enabled",required=false)
                                                               Integer enabled)

根据id和启用状态查询所有行政区

参数:

id - 行政区划id（可不传）

enabled - 启用状态（可不传）

返回:

行政区列表