Province - 友好速搭 -- 开发文档

友好速搭

开放 API
使用说明 获取授权 全部 API 特殊 API 开放功能

Province

Province

#实体关系 地址中,国家下的省份对象,通过API只可读,不可修改。

Province 相关API

GET /countries/#{country_id}/provinces获取指定国家中所有省份列表GET /countries/#{country_id}/provinces/count获取指定国家下,所有省份数量GET /countries/#{country_id}/provinces/#{province_code}获取指定国家下,指定 Code 的省份内容

Province 属性

    • code
    •   { "code" : "230000" }
      
      String 类型,唯一编码标识。
    • name
    •   { "name" : "黑龙江" }
      
      String 类型,省份名称。
    • full_name
    •   { "full_name" : "黑龙江省" }
      
      String 类型,省份名称全称。
    • region
    •   { "region" : "东北" }
      
      String 类型,省份所属名称。
    • cities
    •   { "cities" : [] }
      
      Array 类型,省份下辖城市数组,参考 City

GET /countries/#{country_id}/provinces

获取指定国家中所有省份列表

    • limit
    • 可选,返回结果条数
      默认10,最大50
    • page
    • 可选,显示的页码
      默认1
    • code
    • 可选,指定省份编码
    • name
    • 可选,指定省份名称
    • 获取 ID 为 1 的国家下所有省份
    • GET /countries/1/provinces
    • {
      "provinces": [
          {
              "cities": [...],
              "code": "230000",
              "full_name": "黑龙江省",
              "name": "黑龙江",
              "region": "东北"
          }
      ]
      }
      

GET /countries/#{country_id}/provinces/count

获取指定国家下,所有省份数量

    • 获取 Country 总数
    • GET /countries/1/provinces/count
    • {
      "count": 34
      }
      

GET /countries/#{country_id}/provinces/#{province_code}

获取指定国家下,指定 Code 的省份内容

    • 获取 ID 为 1 的 Country 下,省份 Code 为 440000 的内容
    • GET /countries/1/provinces/440000
    • {
      "province": [
          {
              "cities": [...],
              "code": "440000",
              "full_name": "广东省",
              "name": "广东",
              "region": "华南"
          }
      ]
      }
      
免费领取15天试用
立即注册
联系客服
微信咨询
微信二维码

领取免费试用资格

姓名 *

电话 *

公司名称

所在地区

意向产品

提交

提交成功

你好, XXX女士/先生 ,你的需求已提交成功,后续会有专门的客户经理与你电话联系。谢谢!