Weather Data - Get

Riferimento

Servizio:: Azure Data Manager for Agriculture

Versione API:: 2023-11-01-preview

Restituisce un elenco di WeatherData.

POST {endpoint}/weather-data:fetch?api-version=2023-11-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string uri	Nome host dello spazio dei nomi, ad esempio admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Versione dell'API richiesta

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
extensionApiName	True	string	Nome api di estensione a cui deve essere effettuata la richiesta.
extensionId	True	string	ID dell'estensione da usare per providerInput. Ad esempio: DTN. ClearAg.
units	True	string	Unità per le quali deve essere inviata la richiesta al provider di dati. I valori supportati sono 'e' per le unità inglesi, 'm' per unità metrica, 'h' per unità ibride (Regno Unito) e 's' per unità METRICA SI.
additionalParams		AdditionalProviderParameters	Schema di parametri aggiuntivi per la richiesta del provider di dati meteo.
credentials		ApiKeyAuthCredentials	Classe Api Key Auth Credentials per l'autenticazione basata su chiave API.
duration		integer	Specifica il numero di giorni in cui vengono restituite le risposte di previsione giornaliere. I valori disponibili sono 1, 5, 10, 25 e 45. (Applicabile solo per l'estensione Mappe meteo di Azure).
endTimeHours		integer	Fine dell'intervallo di tempo. (applicabile solo per DTN. Estensione ClearAg.
language		string	Lingua (tag di lingua IETF BCP 47) in cui i risultati della ricerca devono essere restituiti dal provider di dati. Esempi: 'en-US', 'es', 'es-MX', 'fr-FR'.
locations		WeatherLocation[]	Elenco delle località per cui è necessario recuperare i dati meteo dal provider.
startTimeHours		integer	Inizio dell'intervallo di tempo. L'ora 0 rappresenta l'ora corrente. (applicabile solo per DTN. Estensione ClearAg.

Risposte

Nome	Tipo	Descrizione
200 OK	WeatherDataProviderResponse	Operazione completata
Other Status Codes	ErrorResponse	Errore Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

WeatherDataProviderResponse

Operazione completata

Other Status Codes

ErrorResponse

Errore

Intestazioni

x-ms-error-code: string

Sicurezza

Authorization

Specificare un token di connessione valido per le chiamate API autorizzate. Si noti che potrebbe essere necessario cancellare la cache del browser se si è tentato di eseguire chiamate non autenticate prima.

Tipo: apiKey
In: header

Esempio

WeatherData_Get

Esempio di richiesta

HTTP

POST {endpoint}/weather-data:fetch?api-version=2023-11-01-preview

{
  "extensionId": "IBM.TWC",
  "extensionApiName": "currents-on-demand",
  "locations": [
    {
      "type": "LatLong",
      "value": "33,-97"
    }
  ],
  "language": "en-US",
  "units": "e",
  "credentials": {
    "kind": "ApiKeyAuthCredentials",
    "apiKey": {
      "keyVaultUri": "https://<keyvaultname>.vault.azure.net/",
      "keyName": "string",
      "keyVersion": "string"
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "weatherMetadata": {
    "extensionVersion": "1.0",
    "weatherDataType": "current",
    "extensionId": "IBM.TWC",
    "extensionApiName": "currents-on-demand",
    "units": "e"
  },
  "status": "Succeeded",
  "locations": [
    {
      "location": {
        "type": "LatLong",
        "value": "33,-97"
      },
      "lastRefreshedDateTime": "2023-02-09T13:02:20Z",
      "data": {
        "dayOfWeek": [
          "Wednesday"
        ],
        "dayOrNight": [
          "Night"
        ],
        "pressureMeanSeaLevel": {
          "unit": "inches of mercury",
          "value": [
            1021.1
          ]
        },
        "relativeHumidity": {
          "unit": "percentage",
          "value": [
            84
          ]
        },
        "temperature": {
          "unit": "fahrenheit",
          "value": [
            49
          ]
        },
        "temperatureDewPoint": {
          "unit": "fahrenheit",
          "value": [
            44
          ]
        },
        "temperatureFeelsLike": {
          "unit": "fahrenheit",
          "value": [
            47
          ]
        },
        "temperatureHeatIndex": {
          "unit": "fahrenheit",
          "value": [
            49
          ]
        },
        "temperatureWindChill": {
          "unit": "fahrenheit",
          "value": [
            47
          ]
        },
        "uvDescription": [
          "Low"
        ],
        "uvIndex": [
          0
        ],
        "visibility": {
          "unit": "miles",
          "value": [
            10
          ]
        },
        "windDirection": {
          "unit": "degree",
          "value": [
            150
          ]
        },
        "windGust": {
          "unit": "miles/hour",
          "value": [
            0
          ]
        },
        "windSpeed": {
          "unit": "miles/hour",
          "value": [
            4
          ]
        },
        "additionalAttributes": {
          "cloudCoverPhrase": [
            "Partly Cloudy"
          ]
        }
      }
    }
  ],
  "errors": {
    "locations": []
  }
}

Definizioni

Nome	Descrizione
AdditionalProviderParameters	Schema di parametri aggiuntivi per la richiesta del provider di dati meteo.
ApiKeyAuthCredentials	Classe Api Key Auth Credentials for API Key based Auth.
AuthCredentialsKind	Enumerazione per diversi tipi di AuthCredentials supportati.
Error	Errore del servizio Azure AgPlatform.
ErrorForLocation	Modello per informazioni sugli errori per una posizione non riuscita.
ErrorResponse	Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses per il documento di riferimento ErrorResponse.
InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.
KeyVaultProperties	Proprietà dell'insieme di credenziali delle chiavi.
LocationType	Tipo di posizione, ad esempio. LatLong/IataCode/IcaoCode/Placeid/PostalKey.
Measures	Schema per l'archiviazione delle letture delle misurazioni e dell'unità.
Status	Indica una risposta riuscita, non riuscita o ParzialmenteSucceed.
WeatherDataErrors	Modello per gli errori rilevati per tutte le posizioni non riuscite.
WeatherDataForPassthrough	Schema dei dati meteo.
WeatherDataProviderRequest	Schema della richiesta del provider di dati meteo.
WeatherDataProviderResponse	Schema della risposta del provider di dati meteo.
WeatherLocation	Schema dei dati di posizione.
WeatherLocationData	Schema dei dati WeatherLocationData.
WeatherMetadata	Schema dei metadati meteo.

AdditionalProviderParameters

Schema di parametri aggiuntivi per la richiesta del provider di dati meteo.

Nome	Tipo	Valore predefinito	Descrizione
details	boolean	True	Dettagli (applicabile solo per AzureWeatherMaps).
iconResolution	string		Risoluzione delle icone (applicabile solo per AzureWeatherMaps).

ApiKeyAuthCredentials

Classe Api Key Auth Credentials for API Key based Auth.

Nome	Tipo	Descrizione
apiKey	KeyVaultProperties	Proprietà dell'insieme di credenziali delle chiavi.
kind	string: ApiKeyAuthCredentials	Enumerazione per diversi tipi di AuthCredentials supportati.

AuthCredentialsKind

Enumerazione per diversi tipi di AuthCredentials supportati.

Nome	Tipo	Descrizione
ApiKeyAuthCredentials	string
OAuthClientCredentials	string

Error

Errore del servizio Azure AgPlatform.

Nome	Tipo	Descrizione
code	string	Set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object per il documento di riferimento InnerError.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorForLocation

Modello per informazioni sugli errori per una posizione non riuscita.

Nome	Tipo	Descrizione
code	integer	Codice di stato restituito dal provider di dati.
description	string	Descrizione dell'errore.
location	WeatherLocation	Schema dei dati location.
retryable	boolean	Flag che suggerisce se è necessario eseguire un nuovo tentativo con lo stesso corpo della richiesta per recuperare i dati necessari.

ErrorResponse

Risposta di errore dal servizio Azure AgPlatform. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses per il documento di riferimento ErrorResponse.

Nome	Tipo	Descrizione
error	Error	Errore del servizio Azure AgPlatform.
traceId	string	ID traccia univoco.

InnerError

Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.

Nome	Tipo	Descrizione
code	string	Codice di errore specifico di quello fornito dall'errore che lo contiene.
innererror	InnerError	Errore interno contenente l'elenco di errori. Vedere https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object il documento di riferimento per InnerError.

KeyVaultProperties

Proprietà dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
keyName	string	Nome della chiave di Key Vault.
keyVaultUri	string	Uri dell'insieme di credenziali delle chiavi.
keyVersion	string	Versione della chiave di Key Vault.

LocationType

Tipo di posizione, ad esempio. LatLong/IataCode/IcaoCode/Placeid/PostalKey.

Nome	Tipo	Descrizione
IataCode	string
IcaoCode	string
LatLong	string
PlaceId	string
PostalKey	string

Measures

Schema per l'archiviazione delle letture delle misurazioni e dell'unità.

Nome	Tipo	Descrizione
unit	string	Unità dati.
value	number[]	Valori dei dati.

Status

Indica una risposta riuscita, non riuscita o ParzialmenteSucceed.

Nome	Tipo	Descrizione
Failed	string
PartiallySucceeded	string
Succeeded	string

WeatherDataErrors

Modello per gli errori rilevati per tutte le posizioni non riuscite.

Nome	Tipo	Descrizione
locations	ErrorForLocation[]	Elenco degli errori rilevati per tutte le posizioni non riuscite.

WeatherDataForPassthrough

Schema dei dati meteo.

Nome	Tipo	Descrizione
additionalAttributes		Raccolta di coppie di valori chiave appartenenti alla risorsa. Ogni coppia non deve avere una chiave maggiore di 50 caratteri e non deve avere un valore maggiore di 250 caratteri. Nota: è possibile specificare un massimo di 100 coppie di valori chiave per una risorsa e sono supportati solo valori stringa e numerali.
cloudCover	Measures	Schema per archiviare letture e unità di misurazione.
dayOfWeek	string[]	Giorno della settimana.
dayOrNight	string[]	Questo campo dati indica se è giorno o notte in base all'ora apparente locale della posizione.
expirationTime	string[]	Data di scadenza in formato Utc.
hasPrecipitation	boolean[]	Indica se vi sono precipitazioni o meno.
iconCode	integer[]	Questo numero è la chiave per la ricerca dell'icona meteo. Il campo dati mostra il numero di icona corrispondente per rappresentare le condizioni meteo osservate.
iconCodeExtend	integer[]	Codice che rappresenta il tempo sensibile del set completo.
pressureMeanSeaLevel	Measures	Schema per archiviare letture e unità di misurazione.
relativeHumidity	Measures	Schema per archiviare letture e unità di misurazione.
temperature	Measures	Schema per archiviare letture e unità di misurazione.
temperatureDewPoint	Measures	Schema per archiviare letture e unità di misurazione.
temperatureFeelsLike	Measures	Schema per archiviare letture e unità di misurazione.
temperatureHeatIndex	Measures	Schema per l'archiviazione delle letture delle misurazioni e dell'unità.
temperatureWindChill	Measures	Schema per l'archiviazione delle letture delle misurazioni e dell'unità.
uvDescription	string[]	Descrizione dell'indice UV che integra il valore dell'indice UV fornendo un livello associato di rischio di danni alla pelle a causa dell'esposizione (-2 = Non disponibile, -1 = No Report, da 0 a 2 = Basso, da 3 a 5 = Moderato, da 6 a 7 = Alto, da 8 a 10 = Molto alto, da 11 a 16 = Estremo).
uvIndex	number[]	Indice UV massimo orario.
validTime	string[]	La previsione dell'ora è valida in formato Utc.
validTimeLocal	string[]	La previsione temporale è valida nell'ora apparente locale.
visibility	Measures	Schema per l'archiviazione delle letture delle misurazioni e dell'unità.
wetBulbTemperature	Measures	Schema per archiviare letture e unità di misurazione.
windDirection	Measures	Schema per l'archiviazione delle letture delle misurazioni e dell'unità.
windGust	Measures	Schema per l'archiviazione delle letture delle misurazioni e dell'unità.
windSpeed	Measures	Schema per l'archiviazione delle letture delle misurazioni e dell'unità.
wxPhraseLong	string[]	Frase meteo ragionevole ogni ora contenente una descrizione più lunga.
wxPhraseShort	string[]	Frase meteo ragionevole ogni ora contenente una breve descrizione.

WeatherDataProviderRequest

Schema della richiesta del provider di dati meteo.

Nome	Tipo	Descrizione
additionalParams	AdditionalProviderParameters	Schema di parametri aggiuntivi per la richiesta del provider di dati meteo.
credentials	ApiKeyAuthCredentials	Classe Api Key Auth Credentials for API Key based Auth.
duration	integer	Specifica il numero di giorni in cui vengono restituite le risposte di previsione giornaliere. I valori disponibili sono 1, 5, 10, 25 e 45. (applicabile solo per l'estensione Mappe meteo di Azure).
endTimeHours	integer	Intervallo di tempo finale. (applicabile solo per DTN. Estensione ClearAg.
extensionApiName	string	Nome dell'api di estensione a cui effettuare la richiesta.
extensionId	string	ID dell'estensione da usare per il providerInput. Ad esempio: DTN. ClearAg.
language	string	Lingua (tag di lingua IETF BCP 47) in cui i risultati della ricerca devono essere restituiti dal provider di dati. Esempi: 'en-US', 'es', 'es-MX', 'fr-FR'.
locations	WeatherLocation[]	Elenco delle località per cui è necessario recuperare i dati meteo dal provider.
startTimeHours	integer	Inizio dell'intervallo di tempo. L'ora 0 rappresenta l'ora corrente. (applicabile solo per DTN. Estensione ClearAg.
units	string	Unità per cui deve essere inviata la richiesta al provider di dati. I valori supportati sono 'e' per le unità inglesi, 'm' per le unità metriche, 'h' per unità ibride (UK) e 's' per le unità METRICA SI.

WeatherDataProviderResponse

Schema della risposta del provider di dati meteo.

Nome	Tipo	Descrizione
errors	WeatherDataErrors	Modello per gli errori rilevati per tutte le posizioni non riuscite.
locations	WeatherLocationData[]	Elenco dei dati meteo per tutte le località meteo.
status	Status	Indica una risposta riuscita, non riuscita o ParzialmenteSucceed.
weatherMetadata	WeatherMetadata	Schema dei metadati meteo.

WeatherLocation

Schema dei dati di posizione.

Nome	Tipo	Descrizione
type	LocationType	Tipo di posizione, ad esempio. LatLong/IataCode/IcaoCode/Placeid/PostalKey.
value	string	Valore posizione, ad esempio. "10,-25" per tipo LocationType "LatLong".

WeatherLocationData

Schema dei dati WeatherLocationData.

Nome	Tipo	Descrizione
data	WeatherDataForPassthrough	Schema dei dati meteo.
lastRefreshedDateTime	string	Data-ora in cui è stata richiesta l'ultima risorsa, formato di esempio: aaaa-MM-ddTHH:mm:ssZ.
location	WeatherLocation	Schema dei dati di posizione.
requestCompletionTime	string	Tempo di completamento della richiesta in utc della posizione.

WeatherMetadata

Schema dei metadati meteo.

Nome	Tipo	Descrizione
additionalParams	AdditionalProviderParameters	Schema di parametri aggiuntivi per la richiesta del provider di dati meteo.
duration	integer	Specifica il numero di giorni in cui vengono restituite le risposte di previsione giornaliere. I valori disponibili sono 1, 5, 10, 25 e 45. (applicabile solo per l'estensione Mappe meteo di Azure).
endTimeHours	integer	Intervallo di tempo finale. (applicabile solo per DTN. Estensione ClearAg.
extensionApiName	string	Nome dell'api di estensione a cui effettuare la richiesta.
extensionId	string	ID dell'estensione da usare per il providerInput. Ad esempio: DTN. ClearAg.
extensionVersion	string	Versione dell'estensione dati meteo.
language	string	Lingua (tag di lingua IETF BCP 47) in cui i risultati della ricerca devono essere restituiti dal provider di dati. Esempi: 'en-US', 'es', 'es-MX', 'fr-FR'.
startTimeHours	integer	Inizio dell'intervallo di tempo. L'ora 0 rappresenta l'ora corrente. (applicabile solo per DTN. Estensione ClearAg.
units	string	Unità per cui deve essere inviata la richiesta al provider di dati. I valori supportati sono 'e' per le unità inglesi, 'm' per le unità metriche, 'h' per unità ibride (UK) e 's' per le unità METRICA SI.
weatherDataType	string	Tipo di dati meteo (previsione/cronologia).

Condividi tramite

Weather Data - Get

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

Authorization

Esempio

WeatherData_Get

Esempio di richiesta

Risposta di esempio

Definizioni

AdditionalProviderParameters

ApiKeyAuthCredentials

AuthCredentialsKind

Error

ErrorForLocation

ErrorResponse

InnerError

KeyVaultProperties

LocationType

Measures

Status

WeatherDataErrors

WeatherDataForPassthrough

WeatherDataProviderRequest

WeatherDataProviderResponse

WeatherLocation

WeatherLocationData

WeatherMetadata

Risorse aggiuntive