Boundaries.GetOverlapAsync Method

Reference

Definition

Namespace:: Azure.Verticals.AgriFood.Farming

Assembly:: Azure.Verticals.AgriFood.Farming.dll

Package:: Azure.Verticals.AgriFood.Farming v1.0.0-beta.2

Source:: Boundaries.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns overlapping area between two boundary Ids.

public virtual System.Threading.Tasks.Task<Azure.Response> GetOverlapAsync (string partyId, string boundaryId, string otherPartyId, string otherBoundaryId, Azure.RequestContext context = default);

abstract member GetOverlapAsync : string * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetOverlapAsync : string * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetOverlapAsync (partyId As String, boundaryId As String, otherPartyId As String, otherBoundaryId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

partyId: String

Id of the party.

boundaryId: String

Id of the boundary.

otherPartyId: String

PartyId of the other field.

otherBoundaryId: String

Id of the other boundary.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service. Details of the response body schema are in the Remarks section below.

Exceptions

ArgumentNullException

partyId, boundaryId, otherPartyId or otherBoundaryId is null.

ArgumentException

partyId or boundaryId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetOverlapAsync with required parameters and parse the result.

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetBoundariesClient(<2022-11-01-preview>);

Response response = await client.GetOverlapAsync("<partyId>", "<boundaryId>", "<otherPartyId>", "<otherBoundaryId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("boundaryArea").ToString());
Console.WriteLine(result.GetProperty("otherBoundaryArea").ToString());
Console.WriteLine(result.GetProperty("intersectingArea").ToString());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for BoundaryOverlapResponse:

{
  boundaryArea: number, # Optional. Acreage of Main boundary.
  otherBoundaryArea: number, # Optional. Acreage of other boundary.
  intersectingArea: number, # Optional. Acreage of intersecting boundary.
}

Applies to

Share via