区域管理接口

1. 获取区域列表

【注意】该接口对非管理员账户仅能获取到企业下拥有访问权限的区域信息，对于管理员账户则能获取到企业下所有区域的信息。

请求地址

GET User/Current/District

参数说明

区域查询接口支持丰富的条件过滤参数，请参见支持的查询参数附录

返回结果

{
    "offset": 0,
    "total": 0,
    "results": [
        {
            "id": 9722,
            "code": "01",
            "name": "本地",
            "disabled": false
        }
    ],
    "meta": {}
}

参数	说明
offset	当前结果对于首条结果的偏移量，指定分页查询时不为0
total	所有符合查询条件的查询结果数量，指定需要结果记录数量时不为0
results	符合查询条件的区域详情集合
meta	其他信息

2. 创建区域

请求地址

【注意】使用该接口创建区域将会使创建者自动拥有对其访问的权限。 POST /Asset/District

请求示例

{
    "DistrictName":"北京",
    "DistrictCode":"36958"
}

参数说明

参数	是否必须	说明
DistrictCode	是	区域编码
DistrictName	是	区域名称

返回结果

{
    "id": 65902
}

结果说明

属性	说明
Id	区域Id

3. 更新区域

【注意】该接口对于非管理员账户仅能更新企业下其拥有访问权限的区域信息，对于管理员账户则能更新企业下所有区域的信息。

请求地址

PUT /Asset/District
POST /Asset/District/put

对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址

请求示例

{
    "DistrictName":"杭州",
    "DistrictCode":"36958"
}

参数说明

参数	是否必须	说明
DistrictCode	是	区域编码
DistrictName	是	区域名称

返回结果

{}

对于成功更新的请求，该接口仅返回HTTP 200 OK

4. 更新区域编码

【注意】该接口对于非管理员账户仅能更新企业下其拥有访问权限的区域信息，对于管理员账户则能更新企业下所有区域的信息。

请求地址

PUT /Asset/District/Code
POST /Asset/District/Code/put

对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址

请求示例

{
    "CurrentCode":"01"
    "NewCode":"01_new"
}

参数说明

参数	是否必须	说明
CurrentCode	是	当前使用中的区域编码
NewCode	是	预更新的区域编码

返回结果

{}

对于成功更新的请求，该接口仅返回HTTP 200 OK

5. 删除区域

【注意】该接口对于非管理员账户仅能删除企业下其拥有访问权限的区域信息，对于管理员账户则能删除企业下所有区域的信息。

请求地址

DELETE /Asset/District
POST /Asset/District/delete

对于不支持DELETE请求的网络环境，请尝试使用备份的POST请求地址

请求示例

{
    "DistrictCode":"136958"
}

参数说明

参数	是否必须	说明
DistrictCode	是	区域编码

返回结果

{}

对于成功删除的请求，该接口仅返回HTTP 200 OK

6. 设置区域的可用状态

【注意】该接口对于非管理员账户仅能更新企业下其拥有访问权限的区域信息，对于管理员账户则能更新企业下所有区域的信息。

请求地址

PUT /Asset/District/Availability
POST /Asset/District/Availability/put

对于不支持PUT请求的网络环境，请尝试使用备份的POST请求地址

请求示例

{
    "DistrictCode":"27594",
    "Enabled":"0"
}

参数说明

参数	是否必须	说明
DistrictCode	是	区域编码
Enabled	是	是否禁用（0：禁用、1：启用）

返回结果

{}

对于成功删除的请求，该接口仅返回HTTP 200 OK

附录

1. 支持的查询参数

如无特别说明，下列操作对于查询实体对象中的任意属性均适用。使用时只需将其追加至请求的querystring中即可。对实体对象中不存在的属性进行操作将会得到不可预期的结果。

分页

skip={数字} 跳过指定条数的记录数

take={数字}取出指定条数的记录数（注：最大值为1500，即单页最多返回1500条数据）

include=total 需要返回记录总数

排序

orderBy=[-]{属性名称},[-]{属性名称} 返回结果按指定属性排序，在名称前加”-“表示按倒序排序。多个属性的排序可使用逗号分隔。如：orderBy=-Id,Name,-Age

条件过滤

不等于

{属性名称}!={值} 如：Id!=1

大于等于

>{属性名称}={值} 如：>Id=1

大于

{属性名称}>={值} 如：Id>=1

小于

<{属性名称}={值} 如：<Id=1

小于等于

{属性名称}<={值} 如：Id<=1

In

{属性名称}In={值，值，值} 属性的值需包含在指定的集合中，如：IdIn=1,2,3

Between

{属性名称}Between={值，值} 属性的值需处于指定的区间之间，仅支持数字，如： IdBetween=1,3

字符串包含指定字符

{属性名称}Contains={值} 如：nameContains=abc

字符串以指定字符开头

{属性名称}StartsWith={值} 如：nameStartsWith=abc

字符串以指定字符结尾

{属性名称}EndsWith={值} 如：nameEndsWith=abc

2. 数据实体格式

1. 区域数据对象格式

属性名称	说明
code	区域编码
name	区域名称
id	区域id
disabled	是否被禁用