你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Parties - Geo Overlap
返回两个资源之间的重叠区域。
POST {endpoint}/parties:overlap?api-version=2023-11-01-preview
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
命名空间的主机名,例如 admaInstanceName.farmbeats.azure.net |
api-version
|
query | True |
string |
请求的 API 版本 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
resources |
资源列表。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
错误 Headers x-ms-error-code: string |
安全性
Authorization
请为授权的 API 调用提供有效的持有者令牌。 请注意,如果之前尝试过未经身份验证的调用,则可能需要清除浏览器缓存。
Type:
apiKey
In:
header
示例
Parties_GeoOverlap
Sample Request
POST {endpoint}/parties:overlap?api-version=2023-11-01-preview
{
"resources": [
{
"partyId": "PARTY123",
"resourceType": "Field",
"resourceId": "FIELD123"
},
{
"partyId": "PARTY456",
"resourceType": "Field",
"resourceId": "FIELD456"
}
]
}
Sample Response
{
"resources": [
{
"partyId": "PARTY123",
"resourceType": "Field",
"resourceId": "FIELD123",
"resourceArea": 35
},
{
"partyId": "PARTY456",
"resourceType": "Field",
"resourceId": "FIELD456",
"resourceArea": 25
}
],
"overlappingArea": 10
}
定义
名称 | 说明 |
---|---|
Error |
Azure AgPlatform 服务出错。 |
Error |
来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。 |
Inner |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
Overlap |
重叠资源的架构。 |
Overlap |
重叠资源查询参数。 |
Party |
参与方重叠响应的架构。 |
Error
Azure AgPlatform 服务出错。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的错误代码集。 |
details |
Error[] |
有关导致此报告错误的特定错误的详细信息数组。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
|
message |
string |
错误的用户可读表示形式。 |
target |
string |
错误的目标。 |
ErrorResponse
来自 Azure AgPlatform 服务的错误响应。 有关 ErrorResponse 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
名称 | 类型 | 说明 |
---|---|---|
error |
Azure AgPlatform 服务出错。 |
|
traceId |
string |
唯一跟踪 ID。 |
InnerError
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
包含错误提供的特定错误代码。 |
innererror |
包含错误列表的内部错误。有关 InnerError 参考文档,请参阅 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 。 |
OverlapResource
重叠资源的架构。
名称 | 类型 | 说明 |
---|---|---|
partyId |
string |
资源的参与方 ID。 |
resourceArea |
number |
资源的面积。 |
resourceId |
string |
资源的 ID。 |
resourceType |
string |
资源的资源类型。 |
OverlapResourcesQuery
重叠资源查询参数。
名称 | 类型 | 说明 |
---|---|---|
resources |
资源列表。 |
PartyOverlapResponse
参与方重叠响应的架构。
名称 | 类型 | 说明 |
---|---|---|
overlappingArea |
number |
重叠区域的面积。 |
resources |
具有区域的资源。 |