Sensor Partner Integrations - Check Consent

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Vérifie le consentement pour l’intégration du partenaire.

POST {endpoint}/sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:check-consent?key={key}&api-version=2023-11-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string uri	Nom d’hôte de l’espace de noms, par exemple admaInstanceName.farmbeats.azure.net
integrationId	path	True	string	ID de l’objet d’intégration.
sensorPartnerId	path	True	string	ID du partenaire de capteur.
api-version	query	True	string	Version de l’API demandée
key	query	True	string	Clé d’intégration de partenaire.

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 déjà essayé des appels non authentifiés.

Réponses

Nom	Type	Description
200 OK	SensorPartnerIntegrationCheckConsentResponse	Succès
Other Status Codes	ErrorResponse	Error Headers 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 déjà essayé des appels non authentifiés.

Type: apiKey
In: header

Exemples

SensorPartnerIntegrations_CheckConsent

Sample Request

HTTP

POST {endpoint}/sensor-partners/Davis/integrations/I123/:check-consent?key=CuDBfxEiFdTJFk40MNVMO22zvLBG7CA8&api-version=2023-11-01-preview

Sample Response

Status code:

200

{
  "consented": true,
  "sensorPartnerId": "Davis",
  "integrationId": "I123"
}

Définitions

Nom	Description
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 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 le document de référence InnerError.
SensorPartnerIntegrationCheckConsentResponse	Intégration du partenaire de capteur case activée réponse de consentement.

Error

Erreur du service Azure AgPlatform.

Nom	Type	Description
code	string	Ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les 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 le document de référence InnerError.
message	string	Représentation contrôlable de visu de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

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

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

InnerError

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

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

SensorPartnerIntegrationCheckConsentResponse

Intégration du partenaire de capteur case activée réponse de consentement.

Nom	Type	Description
consented	boolean	Indicateur permettant de déterminer le status du consentement d’intégration du partenaire.
integrationId	string	ID de l’intégration.
sensorPartnerId	string	ID du partenaire de capteur associé.