client/docs/initial/data.md

1.6 KiB
Raw Blame History

Data

initial-数据

/initial.Data/Country

Request

{}

Reply

{
    countries: [{
        id: 0, // type<uint32>
        code: "", // type<string>
        code_3: "", // type<string>
        num_code: "", // type<string>
        phone_code: "", // type<string>
        name: "", // type<string>
        local_name: "", // type<string>
        enabled: false, // type<bool>
        sort_order: 0, // type<int32>
    }], // list<CountryItem>
}

/initial.Data/Region

系统区域数据,默认级别:市

Request

{
    // 国家ID默认中国 1
    country_id: 0, // type<int32>
    // 国家代码,默认:中国 CN
    country_code: "", // type<string>
    // 是否输出乡镇,默认:市级
    show_town: false, // type<bool>
}

Reply

{
    regions: [{
        id: "", // type<string>
        pid: "", // type<string>
        deep: 0, // type<int32>
        name: "", // type<string>
        pinyin_prefix: "", // type<string>
        pinyin: "", // type<string>
        ext_id: "", // type<string>
        ext_name: "", // type<string>
    }], // list<RegionItem>
}

/initial.Data/Datas

系统标签数据

Request

{}

Reply

{
    datas: [{
        id: "0", // type<int64>
        data_type: "", // type<string>
        key: "", // type<string>
        title: "", // type<string>
        remark: "", // type<string>
        icon: "", // type<string>
    }], // list<DatasItem>
}