API возвращаемые значения
Текущие коды состояния, возвращаемые API (http_status_code), могут быть 200
и 400
.
Возврат 400
Если API возвращает 400, это означает, что параметры запроса не прошли проверку. В этом случае есть два формата возврата.
- Конкретные ошибки параметров, в основном ошибки проверки параметров.
{
"energy_amount": ["Пожалуйста, убедитесь, что значение больше или равно 10000."],
"period": ["'1X' не является допустимым значением."]
}
TIP
- Будет перечислена причина ошибки для каждого поля. Список причин является массивом, так что возможно наличие нескольких причин!
- Нет конкретных ошибок параметров, в основном проверка параметров прошла успешно, но возникли другие ошибки.
{"detail": "API not found"}
TIP
- Ключ фиксирован как detail, и результат возврата является строкой. Если при разработке необходимо отобразить конкретную ошибку, сначала нужно определить, является ли это ошибкой типа detail, затем определить, есть ли ошибка параметра.
Возврат 200
Когда API возвращает 200, формат возврата фиксирован:
{
"errno": 1,
"message": "XXXX",
"param1": "value1",
...
}
- errno может быть 1 или 0. Когда
errno=0
, это означает, что запрос выполнен успешно. Когдаerrno=1
, это означает, что в запросе возникла проблема, и в этом случае параметрmessage
укажет причину. - В некоторых запросах могут быть другие возвращаемые параметры, подробности см. в описании соответствующего API.