Prescriptions - Get

  • Reference
Service:
Azure Data Manager for Agriculture
API Version:
2023-11-01-preview

Gets a specified prescription resource under a particular party.

GET {endpoint}/parties/{partyId}/prescriptions/{prescriptionId}?api-version=2023-11-01-preview

URI Parameters

Name In Required Type Description
endpoint
 path True

string

uri

The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net
partyId
 path True

string

Id of the associated party.
prescriptionId
 path True

string

Id of the prescription.
api-version
 query True

string

The requested API version

Request Header

Name Required Type Description
Authorization True

string

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Responses

Name Type Description
200 OK

Prescription

Success
Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Security

Authorization

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Type: apiKey
In: header

Examples

Prescriptions_Get

Sample request

GET {endpoint}/parties/PARTY123/prescriptions/PRESCRIPTION123?api-version=2023-11-01-preview

Sample response

Status code:
200 
{
  "id": "PRESCRIPTION123",
  "partyId": "PARTY123",
  "prescriptionMapId": "PRESCRIPTINMAP123",
  "productCode": "PRODUCTCODE123",
  "productName": "Some name",
  "type": "Planting",
  "measurements": {
    "total material": {
      "value": 12,
      "unit": "pounds"
    },
    "rate": {
      "value": 13,
      "unit": "Km/hr"
    }
  },
  "name": "John Smith's Prescription",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "modifiedBy": "00000000-0000-0000-0000-000000000000",
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Definitions

Name Description
Error

An error from the Azure AgPlatform service.
ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
GeoJsonObjectType

GeoJSON object type.
InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
Measure

Schema for storing measurement reading and unit.
MultiPolygon

MultiPolygon geometry.
Point

Point geometry.
Polygon

Polygon geometry.
Prescription

Api Model for Prescription object.

Error

An error from the Azure AgPlatform service.

Name Type Description
code

string

Server-defined set of error codes.
details

Error[]

Array of details about specific errors that led to this reported error.
innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
message

string

Human-readable representation of the error.
target

string

Target of the error.

ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

Name Type Description
error

Error

An error from the Azure AgPlatform service.
traceId

string

Unique trace Id.

GeoJsonObjectType

GeoJSON object type.

Name Type Description
MultiPolygon

string

Point

string

Polygon

string

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Name Type Description
code

string

Specific error code than was provided by the containing error.
innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Measure

Schema for storing measurement reading and unit.

Name Type Description
unit

string

Data unit.
value

number

Data value.

MultiPolygon

MultiPolygon geometry.

Name Type Description
coordinates

number[]

Gets or sets Coordinates of GeoJSON Object. It must be an array of polygons, each polygon contains list of linear rings. For Polygons with more than one of these rings, the first MUST be the exterior ring, and any others MUST be interior rings.
type string:

MultiPolygon

GeoJSON object type.

Point

Point geometry.

Name Type Description
coordinates

number[]

Gets or sets the coordinate of this point. It must be an array of 2 or 3 elements for a 2D or 3D system.
type string:

Point

GeoJSON object type.

Polygon

Polygon geometry.

Name Type Description
coordinates

number[]

Gets or sets type of the GeoJSON Object. It must be an array of linear ring coordinate arrays. For Polygons with more than one of these rings, the first MUST be the exterior ring, and any others MUST be interior rings.
type string:

Polygon

GeoJSON object type.

Prescription

Api Model for Prescription object.

Name Type Description
createdBy

string

Created by user/tenant id.
createdDateTime

string

Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
description

string

Textual description of the resource.
eTag

string

The ETag value to implement optimistic concurrency.
geometry GeoJsonObject:

GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.
id

string

Unique resource ID.
measurements

<string,  Measure>

Measures.
modifiedBy

string

Modified by user/tenant id.
modifiedDateTime

string

Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
name

string

Name to identify resource.
partyId

string

Party Id.
prescriptionMapId

string

Prescription map Id.
productCode

string

Product Code.
productName

string

Product name.
properties

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.
source

string

Source of the resource.
status

string

Status of the resource.
type

string

Prescription type.