Возможные ошибки при работе с сервисом API

Описание возможных ошибок, которые могут возникнуть при работе с сервисом API

Вывод информации об ошибках:

  • В запросе отсутствует токен:
    {
        "detail": "Token expected"
    }
  • Несуществующий токен:
    {
        "detail": "Unknown token"
    }
  • Срок действия токена истек:
    {
        "detail": "Token expired"
    }
  • Не хватает прав токена:
    {
        "detail": " Permission denied "
    }
    
  • Попытка обращения к несуществующему списку или записи:
    {
        "detail": "<object> Not Found"
    }
    
  • Ошибка в теле запроса – отсутствующее поле:
    {
                "tag": "required_field_lost",
                "message": "<field> field required",
                "context": {
                   <field>: "Required"
                }
    }
    
  • В одном запросе передается более одной записи на добавление/удаление из списка:
    {
        "detail": "More than one field <user_identifier> specified"
    }
    
  • Ошибка при парсинге сертификата:
    {
        "tag": "parse_error",
        "message": <reason>,
        "context": {
               "cert_text": <cert_text>
        }
    }
    
  • Запись уже была добавлена в список:
    {
        "tag": "value_duplication",
        "message": "The entered value is already in the list",
        "context": {
            "user_identifier": <user_identifier>
        }
    }
  • Ошибки создания новой записи на шлюзе:
[
  {
    "context": {
      "field": "some_unknown_field"
    },
    "message": "Unexpected field is added",
    "tag": "unexpected_field"
  }
]
Метки возможных ошибок ("tag"):
  • unexpected_field — неизвестное поле сертификата;
  • cert_error — ошибка чтения файла сертификата;
  • parse_error — ошибка в анализе полей сертификата;
  • value_duplication — попытка добавить в список дубликат записи;
  • required_field_lost — в теле запроса отсутствует одно из обязательных полей.