Boundaries - Get

Hier erhalten Sie eine angegebene Begrenzungsressource für einen bestimmten Halter.

GET /farmers/{farmerId}/boundaries/{boundaryId}?api-version=2021-03-31-preview

URI-Parameter

Name In Required Type Description
boundaryId
path True
  • string

ID der Grenze.

farmerId
path True
  • string

ID des zugeordneten Halters.

api-version
query True
  • string

Die angeforderte API-Version.

Anforderungsheader

Name Required Type Description
Authorization True
  • string

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe versucht haben.

Antworten

Name Type Description
200 OK

Erfolg

Other Status Codes

Fehler

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe versucht haben.

Type: apiKey
In: header

Beispiele

Boundaries_Get

Sample Request

GET /farmers/FARMER123/boundaries/BOUNDARY123?api-version=2021-03-31-preview

Sample Response

{
  "parentId": "FIELD123",
  "isPrimary": false,
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.704571723937988,
          20.545385304358106
        ],
        [
          73.704571723937988,
          20.545385304358106
        ],
        [
          73.704485893249512,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.710236549377441,
          20.545083911372505
        ],
        [
          73.706631660461426,
          20.546992723579137
        ],
        [
          73.704571723937988,
          20.545385304358106
        ]
      ]
    ]
  },
  "name": "John Smith's Boundary",
  "description": "Some description"
}

Definitionen

Boundary

Schema der Begrenzungsressource.

Error

Ein Fehler Azure FarmBeats Diensts.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. ErrorResponse-Referenzdokument..

GeoJsonObjectType

GeoJSON-Objekttyp.

InnerError

Innerer Fehler, der eine Liste der Fehler enthält. InnerError-Referenzdokument.

MultiPolygon

MultiPolygon-Geometrie.

Point

Punktgeometrie.

Polygon

Polygongeometrie.

Boundary

Schema der Begrenzungsressource.

Name Type Description
acreage
  • number

Bereich der Grenze in Ungn.

createdDateTime
  • string

UTC-Datum und -Uhrzeit, zu der die Ressource erstellt wurde (Format: yyyy-MM-ddTHH:mm:ssZ).

description
  • string

Kurze Beschreibung der Grenze.

eTag
  • string

Der ETag-Wert kann verwendet werden, um optimistische Parallelität zu implementieren.

farmerId
  • string

ID des zugeordneten Halters.

geometry GeoJsonObject:

Abstrakte GeoJSON-Klasse.

id
  • string

Eindeutige ID der Grenze.Diese ID ist für einen bestimmten Halter eindeutig.

isPrimary
  • boolean

Gibt an, ob die Grenze eine primäre Grenze für das zugeordnete übergeordnete Element ist (sofern dies der Fall ist).

modifiedDateTime
  • string

UTC-Datum/Uhrzeit der letzten Änderung der Ressource (Format: yyyy-MM-ddTHH:mm:ssZ).

name
  • string

Name der Grenze.

parentId
  • string

Wenn die Grenze einem Feld oder einem saisonalen Feld zugeordnet ist, verweist die übergeordnete ID auf die ID des Felds/saisonalen Felds.

parentType
  • string

Gibt an, ob das übergeordnete Feld ein Feld oder ein saisonales Feld ist. Zulässige Werte sind "Field" und "SeasonalField".

properties
  • object

Eine Auflistung von Schlüssel-Wert-Paaren, die der Ressource zugeordnet sind.Ein Schlüssel ist eine Zeichenfolge, und ein Wert kann eine numerische oder eine Zeichenfolge sein.Einer Ressource können maximal 25 Schlüssel-Wert-Paare zugeordnet werden.

status
  • string

Vom Benutzer festgelegter Status der Ressource.

Error

Ein Fehler Azure FarmBeats Diensts.

Name Type Description
code
  • string

Serverdefinierter Satz von Fehlercodes.

details

Array mit Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.

innererror

Innerer Fehler, der eine Liste der Fehler enthält. InnerError-Referenzdokument.

message
  • string

Lesbare Darstellung des Fehlers.

target
  • string

Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. ErrorResponse-Referenzdokument..

Name Type Description
error

Ein Fehler Azure FarmBeats Diensts.

traceId
  • string

Eindeutige Ablaufverfolgungs-ID.

GeoJsonObjectType

GeoJSON-Objekttyp.

Name Type Description
MultiPolygon
  • string
Point
  • string
Polygon
  • string

InnerError

Innerer Fehler, der eine Liste der Fehler enthält. InnerError-Referenzdokument.

Name Type Description
code
  • string

Ein bestimmter Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.

innererror

Innerer Fehler, der eine Liste der Fehler enthält. InnerError-Referenzdokument.

MultiPolygon

MultiPolygon-Geometrie.

Name Type Description
coordinates
  • array[]

Ruft Koordinaten des GeoJSON-Objekts ab oder legt sie fest. Es muss ein Array von Polygonen sein. Jedes Polygon enthält eine Liste linearer Ringe. Für Polygone mit mehr als einem dieser Ringe MUSS der erste der äußere Ring sein, und alle anderen MÜSSEN innere Ringe sein.

type string:

GeoJSON-Objekttyp.

Point

Punktgeometrie.

Name Type Description
coordinates
  • number[]

Ruft die Koordinate dieses Punkts ab oder legt sie fest. Es muss ein Array von 2 oder 3 Elementen für ein 2D- bzw. 3D-System sein.

type string:

GeoJSON-Objekttyp.

Polygon

Polygongeometrie.

Name Type Description
coordinates
  • array[]

Ruft den Typ des GeoJSON-Objekts ab oder legt diesen fest. Es muss ein Array von linearen Ringkoordinatenarrays sein. Für Polygone mit mehr als einem dieser Ringe MUSS der erste der äußere Ring sein, und alle anderen MÜSSEN innere Ringe sein.

type string:

GeoJSON-Objekttyp.