Boundaries - Get Overlap

Service:: Azure Data Manager for Agriculture

Version d'API:: 2023-06-01-preview

Retourne une zone qui se chevauche entre deux ID de limite.

GET /parties/{partyId}/boundaries/{boundaryId}/overlap?otherPartyId={otherPartyId}&otherBoundaryId={otherBoundaryId}&api-version=2023-06-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
boundaryId	path	True	string	ID de la limite.
partyId	path	True	string	ID de la partie.
api-version	query	True	string	Version de l’API demandée
otherBoundaryId	query	True	string	ID de l’autre limite.
otherPartyId	query	True	string	PartyId de l’autre champ.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez essayé des appels non authentifiés avant.

Réponses

Nom	Type	Description
200 OK	BoundaryOverlapResponse	Succès
Other Status Codes	ErrorResponse	Erreur En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

BoundaryOverlapResponse

Succès

Other Status Codes

ErrorResponse

Erreur

En-têtes

x-ms-error-code: string

Sécurité

Authorization

Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez essayé des appels non authentifiés avant.

Type: apiKey
Dans: header

Exemples

Boundaries_GetOverlap

Exemple de requête

HTTP

GET /parties/PARTY123/boundaries/BOUNDARY123/overlap?otherPartyId=PARTY456&otherBoundaryId=BOUNDARY56&api-version=2023-06-01-preview

Exemple de réponse

Code d’état:: 200

{
  "boundaryArea": 35,
  "otherBoundaryArea": 25,
  "intersectingArea": 10
}

Définitions

Nom	Description
BoundaryOverlapResponse	Schéma de la réponse de chevauchement des limites.
Error	Erreur du service Azure AgPlatform.
ErrorResponse	Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses pour le document de référence ErrorResponse.
InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.

BoundaryOverlapResponse

Object

Schéma de la réponse de chevauchement des limites.

Nom	Type	Description
boundaryArea	number (double)	Acreage de la limite principale.
intersectingArea	number (double)	Acreage de la limite d’intersection.
otherBoundaryArea	number (double)	Acreage d’autres limites.

Error

Object

Erreur du service Azure AgPlatform.

Nom	Type	Description
code	string minLength: 1	Ensemble défini par le serveur de codes d’erreur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.
message	string minLength: 1	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Object

Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses pour le document de référence ErrorResponse.

Nom	Type	Description
error	Error	Erreur du service Azure AgPlatform.
traceId	string	ID de trace unique.

InnerError

Object

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.

Nom	Type	Description
code	string	Code d’erreur spécifique que fourni par l’erreur contenante.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.