{"openapi":"3.0.2","info":{"title":"Weather API v1","version":"1.0.0","description":"The HERE Weather API is a RESTful API that:\n\n- provides weather forecasts and reports on current weather conditions.\n- provides information on severe weather alerts along a specified route or a single car location.\n- provides weather radar images in an area.\n\nExamples of information that may be available in weather reports include:\n\n- Descriptions of the overall weather, temperature, precipitation, and wind in supported languages.\n- Numerical data on temperature, humidity, dew point, precipitation, wind and visibility.\n- Forecast alerts, severe warnings and watches for supported NWS alert types and for supported global alert types.\n- Icon name and link for the report.\n\nA weather report typically contains at least the temperature, comfort level, wind speed and direction, and a description, but there can be variation in the responses. The HERE Destination Weather API provides solutions for the following high-level use cases:\n\n- Get current weather reports or weather forecasts for a specific location.\n- Check for severe weather alerts at a specific location.\n- Check when the sun and moon rise and set at a specific location.\n\nWeather data is intended to be used by connected in-vehicle infotainment systems to provide weather information to drivers.\n\nNOTE: Accessing Weather Radar and Weather Alerts required Weather Premium product permissions.\n"},"security":[{"Bearer":[]}],"tags":[{"name":"Weather Report","description":"Destination weather report."},{"name":"Weather Radar","description":"Dopler radar images."},{"name":"Weather Alerts","description":"Weather alerts."},{"name":"API Information","description":"API Information."}],"paths":{"/weather/1.0/report":{"get":{"tags":["Weather Report"],"summary":"Weather report","description":"Retrieves weather reports, weather forecasts, severe weather alerts.","operationId":"Weather API v1 weatherReport","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"name":"app_id","in":"query","description":"Client application Id (for authentication)).","schema":{"type":"string"}},{"name":"app_code","in":"query","description":"Client application Code (for authentication)).","schema":{"type":"string"}},{"name":"product","in":"query","description":"A parameter identifying the type of report to obtain.","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/WeatherProduct"}}},{"name":"name","in":"query","description":"Name of a city. If there is more than one match for the name, then the most populous location is in the response. Country, state and street name can be added to this parameter. Latitude and longitude, name or zipcode must be present.","schema":{"type":"string"}},{"name":"zipCode","in":"query","description":"ZIP code of the location. This parameter is supported only for locations in the United States of America. Latitude and longitude, name or zipcode must be present.","schema":{"type":"string"}},{"name":"latitude","in":"query","description":"Geographical coordinates in WGS-84-compliant format, specifying the area covered by the weather report. Latitude and longitude, name or zipcode must be present.","schema":{"type":"number","format":"double"}},{"name":"longitude","in":"query","description":"Geographical coordinates in WGS-84-compliant format, specifying the area covered by the weather report. Latitude and longitude, name or zipcode must be present.","schema":{"type":"number","format":"double"}},{"name":"metric","in":"query","description":"Boolean, defines whether metric or imperial units are used in the response. If set to false, the response contains imperial units (feet, inch, Fahrenheit, miles). The default is `true`.","required":false,"schema":{"type":"boolean","default":true}},{"name":"oneobservation","in":"query","description":"Boolean, if set to true, the response only includes the closest location. Only available when the product parameter is set to observation. The default is `false`.","required":false,"schema":{"type":"boolean","default":false}},{"name":"hourlydate","in":"query","description":"Date for which hourly forecasts are to be retrieved. The format is YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"language","in":"query","description":"Defines the language used in the descriptions in the response. For example, the response for a query with language=de has descriptions in German. The default is `en-US`.\nList of supported languages:\n\n|Language|Code|\n|---|---|\n|afrikaans|af-ZA|\n|albanian|sq|\n|amharic|am-ET|\n|arabic|ar|\n|armenian|hy|\n|assamese|as-IN|\n|azerbaijani|az-AZ|\n|basque|eu|\n|belarusian|be|\n|bengali-bd|bn-BD|\n|bengali|bn|\n|bosnian|bs-BA|\n|bulgarian|bg-BG|\n|catalan|ca|\n|chinese_prc|zh-CN|\n|chinese_hk|zh-HK|\n|chinese_tw|zh-TW|\n|croatian|hr-HR|\n|czech|cs-CZ|\n|danish|da-DK|\n|dutch|nl-NL|\n|english|en|\n|english_us|en-US|\n|estonian|et-EE|\n|finnish|fi-FI|\n|french_ca|fr-CA|\n|french|fr|\n|galician|gl|\n|georgian|ka-GE|\n|german|de|\n|greek|el-GR|\n|gujarati|gu-IN|\n|hausa|ha|\n|hebrew|he-IL|\n|hindi|hi-IN|\n|hungarian|hu-HU|\n|icelandic|is-IS|\n|igbo|ig-NG|\n|indonesian|id-ID|\n|italian|it|\n|japanese|ja-JP|\n|kannada|kn-IN|\n|kashmiri|ks-IN|\n|kazakh|kk-KZ|\n|khmer|km-KH|\n|kirghiz|ky-KG|\n|korean|ko-KR|\n|lao|lo-LA|\n|latvian|lv-LV|\n|lingala|ln|\n|lithuanian|lt-LT|\n|macedonian|mk-MK|\n|malagasy|mg-MG|\n|malay|ms-MY|\n|malayalam|ml-IN|\n|marathi|mr-IN|\n|mongolian|mn-MN|\n|norwegian|no-NO|\n|oriya|or-IN|\n|persian-af|fa-AF|\n|farsi|fa|\n|polish|pl-PL|\n|portuguese_br|pt-BR|\n|portuguese|pt-PT|\n|punjabi|pa|\n|pushto|ps|\n|romanian|ro-RO|\n|russian|ru-RU|\n|serbian|sr-YU|\n|sesotho|st|\n|sinhala|si-LK|\n|slovak|sk-SK|\n|slovene|sl-SI|\n|spanish|es-ES|\n|spanish_am|es-US|\n|swahili|sw|\n|swedish|sv|\n|tagalog|tl-PH|\n|tamil|ta|\n|telugu|\"te-IN\t\"|\n|thai|th-TH|\n|tajik|tg-TJ|\n|turkish|tr-TR|\n|turkmen|tk|\n|turkmen_latin|tk|\n|ukrainian|uk-UA|\n|urdu|ur|\n|uzbek|uz-UZ|\n|vietnamese|vi-VN|\n|xhosa|xh|\n|yoruba|yo|\n|zulu|zu|\n","required":false,"schema":{"type":"string","default":"en-US"}},{"name":"politicalView","in":"query","description":"Specify the political view. Available territories will be seen through the point of view of this country. If this parameter is not specified the neutral international view is made available, where territories may have unresolved claims. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political view is `CHN`. Any political view that is unsupported, falls back to the default view. For example, politicalView=USA or politicalView=FRA does not impact a response in any way.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherReport"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WeatherReport"}}}},"400":{"$ref":"#/components/responses/Error400ReportResponse"},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"429":{"$ref":"#/components/responses/Error429Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}},"/weather/2.0/tile/{zoom}/{x}/{y}/{imageType}":{"get":{"tags":["Weather Radar"],"summary":"Weather radar image","description":"Retrieves a doppler radar image.","operationId":"Weather API v1 weatherRadarImage","parameters":[{"name":"zoom","in":"path","description":"Zoom level. Value can be in range:\n* for imageTye=1 from 3 to 11, \n* for imageType=2 from 4 to 9\n","required":true,"schema":{"type":"integer","format":"int32","minimum":3,"maximum":11}},{"name":"x","in":"path","description":"x coordinate for the tile, can be any number between 0 and 2^zoom - 1.","required":true,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2047}},{"name":"y","in":"path","description":"y coordinate for the tile, can be any number between 0 and 2^zoom - 1.","required":true,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":2047}},{"name":"imageType","in":"path","description":"ID of the image type. Currently, there are two valid image types identifying the Doppler radar images (1) and Global precipitation images (2). Other image types might be added in future versions of the API.","required":true,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":2}},{"name":"ts","in":"query","description":"The time in ISO 8601 format. By default, current time is being considered. You can specify a time in the past to get archived radar images or future to retrieve precipitation forecasts.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"image/png":{"schema":{"type":"string","format":"binary"}}},"headers":{"X-RADAR-IMAGE":{"description":"Image timestamp. if requested area is not covered. Custom header 'X-RADAR-IMAGE' in the response contains value 'NC'","schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/Error400TileResponse"},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"429":{"$ref":"#/components/responses/Error429Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}},"/weather/2.0/alerts":{"get":{"tags":["Weather Alerts"],"summary":"Weather alerts","description":"Weather alerts around single car location.","operationId":"Weather API v1 weatherAlert","parameters":[{"name":"lat","in":"query","description":"Latitude of car position.","required":true,"schema":{"type":"number","format":"double","minimum":-90,"maximum":90}},{"name":"lon","in":"query","description":"Longitude of car position.","required":true,"schema":{"type":"number","format":"double","minimum":-180,"maximum":180}},{"name":"width","in":"query","description":"Width of circular area around car position in meters. Default 50 000 (app. 31 miles). Minimum value 1000 meters, maximum 100 km.","required":false,"schema":{"type":"integer","format":"int32","minimum":1000,"maximum":100000}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherAlertsResponse"}}}},"400":{"$ref":"#/components/responses/Error400AlertsResponse"},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"429":{"$ref":"#/components/responses/Error429Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}},"post":{"tags":["Weather Alerts"],"summary":"Weather alerts","description":"Weather alerts along the route.","operationId":"Weather API v1 weatherRouteAlert","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherAlertsResponse"}}}},"400":{"$ref":"#/components/responses/Error400AlertsResponse"},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"429":{"$ref":"#/components/responses/Error429Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}},"/isalive":{"get":{"tags":["API Information"],"summary":"Weather service is alive check","description":"Weather service is working properly.","operationId":"Weather API v1 weatherIsAlive","responses":{"200":{"description":"Service is live, all components works."},"500":{"description":"Internal server error."},"503":{"description":"Service is not working."}}}},"/version":{"get":{"tags":["API Information"],"summary":"Weather service version","description":"Weather service version.","operationId":"Weather API v1 weatherVersion","responses":{"200":{"description":"Service version."},"500":{"$ref":"#/components/responses/Error500Response"},"503":{"$ref":"#/components/responses/Error503Response"}}}}},"servers":[{"url":"https://weather.cc.api.here.com","description":"Production environment URL."}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request.\n\nFor more information on how to get a bearer token, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html.\n"}},"schemas":{"Route":{"type":"object","required":["route"],"properties":{"route":{"type":"string","example":"52.5160,13.3771;52.5111,13.3712;52.5355,13.3634","description":"List of route coordinates {latitude,longitude} separated by semicolon. At least two points are expected. maximum number of points is 1000."},"width":{"type":"integer","format":"int32","example":2000,"minimum":1000,"maximum":25000}},"description":"Weather alerts along the route."},"WeatherReport":{"description":"Weather report.","type":"object","properties":{"observations":{"properties":{"location":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/LocationMetadata"},{"type":"object"}],"properties":{"observation":{"type":"array","items":{"$ref":"#/components/schemas/WeatherItem"}}}}}},"description":"Actual weather conditions."},"forecasts":{"properties":{"forecastLocation":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/LocationMetadata"},{"type":"object"}],"properties":{"forecast":{"type":"array","items":{"$ref":"#/components/schemas/WeatherItem"}}}}}},"description":"Weather seven days detailed forecasts,\nmorning, afternoon, evening and night weather forecasts for the next seven days.\n"},"dailyForecasts":{"properties":{"forecastLocation":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/LocationMetadata"},{"type":"object"}],"properties":{"forecast":{"type":"array","items":{"$ref":"#/components/schemas/WeatherItem"}}}}}},"description":"Daily weather forecasts for the next seven days."},"hourlyForecasts":{"properties":{"forecastLocation":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/LocationMetadata"},{"type":"object"}],"properties":{"forecast":{"type":"array","items":{"$ref":"#/components/schemas/WeatherItem"}}}}}},"description":"Hourly weather forecasts for the next seven days."},"alerts":{"properties":{"forecastLocation":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/LocationMetadata"},{"type":"object"}],"properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AlertItem"}}}}}},"description":"Forecasted weather alerts for the next 24 hours."},"nwsAlerts":{"allOf":[{"$ref":"#/components/schemas/NWSAlertsType"}],"description":"All active watches and warnings for the US and Canada issued by National Weather Service."},"feedCreation":{"type":"string","format":"date-time","example":"2020-08-28T11:23:53.104Z"},"metric":{"type":"boolean","example":true}}},"WeatherAlertsResponse":{"description":"Weather alerts response - GeoJSON FeatureCollection.","type":"object","required":["type","features"],"properties":{"type":{"type":"string","enum":["FeatureCollection"]},"features":{"type":"array","items":{"$ref":"#/components/schemas/Feature"}}}},"Feature":{"description":"GeoJSON Feature","type":"object","properties":{"type":{"type":"string","enum":["Feature"]},"properties":{"$ref":"#/components/schemas/Warnings"},"geometry":{"type":"object","oneOf":[{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPolygon"}]},"id":{"type":"string","example":"wa-1234","description":"Unique weather alert id."}}},"Warnings":{"description":"Warnings","type":"object","properties":{"warnings":{"items":{"$ref":"#/components/schemas/Warning"}}}},"Warning":{"description":"Warning details.","type":"object","properties":{"severity":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5],"example":2,"description":"The severity of the event. One of:\n- 0 Event doesn't have significance by nature.\n- 1 There are no alerts for the location.\n- 2 Minor Severity, the event is potentially dangerous but not usual.\n- 3 Medium Severity, the event is dangerous.\n- 4 High Severity, The event is very dangerous.\n- 5 Emergency. Take immediate action to protect life.\n"},"type":{"type":"integer","format":"int32","example":3,"description":"Event type\n|Event Type|Description|\n|---|---|\n|1|Extremely high temperature.|\n|2|Extremely low temperature.|\n|3|Fog|\n|4|Ice or freezing rain.|\n|5|Rain|\n|6|Snow|\n|7|Thunderstorm|\n|8|Wind|\n|9|Air quality.|\n|10|Volcanic ashfall.|\n|11|Avalanche|\n|12|Tsunami|\n|13|Dust storm or sandstorm.|\n|14|Earthquake|\n|15|Fire danger.|\n|16|Flood|\n|17|High waves.|\n|18|High UV index.|\n|19|Low water.|\n|20|Smoke or smog.|\n|21|Volcano|\n|22|Ice in waterway.|\n|23|Coastal event.|\n|24|Civil danger.|\n|25|Evacuation|\n|26|Hazardous materials.|\n|27|Radiological hazard.|\n|28|Shelter in place.|\n|29|Warning|\n"},"country":{"type":"string","example":"JP","description":"ISO-3166-1 2-letter country code."},"startTime":{"type":"integer","format":"int32","example":1598510460,"description":"Start time of the event in UNIX time."},"endTime":{"type":"integer","format":"int32","example":1598536800,"description":"End time of the event in UNIX time. \nIf not present, warning is valid until it is not removed from the feed by national weather institutes (valid until warning is present in the response).\n"},"messages":{"description":"An array of localized textual descriptions of the event.","type":"array","items":{"$ref":"#/components/schemas/Message"}}}},"Message":{"description":"Warning message.","type":"object","properties":{"lang":{"type":"string","example":"en-AU","description":"Language code."},"text":{"type":"string","example":"Minor Flood Warning","description":"Human readable weather warning description."}}},"Polygon":{"description":"GeoJSON Polygon.","required":["type","coordinates"],"type":"object","properties":{"type":{"type":"string","enum":["Polygon"],"example":"Polygon"},"coordinates":{"$ref":"#/components/schemas/PolygonCoordinates"}}},"MultiPolygon":{"description":"GeoJSON Polygon.","required":["type","coordinates"],"type":"object","properties":{"type":{"type":"string","enum":["MultiPolygon"],"example":"MultiPolygon"},"coordinates":{"type":"array","items":{"$ref":"#/components/schemas/PolygonCoordinates"}}}},"PolygonCoordinates":{"type":"array","items":{"$ref":"#/components/schemas/LinearRingCoordinates"}},"LinearRingCoordinates":{"type":"array","minItems":4,"items":{"$ref":"#/components/schemas/PointCoordinates"}},"PointCoordinates":{"type":"array","minItems":2,"items":{"type":"number","format":"double"}},"LocationMetadata":{"type":"object","properties":{"country":{"type":"string","example":"United States","xml":{"attribute":true}},"state":{"type":"string","example":"Illinois","xml":{"attribute":true}},"city":{"type":"string","example":"Chicago","xml":{"attribute":true}},"latitude":{"type":"number","format":"double","example":41.85003,"xml":{"attribute":true}},"longitude":{"type":"number","format":"double","example":-87.65005,"xml":{"attribute":true}},"distance":{"type":"number","format":"double","example":11.4,"xml":{"attribute":true}},"elevation":{"type":"number","format":"double","example":125,"xml":{"attribute":true}},"dayOfWeek":{"type":"integer","format":"int32","example":5,"xml":{"attribute":true}},"weekday":{"type":"string","example":"Thursday","xml":{"attribute":true}},"utcTime":{"type":"string","format":"date-time","example":"2020-08-28 00:00:00-05:00","xml":{"attribute":true}},"timezone":{"type":"integer","format":"int32","example":-6,"xml":{"attribute":true}},"localTime":{"type":"string","example":117806091,"xml":{"attribute":true}},"localTimeFormat":{"type":"string","example":"HHMMddyyyy","xml":{"attribute":true}}}},"WeatherProduct":{"type":"string","enum":["observation","forecast_7days","forecast_7days_imple","forecast_hourly","alerts","nws_alerts"]},"WeatherItem":{"allOf":[{"$ref":"#/components/schemas/LocationMetadata"},{"type":"object","properties":{"daylight":{"type":"string","enum":["D","N"],"example":"D","description":"Part of the day (D=day or N=night)."},"daySegment":{"type":"string","enum":["Morning","Afternoon","Evening","Night"],"example":"Morning","description":"Day segment"},"description":{"type":"string","example":"Passing clouds. Mild.","description":"Human-readable weather description."},"skyInfo":{"type":"integer","format":"int32","example":7,"description":"Sky descriptor value.\nIf the element is in the response and it contains a value, there is an Integer in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe available values are as follows: \n\n    1 - Sunny\n    2 - Clear\n    3 - Mostly Sunny\n    4 - Mostly Clear\n    5 - Hazy Sunshine\n    6 - Haze\n    7 - Passing Clouds.\n    8 - More Sun than Clouds\n    9 - Scattered Clouds\n    10 - Partly Cloudy.\n    11 - A Mixture of Sun and Clouds\n    12 - High Level Clouds\n    13 - More Clouds than Sun\n    14 - Partly Sunny\n    15 - Broken Clouds\n    16 - Mostly Cloudy\n    17 - Cloudy\n    18 - Overcast\n    19 - Low Clouds\n    20 - Light Fog\n    21 - Fog\n    22 - Dense Fog\n    23 - Ice Fog\n    24 - Sandstorm\n    25 - Duststorm\n    26 - Increasing Cloudiness\n    27 - Decreasing Cloudiness\n    28 - Clearing Skies\n    29 - Breaks of Sun Later\n    30 - Early Fog Followed by Sunny Skies\n    31 - Afternoon Clouds\n    32 - Morning Clouds\n    33 - Smoke\n    34 - Low Level Haze\n"},"skyDescription":{"type":"string","example":"Passing clouds","description":"Description of sky conditions.\nSee the text descriptions associated with the skyInfo element above.\n"},"temperature":{"type":"number","format":"double","example":24.39,"description":"Temperature in Celsius/Fahrenheit.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value depends on the units parameter value. The default is Celsius.\n"},"temperatureDesc":{"type":"string","example":"Mild","description":"Temperature description.\n\nThe available values are as follows:\n\n    Extremely Cold\n    Frigid\n    Cold\n    Chilly\n    Nippy\n    Cool\n    Refreshing Cool\n    Mild\n    Pleasantly Warm\n    Warm\n    Hot\n    Extremely Hot\n    Breezy\n    Windy\n    Gusty\n    Blustery\n    Very Windy\n    Extremely Windy\n    High Winds\n    Beautiful\n    Very Nice\n    Nice\n    Dreary\n    Smoggy\n    Low Level Pollution\n    Blowing Snow\n    Blowing Spray\n    Dry\n    Comfortable\n    Crisp\n    Raw\n    Damp\n    Humid\n    Muggy\n    Sultry\n    Steamy\n"},"comfort":{"type":"string","example":24.31,"description":"Comfort level in degrees. This value indicates what the temperature feels like, depending on a variety of environmental factors such as wind speed and humidity.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n"},"highTemperature":{"type":"string","example":31.4,"description":"The Highest temperature for the day in Celsius/Fahrenheit.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value. The default is Celsius.\n"},"lowTemperature":{"type":"string","example":24.6,"description":"The lowest temperature for the day in Celsius/Fahrenheit.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value. The default is Celsius.\n"},"humidity":{"type":"string","example":91,"description":"Humidity as a percentage (%)\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n"},"dewPoint":{"type":"number","format":"double","example":22.78,"description":"Dew point in Celsius/Fahrenheit.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value. The default is Celsius.\n"},"precipitation1H":{"type":"number","format":"double","example":1,"description":"Precipitation over 1 hour in cm/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"precipitation3H":{"type":"number","format":"double","example":2,"description":"Precipitation over 3 hour in cm/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"precipitation6H":{"type":"number","format":"double","example":4,"description":"Precipitation over 6 hour in cm/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"precipitation12H":{"type":"number","format":"double","example":5,"description":"Precipitation over 12 hour in cm/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"precipitation24H":{"type":"number","format":"double","example":11,"description":"Precipitation over 24 hour in cm/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"precipitationProbability":{"type":"integer","format":"int32","example":22,"description":"Precipitation probability percentage (%).\n\nIf the element is in the response and it contains a value, there is an Integer in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n"},"precipitationDesc":{"type":"string","example":"Strong thunderstorms","description":"Precipitation description.\n\nThe possible values are:\n\n    Drizzle\n    Sprinkles\n    Scattered Showers\n    A Few Showers\n    Light Showers\n    Passing Showers\n    Light Rain\n    Rain Showers\n    Rain\n    Numerous Showers\n    Showery\n    Heavy Rain\n    Lots of Rain\n    Tons of Rain\n    Flash Floods\n    Widely Scattered TStorms\n    Isolated TStorms\n    A Few TStorms\n    Thundershowers\n    Thunderstorms\n    Strong Thunderstorms\n    Severe Thunderstorms\n    Hail\n    Tornado\n    Tropical Storm\n    Hurricane\n    Light Freezing Rain\n    Light Mixture of Precip\n    Sleet\n    Icy Mix\n    Freezing Rain\n    Mixture of Precip\n    Heavy Mixture of Precip\n    Snow Changing to Rain\n    Snow Changing to an Icy Mix\n    An Icy Mix Changing to Snow\n    An Icy Mix Changing to Rain\n    Rain Changing to Snow\n    Rain Changing to an Icy Mix\n    Scattered Flurries\n    Snow Flurries\n    Light Snow Showers\n    Snow Showers\n    Light Snow\n    Snow\n    Moderate Snow\n    Heavy Snow\n    Snowstorm\n    Blizzard\n    Sprinkles Early\n    Showers Early\n    Light Rain Early\n    Rain Early\n    Heavy Rain Early\n    TStorms Early\n    Flurries Early\n    Snow Showers Early\n    Light Snow Early\n    Snow Early\n    Heavy Snow Early\n    Light Icy Mix Early\n    Icy Mix Early\n    Sprinkles Late\n    Showers Late\n    Light Rain Late\n    Rain Late\n    Heavy Rain Late\n    Isolated TStorms Late\n    Scattered TStorms Late\n    TStorms Late\n    Flurries Late\n    Snow Showers Late\n    Light Snow Late\n    Snow Late\n    Heavy Snow Late\n    Light Icy Mix Late\n    Icy Mix Late\n"},"rainFall":{"type":"number","format":"double","example":11,"description":"Amount of rain in cm/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"snowFall":{"type":"number","format":"double","example":0,"description":"Amount of snow in cm/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the metric parameter value.\n"},"airInfo":{"type":"integer","format":"int32","example":7,"description":"Air description value.\n\nIf the element is in the response and it contains a value, there is an Integer in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe possible values are as follows:\n\n    1 - Extremely Cold\n    2 - Frigid\n    3 - Cold\n    4 - Chilly\n    5 - Nippy\n    6 - Cool\n    7 - Refreshing Cool\n    8 - Mild\n    9 - Pleasantly Warm\n    10 - Warm\n    11 - Hot\n    12 - Extremely Hot\n    13 - Breezy\n    14 - Windy\n    15 - Gusty\n    16 - Blustery\n    17 - Very Windy\n    18 - Extremely Windy\n    19 - High Winds\n    20 - Beautiful\n    21 - Very Nice\n    22 - Nice\n    23 - Dreary\n    24 - Smoggy\n    25 - Low Level Pollution\n    26 - Blowing Snow\n    27 - Blowing Spray\n    28 - Dry\n    29 - Comfortable\n    30 - Crisp\n    31 - Raw\n    32 - Damp\n    33 - Humid\n    34 - Muggy\n    35 - Sultry\n    36 - Steamy\n"},"airDescription":{"type":"string","example":"Refreshing Cool","description":"Air description.\n\nSee the text descriptions associated with the airInfo element above.\n"},"windSpeed":{"type":"number","format":"double","example":14.83,"description":"Wind speed in km/h or mph.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"windDirection":{"type":"number","format":"double","example":200,"description":"Wind direction in degrees.\n\nIf the element is in the response and it contains a value, there is an Integer in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n"},"windDesc":{"type":"string","example":"Northwest","description":"Human readable description of the direction of the wind.\n"},"windDescShort":{"type":"string","example":"NW","description":"Abbreviation of the direction of the wind.\n"},"beaufortScale":{"type":"integer","format":"int32","example":0,"description":"Wind speed on the Beaufort scale.\n\nIf the element is in the response and it contains a value, there is an Integer in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe possible values are:\n\n    0 - Calm\n    1 - Light Air\n    2 - Light Breeze\n    3 - Gentle Breeze\n    4 - Moderate Breeze\n    5 - Fresh Breeze\n    6 - Strong Breeze\n    7 - Near Gale\n    8 - Gale\n    9 - Severe Gale\n    10 - Storm\n    11 - Violent Storm\n    12 - Hurricane\n"},"beaufortDescription":{"type":"string","example":"Calm","description":"Beaufort scale conditions description.\n\nSee the text descriptions associated with the beaufortScale element above.\n"},"uvIndex":{"type":"integer","format":"int32","example":3,"description":"UV Index value.\n\nIf the element is in the response and it contains a value, there is an Integer in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe possible values are:\n\n    0 - Minimal\n    3 - Low\n    5 - Moderate\n    7 - High\n    10 - Extreme\n"},"uvDesc":{"type":"string","example":"Low","description":"UV conditions description.\n\nSee the text descriptions associated with the uvIndex element above.\n"},"barometerPressure":{"type":"number","format":"double","example":1006.1,"description":"Barometric pressure in mbar/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n"},"barometerTrend":{"type":"string","example":"Falling","description":"Description of the trend in the barometric pressure.\n"},"visibility":{"type":"number","format":"double","example":150,"description":"Visibility in km/mi.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"snowCover":{"type":"number","format":"double","example":0,"description":"Amount of snow on the ground in cm/in.\n\nIf the element is in the response and it contains a value, there is a Double in the String. If the element is in the response and it does not contain a value, there is an asterisk (*) in the String.\n\nThe value used depends on the units parameter value.\n"},"icon":{"type":"integer","format":"int32","example":23,"description":"Icon number.\n\nDEPRECATED: We recommend that you use the values in the iconName element.\n"},"iconName":{"type":"string","example":"severe_tstorms","description":"Icon name.\n\nThe possible values are:\n\n    sunny\n    clear\n    mostly_sunny\n    mostly_clear\n    passing_clounds\n    more_sun_than_clouds\n    scattered_clouds\n    partly_cloudy\n    a_mixture_of_sun_and_clouds\n    increasing_cloudiness\n    breaks_of_sun_late\n    afternoon_clouds\n    morning_clouds\n    partly_sunny\n    high_level_clouds\n    decreasing_cloudiness\n    clearing_skies\n    high_clouds\n    rain_early\n    heavy_rain_early\n    strong_thunderstorms\n    severe_thunderstorms\n    thundershowers\n    thunderstorms\n    tstorms_early\n    isolated_tstorms_late\n    scattered_tstorms_late\n    tstorms_late\n    tstorms\n    ice_fog\n    more_clouds_than_sun\n    broken_clouds\n    scattered_showers\n    a_few_showers\n    light_showers\n    passing_showers\n    rain_showers\n    showers\n    widely_scattered_tstorms\n    isolated_tstorms\n    a_few_tstorms\n    scattered_tstorms\n    hazy_sunshine\n    haze\n    smoke\n    low_level_haze\n    early_fog_followed_by_sunny_skies\n    early_fog\n    light_fog\n    fog\n    dense_fog\n    night_haze\n    night_smoke\n    night_low_level_haze\n    night_widely_scattered_tstorms\n    night_isolated_tstorms\n    night_a_few_tstorms\n    night_scattered_tstorms\n    night_tstorms\n    night_clear\n    mostly_cloudy\n    cloudy\n    overcast\n    low_clouds\n    hail\n    sleet\n    light_mixture_of_precip\n    icy_mix\n    mixture_of_precip\n    heavy_mixture_of_precip\n    snow_changing_to_rain\n    snow_changing_to_an_icy_mix\n    an_icy_mix_changing_to_snow\n    an_icy_mix_changing_to_rain\n    rain_changing_to_snow\n    rain_changing_to_an_icy_mix\n    light_icy_mix_early\n    icy_mix_early\n    light_icy_mix_late\n    icy_mix_late\n    snow_rain_mix\n    scattered_flurries\n    snow_flurries\n    light_snow_showers\n    snow_showers\n    light_snow\n    flurries_early\n    snow_showers_early\n    light_snow_early\n    flurries_late\n    snow_showers_late\n    light_snow_late\n    night_decreasing_cloudiness\n    night_clearing_skies\n    night_high_level_clouds\n    night_high_clouds\n    night_scattered_showers\n    night_a_few_showers\n    night_light_showers\n    night_passing_showers\n    night_rain_showers\n    night_sprinkles\n    night_showers\n    night_mostly_clear\n    night_passing_clouds\n    night_scattered_clouds\n    night_partly_cloudy\n    increasing_cloudiness\n    night_afternoon_clouds\n    night_morning_clouds\n    night_broken_clouds\n    night_mostly_cloudy\n    light_freezing_rain\n    freezing_rain\n    heavy_rain\n    lots_of_rain\n    tons_of_rain\n    heavy_rain_early\n    heavy_rain_late\n    flash_floods\n    flood\n    drizzle\n    sprinkles\n    light_rain\n    sprinkles_early\n    light_rain_early\n    sprinkles_late\n    light_rain_late\n    rain\n    numerous_showers\n    showery\n    showers_early\n    rain_early\n    showers_late\n    rain_late\n    snow\n    moderate_snow\n    snow_early\n    snow_late\n    heavy_snow\n    heavy_snow_early\n    heavy_snow_late\n    tornado\n    tropical_storm\n    hurricane\n    sandstorm\n    duststorm\n    snowstorm\n    blizzard\n    cw_no_report_icon\n"},"iconLink":{"type":"string","example":"https://weather.cc.api.here.com/static/weather/icon/6.png","description":"Link to icon resource file.\nNote that an individual icon may be used for more than one of the iconName values given above and image file name may be different from icon field value.\n"},"ageMinutes":{"type":"integer","format":"int32","example":33,"description":"Data age in minutes.\n"},"activeAlerts":{"type":"integer","format":"int32","example":0,"description":"Number of active weather alerts.\n"}}}]},"AlertItem":{"allOf":[{"$ref":"#/components/schemas/LocationMetadata"},{"type":"object","properties":{"timeSegment":{"type":"object","properties":{"segment":{"type":"string","example":"M"},"day_of_Week":{"type":"string","example":5}}},"type":{"type":"integer","format":"int32","example":1},"description":{"type":"string","example":"Strong Thunderstorms Anticipated - Strong thunderstorms anticipated during the next 24 hours"}}}]},"NWSAlertsType":{"type":"object","properties":{"warning":{"type":"array","items":{"$ref":"#/components/schemas/NWSAlertItems"},"description":"Warning issued for location.\n\nThese alerts require immediate notification and are extremely time sensitive. Severe weather warnings are sorted by county ID and should generally only be sent to locations within that particular county. Customer may wish to include warnings from counties within a certain distance threshold such as 25 or 50 kilometers.\n"},"watch":{"type":"array","items":{"$ref":"#/components/schemas/NWSAlertItems"},"description":"Watch issued for location.\n\nIncludes watches, advisories, special weather statements, and marine warnings.\n\nThese alerts cover an extended time frame from several minutes to several hours; immediate activation is not always necessary for these alerts although it is highly recommended. Severe Weather Watches are listed by zone and should be sent to all locations within a reasonable distance of the respective zone.\n"}}},"NWSAlertItems":{"type":"object","oneOf":[{"$ref":"#/components/schemas/CountyType"},{"$ref":"#/components/schemas/ZoneType"},{"$ref":"#/components/schemas/ProvinceType"},{"properties":{"type":{"type":"integer","format":"int32","example":5,"description":"Type of alert.\n\n|ID|Description|\n|---|---|\n|0|Aviation Weather Warning.|\n|1|Civil Emergency Message [1].|\n|2|Coastal Flood Warning, Watch, or Statement.|\n|3|Flash Flood Watch.|\n|4|Flash Flood Statement.|\n|5|Flash Flood Warning [1].|\n|6|Flood Statement.|\n|7|Flood Warning [1].|\n|8|Urban and Small Stream Flood Advisory [1].|\n|9|Hurricane Local Statement [1].|\n|10|Lakeshore Warning or Statement [1].|\n|11|Marine Weather Statement.|\n|12|Non Precipitation Warning, Watch, or Statement.|\n|13|Public Severe Weather Alert [1].|\n|14|Red Flag Warning.|\n|15|River Ice Statement.|\n|16|River Recreation Statement.|\n|17|River Statement.|\n|18|Snow Avalanche Bulletin.|\n|19|Preliminary Notice of Watch Cancellation - Aviation Message.|\n|20|Special Dispersion Statement.|\n|21|Severe Local Storm Watch or Watch Cancellation.|\n|22|SPC Watch Point Information Message.|\n|23|Severe Local Storm Watch and Areal Outline.|\n|24|Marine Subtropical Storm Advisory.|\n|25|Special Marine Warning [1].|\n|26|Storm Strike Probability Bulletin from the TPC.|\n|27|Special Weather Statement [2].|\n|28|Severe Thunderstorm Warning [1].|\n|29|Severe Weather Statement.|\n|30|Tropical Cyclone Advisory.|\n|31|Tropical Cyclone Advisory for Marine and Aviation Interests.|\n|32|Public Tropical Cyclone Advisory.|\n|33|Tropical Cyclone Update.|\n|34|Tornado Warning [1].|\n|35|Tsunami Watch or Warning [1].|\n|36|Volcanic Activity Advisory.|\n|37|Winter Weather Warning, Watch, or Advisory [1].|\n|38|Air Stagnation Advisory.|\n\n[1] Watch and Warning Types are highly recommended for immediate activation.\n\n[2] Watch and Warning description can be more detailed for this type, such as 'Frost advisory in effect'.\n"},"description":{"type":"string","example":"Flash Flood Warning","description":"Short description of alert.\n"},"severity":{"type":"integer","format":"int32","example":3,"description":"The severity of alerts from 1-100 with 1 being the most severe.\n"},"message":{"type":"string","example":"FLASH FLOOD WARNING REMAINS IN EFFECT UNTIL 1115 PM MST THIS EVENING FOR MARICOPA COUNTY","description":"The warning or watch text is a long string of words describing the warning or watch in detail.\n"},"name":{"type":"string","example":"Saint Johns Mission","description":"Location name.\n"},"validFromTimeLocal":{"type":"string","format":"date-time","example":"2020-10-11T03:35:00.000-04:00","description":"Date and time at the location the alert was issued by National Weather Service. The format is either YYYY-MM-DDThh:mm:ss.SSS + the timezone offset, unless the forecast is for a location in the UTC zone, in which the date and time is terminated by a Z.\n"},"validUntilTimeLocal":{"type":"string","format":"date-time","example":"2020-10-12T20:00:00.000-04:00","description":"Alert expiration date and time at the location. The format is either YYYY-MM-DDThh:mm:ss.SSS + the timezone offset, unless the forecast is for a location in the UTC zone, in which the date and time is terminated by a Z.\n"}}}]},"CountyType":{"type":"object","properties":{"county":{"type":"array","items":{"$ref":"#/components/schemas/AlertZoneCountyType"}}}},"ZoneType":{"type":"object","properties":{"zone":{"type":"array","items":{"$ref":"#/components/schemas/AlertZoneCountyType"}}}},"ProvinceType":{"type":"object","properties":{"province":{"type":"array","items":{"$ref":"#/components/schemas/AlertProvinceType"}}}},"AlertZoneCountyType":{"type":"object","properties":{"value":{"type":"string","example":"AZC013","description":"Location code (zone code, county code, province code).\nThe shape file information for zones, counties and provinces can be found here in National Weather Service GIS - AWIPS Shapefile Database (http://www.nws.noaa.gov/geodata/).\n","xml":{"attribute":true}},"country":{"type":"string","example":"US","description":"2-letters ISO country code.","xml":{"attribute":true}},"countryName":{"type":"string","example":"United States","description":"Full country name.","xml":{"attribute":true}},"state":{"type":"string","example":"IL","description":"2-letters US-state abbreviation.","xml":{"attribute":true}},"stateName":{"type":"string","example":"Illinois","description":"Full US-state name.","xml":{"attribute":true}},"name":{"type":"string","example":"Maricopa","description":"Location name.","xml":{"attribute":true}},"latitude":{"type":"number","format":"double","example":41.85003,"description":"Latitude of location polygon centroid in degrees in WGS 84 format.","xml":{"attribute":true}},"longitude":{"type":"number","format":"double","example":-87.65005,"description":"Longitude of location polygon centroid in degrees in WGS 84 format.","xml":{"attribute":true}}}},"AlertProvinceType":{"type":"object","properties":{"value":{"type":"string","example":"AZC013","description":"Location code (zone code, county code, province code).\nThe shape file information for zones, counties and provinces can be found here in National Weather Service GIS - AWIPS Shapefile Database (http://www.nws.noaa.gov/geodata/).\n","xml":{"attribute":true}},"country":{"type":"string","example":"US","description":"2-letters ISO country code.","xml":{"attribute":true}},"countryName":{"type":"string","example":"United States","description":"Full country name.","xml":{"attribute":true}},"province":{"type":"string","example":true,"description":"2-letters province code. Canada only.","xml":{"attribute":true}},"provinceName":{"type":"string","example":"Ontario","description":"Full province name. Canada only.","xml":{"attribute":true}},"name":{"type":"string","example":"Maricopa","description":"Location name.","xml":{"attribute":true}},"latitude":{"type":"number","format":"double","example":41.85003,"description":"Latitude of location polygon centroid in degrees in WGS 84 format.","xml":{"attribute":true}},"longitude":{"type":"number","format":"double","example":-87.65005,"description":"Longitude of location polygon centroid in degrees in WGS 84 format.","xml":{"attribute":true}}}},"Error":{"type":"object","properties":{"Type":{"type":"string","example":"Invalid Request"},"Message":{"type":"array","items":{"type":"string","example":"Request parameter 'product' does not conform with expected data type. Please check the documentation."}}}},"AuthError":{"description":"Error object reported in case of authentication or authorization errors.","type":"object","properties":{"error":{"type":"string","description":"Error message."},"error_description":{"type":"string","description":"Detailed information about the error."}},"example":{"Type":"Unauthorized","Message":"ApiKey invalid. ApiKey not found."}}},"parameters":{"X-Request-Id":{"name":"X-Request-Id","in":"header","description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","schema":{"type":"string"}}},"headers":{"X-Correlation-Id":{"description":"Auto-generated unique identifier to identify this request.","schema":{"type":"string"},"example":"4d173a1e-6f1b-459b-b74f-23686354aaea"},"X-Request-Id":{"description":"User-provided token that can be used to trace a request or a group of requests sent to the service.\n","schema":{"type":"string"}}},"responses":{"Error400ReportResponse":{"description":"Invalid parameters were provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}}},"Error400TileResponse":{"description":"Invalid parameters were provided.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"badRequestExample":{"$ref":"#/components/examples/BadRequestTileExample"}}}}},"Error400AlertsResponse":{"description":"Invalid parameters were provided.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"badRequestRouteExample":{"$ref":"#/components/examples/BadRequestAlertExample"},"badRequestPointExample":{"$ref":"#/components/examples/BadRequestPointAlertExample"}}}}},"Error401Response":{"description":"API response in case of lacking valid authorization credentials.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthError"},"example":{"error":"Unauthorized","error_description":"No credentials found"}}}},"Error403Response":{"description":"API response in case of insufficient credentials for access to the requested resource.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthError"},"example":{"error":"Forbidden","error_description":"These credentials do not authorize access"}}}},"Error404Response":{"description":"API response in case of a resource not being found.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Error429Response":{"description":"API response in case of too many requests","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"Type":"Too many requests","Message":["Request rate limit reached"]}}}},"Error500Response":{"description":"API response in case of internal server error","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/InternalServerErrorExample"}}}}},"Error502Response":{"description":"API response in case of bad gateway","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/502errorResponseExample"}}}}},"Error503Response":{"description":"API response in case of service unavailable","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"Type":"Service not available","Message":["Service is not available"]}}}},"Error504Response":{"description":"API response in case of gateway timeout.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/504errorResponseExample"}}}}}},"examples":{"Sentry401ErrorExample":{"value":{"error":"Unauthorized","error_description":"These credentials do not authorize access"}},"Sentry403ErrorExample":{"value":{"error":"Forbidden","error_description":"These credentials do not authorize access"}},"InternalServerErrorExample":{"value":{"Type":"Internal Server Error","Message":["Service is not available"]}},"BadRequestAlertExample":{"value":{"Type":"Invalid Request","Message":["Request payload JSON is missing."]}},"BadRequestPointAlertExample":{"value":{"Type":"Invalid Request","Message":["Missing parameter: lon"]}},"BadRequestTileExample":{"value":{"Type":"Invalid Request","Message":["LayerId '3' is invalid. Only layer Ids '2,1' are allowed."]}},"502errorResponseExample":{"value":{"Type":"Bad Gateway","Message":["Failure of communication with external system."]}},"504errorResponseExample":{"value":{"Type":"Gateway timeout","Message":["Did not receive a timely response from an upstream server"]}}}}}