PlantingData.GetPlantingDataAsync(String, String, RequestContext) Method

Definition

Namespace:

Azure.Verticals.AgriFood.Farming

Assembly:

Azure.Verticals.AgriFood.Farming.dll

Package:

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

Source:

PlantingData.cs

Get a specified planting data resource under a particular party.

public virtual System.Threading.Tasks.Task<Azure.Response> GetPlantingDataAsync (string partyId, string plantingDataId, Azure.RequestContext context = default);

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

Public Overridable Function GetPlantingDataAsync (partyId As String, plantingDataId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

partyId

String

ID of the associated party resource.

plantingDataId

String

ID of the planting data resource.

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 or plantingDataId is null.

ArgumentException

partyId or plantingDataId 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 GetPlantingDataAsync with required parameters and parse the result.

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

Response response = await client.GetPlantingDataAsync("<partyId>", "<plantingDataId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("avgPlantingRate").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("avgPlantingRate").GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("totalMaterial").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("totalMaterial").GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("avgMaterial").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("avgMaterial").GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("plantingProductDetails")[0].GetProperty("productName").ToString());
Console.WriteLine(result.GetProperty("plantingProductDetails")[0].GetProperty("area").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("plantingProductDetails")[0].GetProperty("area").GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("plantingProductDetails")[0].GetProperty("totalMaterial").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("plantingProductDetails")[0].GetProperty("totalMaterial").GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("plantingProductDetails")[0].GetProperty("avgMaterial").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("plantingProductDetails")[0].GetProperty("avgMaterial").GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("area").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("area").GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("operationModifiedDateTime").ToString());
Console.WriteLine(result.GetProperty("operationStartDateTime").ToString());
Console.WriteLine(result.GetProperty("operationEndDateTime").ToString());
Console.WriteLine(result.GetProperty("attachmentsLink").ToString());
Console.WriteLine(result.GetProperty("associatedBoundaryId").ToString());
Console.WriteLine(result.GetProperty("partyId").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("eTag").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("modifiedDateTime").ToString());
Console.WriteLine(result.GetProperty("source").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("createdBy").ToString());
Console.WriteLine(result.GetProperty("modifiedBy").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("<test>").ToString());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for PlantingData:

{
  avgPlantingRate: {
    unit: string, # Optional. Data unit.
    value: number, # Optional. Data value.
  }, # Optional. Schema for storing measurement reading and unit.
  totalMaterial: Measure, # Optional. Schema for storing measurement reading and unit.
  avgMaterial: Measure, # Optional. Schema for storing measurement reading and unit.
  plantingProductDetails: [
    {
      productName: string, # Optional. Name of the product.
      area: Measure, # Optional. Schema for storing measurement reading and unit.
      totalMaterial: Measure, # Optional. Schema for storing measurement reading and unit.
      avgMaterial: Measure, # Optional. Schema for storing measurement reading and unit.
    }
  ], # Optional. Planting product details.
  area: Measure, # Optional. Schema for storing measurement reading and unit.
  operationModifiedDateTime: string (ISO 8601 Format), # Optional. Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
Note: this will be specified by the source provider itself.
  operationStartDateTime: string (ISO 8601 Format), # Optional. Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
  operationEndDateTime: string (ISO 8601 Format), # Optional. End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
  attachmentsLink: string, # Optional. Link for attachments.
  associatedBoundaryId: string, # Optional. Optional boundary ID of the field for which operation was applied.
  partyId: string, # Optional. Party ID which belongs to the operation data.
  id: string, # Optional. Unique resource ID.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
  status: string, # Optional. Status of the resource.
  createdDateTime: string (ISO 8601 Format), # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
  modifiedDateTime: string (ISO 8601 Format), # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
  source: string, # Optional. Source of the resource.
  name: string, # Optional. Name to identify resource.
  description: string, # Optional. Textual description of the resource.
  createdBy: string, # Optional. Created by user/tenant id.
  modifiedBy: string, # Optional. Modified by user/tenant id.
  properties: Dictionary<string, any>, # Optional. A collection of key value pairs that belongs to the resource.
Each pair must not have a key greater than 50 characters
and must not have a value greater than 150 characters.
Note: A maximum of 25 key value pairs can be provided for a resource and only string,
numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
}