Weather POST GET
Возвращает информацию о погоде.
Запросы следует отправлять на адрес:
Поддерживаются запросы методом GET и POST.
По умолчанию ответ сервера будет в формате JSON.
Для получения ответа в другом формате, можно добавить расширение к файлу в адресе:
.xml, .html или .txt.
Например: /v2/Weather.xml
Либо использовать HTTP-заголовок Accept: text/xml, text/html или text/plain.
Параметры
| Имя параметра | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
| loc | String | Условно | Current | Название населенного пункта, либо IP-адрес. |
| days | Int32 | Нет | 1 | Количество дней, на которое следует получить прогноз погоды. Допустимо значение не более 7 дней. |
| date | String | Нет | Today | Дата, от которой следует получить прогноз погоды. |
Общие параметры
В таблице ниже представлен список параметров, которые могут быть использованы при запросе к любому методу API.
| Имя параметра | Тип | Обязательный | По умолчанию | Описание |
|---|---|---|---|---|
| appId | Int32 | Нет | NULL | Идентификатор приложения. |
| appSecret | String | Условно | NULL | Секретный ключ приложения. |
| token | String | Нет | NULL | Маркер доступа клиента, полученный методом GetToken. |
| formatting | ResponseFormatting | Нет | None | Определяет параметры форматирования выдачи результатов. |
| details | Boolean | Нет | False | Позволяет отобразить дополнительную информацию о запросе. |
| cp | String | Нет | UTF-8 | Имя кодовой страницы. |
| lang | Language | Нет | Auto | Язык, на котором будут выдаваться системные сообщения. Этот параметр также можно использовать при работе со справочной информацией API. |
| auth | Boolean | Нет | False | При наличии этого параметра, сервер вернет ответ с кодом HTTP401 и потребует указание идентификатора приложения и секретного ключа в HTTP заголовке Authorization. |
Результат
Возвращает результат типа WeatherResult.
| Имя свойства | Тип | Описание | ||
|---|---|---|---|---|
| Исходное | XML | JSON | ||
| Location | location | location | WeatherLocation | Содержит информацию об обнаруженном местерасположения. |
| Items | items | items | WeatherResultItem[] | Список информации о погоде. |
| Messages | messages | messages | Message[] | Список сообщений системы. |
| Trace | trace | trace | TraceItem[] | Детальная информация о выполнении запроса. Добавляется, если параметр details имеет значение True. |
Имя XML и JSON используется при выдаче результатов в XML и, соответственно, JSON.
Если имя XML начинается с символа «собака» (@), то значит в XML это имя будет использоваться в качестве имени атрибута, а не самостоятельного элемента.
Исходное имя - это имя, которое используется непосредственно в коде API.
Ошибки
При возникновении ошибок, будет возвращаен результат типа ErrorResult.
В таблице ниже представлен список ошибок, которые могут возникнуть при работе с методом Weather.
| Ключ | Код | Описание |
|---|---|---|
| DataNotFound | 3101 | Ошибка возникает, когда данные не были найдены. |
Ключ и код соответствуют элементам перчисления ErrorCode.
В некоторых случаях, в ответе сервера могут содержать предупреждения (Warning) и сообщения о проблемах (Critical), которые можно найти в коллекции Messages.
При этом, ответ сервера будет иметь тип WeatherResult.
Если метод содержит сообщения типа Critical, то можно считать, что работа метода завершена с ошибкой.
Подобное поведение свойствено методам, в которых производится обработка списка данных, где каждый элемент списка является независимым от других элментов.
Т.е. в таких случаях запрос может быть выполнен частично.