weather

2.0info: 1.0.0 weather description: Análise de Dados Climáticos x-senior-domain: Agro x-senior-domain-path: agro x-senior-service-path: weather contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /weather/queries/healthcheck: post: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/listStates: post: description: Retorna os estados disponíveis para seleção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: região searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/listRegions: post: description: Retorna as regiões disponíveis para seleção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das regiões disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as regiões disponíveis para seleção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchTerm description: valor a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das regiões disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/listWeatherStations: post: description: Retorna as estações meteorológicas disponíveis para seleção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das estações meteorológicas disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/listInitialPeriod: post: description: Retorna a data inicial disponível para seleção conforme a estação meteorológica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – region properties: region: type: array items: type: string minimum: 1 description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Período inicial totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/listFinalPeriod: post: description: Retorna a data final disponível para seleção conforme a estação meteorológica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – region properties: region: type: array items: type: string minimum: 1 description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Período final totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/showWeatherStationDetails: post: description: Query para consultar os dados detalhados de uma estação meteorológica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – weatherStation properties: weatherStation: type: array items: type: string minimum: 1 description: Estação meteorológica responses: 200: description: Ok schema: type: object required: – weatherStationDetails properties: weatherStationDetails: type: array items: type: object allOf: – #/definitions/weatherStationDetails minimum: 1 description: Retorno contendo dados detalhados de uma estação meteorológica 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/precipitationData: post: description: Query para consultar os dados de precipitação do dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalyticsData minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/precipitationByStation: post: description: Query para consultar os dados de precipitação por estação metereológica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalyticsMap minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/atmosphericPressure: post: description: Query para consultar os dados de pressão atmosférica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalyticsAP minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/radiation: post: description: Query para consultar os dados de radiação solar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalyticsData minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/temperatures: post: description: Query para consultar os dados de temperaturas e ponto de orvalho tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalyticsTemperatures minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/airTemperatureDryBulb: post: description: Query para consultar os dados da temperatura do ar bulbo seco do dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalyticsData minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/humidity: post: description: Query para consultar os dados da humildade relativa do ar do dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalyticsHumidity minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/winds: post: description: Query para consultar os dados de ventos do dia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: region: type: array items: type: string description: Região state: type: array items: type: string description: Estado weatherStation: type: array items: type: string description: Estação Meteorológica initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/projectionAnalyticsWinds minimum: 1 description: Retorno dos datasets de API, padrão para o analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /weather/actions/clearStructures: post: description: Remove todas as estruturas de dados, menos os tipos explicitamente marcados como false tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: analytics: type: boolean description: Remover analytics default: true page: type: boolean description: Remover páginas default: true landingPage: type: boolean description: Remover landing pages default: true responses: 200: description: Ok schema: type: object required: – analyticsCount – pageCount – landingPageCount properties: analyticsCount: type: integer format: int64 description: Analytics removidos pageCount: type: integer format: int64 description: Páginas removidas landingPageCount: type: integer format: int64 description: Landing pages removidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck weatherStationDetails: description: Dados detalhados de uma estação meteorológica type: object required: – weatherStationDescription – weatherStationCode – weatherStationState – weatherStationRegion – weatherStationLatitude – weatherStationLongitude – weatherStationAltitude – weatherStationFoundationDate properties: weatherStationDescription: type: string description: Nome da estação weatherStationCode: type: string description: Código da estação weatherStationState: type: string description: UF da estação weatherStationRegion: type: string description: Região da estação weatherStationLatitude: type: number format: double description: Latitude da estação weatherStationLongitude: type: number format: double description: Longitude da estação weatherStationAltitude: type: number format: double description: Altitude da estação weatherStationFoundationDate: type: string description: Data de fundação projectionAnalyticsData: description: Retorno dos datasets de API, padrão para o analytics type: object required: – period – data properties: period: type: string description: valores da coluna data: type: number format: double description: valores da série projectionAnalyticsAP: description: Retorno dos datasets de API, padrão para o analytics type: object required: – period – atmosphericPressure – minAtmosphericPressure – maxAtmosphericPressure properties: period: type: string description: Datas de medição atmosphericPressure: type: number format: double description: pressão atmosférica minAtmosphericPressure: type: number format: double description: pressão atmosférica mínima maxAtmosphericPressure: type: number format: double description: pressão atmosférica máxma projectionAnalyticsHumidity: description: Retorno dos datasets de API, padrão para o analytics type: object required: – period – humidity – minHumidity – maxHumidity properties: period: type: string description: Datas de medição humidity: type: number format: double description: humidade relativa minHumidity: type: number format: double description: humidade relativa mínima maxHumidity: type: number format: double description: humidade relativa máxma projectionAnalyticsWinds: description: Retorno dos datasets de API, padrão para o analytics type: object required: – period – direction – maxGust – hourlySpeed properties: period: type: string description: Datas de medição direction: type: number format: double description: direção do vento maxGust: type: number format: double description: Rajada máxima de vento hourlySpeed: type: number format: double description: velocidade horária do vento projectionAnalyticsMap: description: Retorno dos datasets de API, padrão para o analytics type: object required: – station – latitude – longitude – precipitation properties: station: type: string description: Estação metereológica latitude: type: number format: double description: latitude longitude: type: number format: double description: longitude precipitation: type: number format: double description: precipitação projectionAnalyticsTemperatures: description: Retorno dos datasets de API, padrão para o analytics type: object required: – period – maxTemperature – minTemperature – dewPoint – dewPointMax – dewPointMin properties: period: type: string description: Datas de medição maxTemperature: type: number format: double description: Temperatura máxima minTemperature: type: number format: double description: Temperatura mínima dewPoint: type: number format: double description: Ponto de orvalho dewPointMax: type: number format: double description: Ponto de orvalho máximo dewPointMin: type: number format: double description: Ponto de orvalho mínimo defaultDataLookup: description: Retorno padrão para lookup de dados type: object required: – id – description properties: id: type: string description: Id description: type: string description: Descrição notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage