Sensor Partner Integrations - Check Consent

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Verifica o consentimento para integração de parceiros.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
integrationId	path	True	string	ID do objeto de integração.
sensorPartnerId	path	True	string	ID do parceiro do sensor.
api-version	query	True	string	A versão da API solicitada
key	query	True	string	Chave de integração do parceiro.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas à API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Respostas

Nome	Tipo	Description
200 OK	SensorPartnerIntegrationCheckConsentResponse	Êxito
Other Status Codes	ErrorResponse	Erro Headers x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas à API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Type: apiKey
In: header

Exemplos

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"
}

Definições

Nome	Description
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço AgPlatform do Azure. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
SensorPartnerIntegrationCheckConsentResponse	Integração de parceiros do sensor marcar resposta de consentimento.

Error

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message	string	Representação legível ao olho humano do erro.
target	string	Destino do erro.

ErrorResponse

Uma resposta de erro do serviço AgPlatform do Azure. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Nome	Tipo	Description
code	string	Código de erro específico que foi fornecido pelo erro que o contém.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

SensorPartnerIntegrationCheckConsentResponse

Integração de parceiros do sensor marcar resposta de consentimento.

Nome	Tipo	Description
consented	boolean	Sinalizador para determinar a status do consentimento de integração de parceiros.
integrationId	string	ID da integração.
sensorPartnerId	string	ID do parceiro de sensor associado.