GET entity/regions

Request Information

URI Parameters

Name	Type	Additional information
region_id	integer	None.
region_ids	Collection of integer	None.
region_name	string	None.
region_type_ids	Collection of integer	None.
region_type_ids_str	string	None.
parent_region_id	integer	None.
enabled	boolean	None.
open	boolean	None.
sms_region_code	string	None.

Body Parameters

None.

Response Information

Resource Description

DataResponseOfListOfRegionViewModel

Name	Type	Additional information
code	integer	None.
message	string	None.
success	boolean	None.
data	Collection of RegionViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "code": 1,
  "message": "sample string 2",
  "success": true,
  "data": [
    {
      "region_id": 1,
      "parent_region_id": 2,
      "area_region_id": 3,
      "root_region_id": 4,
      "name": "sample string 5",
      "city_id": 6,
      "city_name": "sample string 7",
      "region_type_id": 8,
      "region_type_name": "sample string 9",
      "sms_region_code": "sample string 10",
      "amap_sms_region_code": "sample string 11",
      "province_code": "sample string 12",
      "domestic": true,
      "pin_yin": "sample string 14",
      "letter": "sample string 15",
      "domain_prefix": "sample string 16",
      "enabled": true,
      "open": true,
      "indentation": 19,
      "descend": 20
    },
    {
      "region_id": 1,
      "parent_region_id": 2,
      "area_region_id": 3,
      "root_region_id": 4,
      "name": "sample string 5",
      "city_id": 6,
      "city_name": "sample string 7",
      "region_type_id": 8,
      "region_type_name": "sample string 9",
      "sms_region_code": "sample string 10",
      "amap_sms_region_code": "sample string 11",
      "province_code": "sample string 12",
      "domestic": true,
      "pin_yin": "sample string 14",
      "letter": "sample string 15",
      "domain_prefix": "sample string 16",
      "enabled": true,
      "open": true,
      "indentation": 19,
      "descend": 20
    }
  ]
}