API Documentation

Города

GET /

Описание: Получение списка городов.

Теги: Города

Параметры: Отсутствуют

Ответ:

• 200 OK:

  [
      {
          "id": 1,
          "iikoId": "e27dec5a-4447-4bcb-a124-0c1795618998",
          "name": "Новокуйбышевск",
          "additionalInfo": null,
          "classifierId": "some-classifier-id",
          "deleted": 0,
          "externalRevision": "some-revision-string",
          "createdAt": "2023-10-26T12:00:00.000Z",
          "updatedAt": "2023-10-26T13:00:00.000Z",
          "slug": "novokuybyshevsk",
          "cityIn": "Новокуйбышевске"
      },
      {
          "id": 2,
          "iikoId": "a85360f2-55a8-47cc-8a79-1eb88a40c4f0",
          "name": "Самара",
          "additionalInfo": null,
           "classifierId": "some-classifier-id",
           "deleted": 0,
          "externalRevision": "some-revision-string",
          "createdAt": "2023-10-26T12:00:00.000Z",
          "updatedAt": "2023-10-26T13:00:00.000Z",
          "slug": "samara",
          "cityIn": "Самаре"
      },
       {
          "id": 3,
          "iikoId": "3f02eb06-e771-434c-ab73-2ec5bbde1265",
          "name": "Тольятти",
          "additionalInfo": null,
           "classifierId": "some-classifier-id",
           "deleted": 0,
          "externalRevision": "some-revision-string",
          "createdAt": "2023-10-26T12:00:00.000Z",
          "updatedAt": "2023-10-26T13:00:00.000Z",
          "slug": "tolyatti",
         "cityIn": "Тольятти"
      }
  ]
  

  Copy to clipboard
  • id: (integer) - ID города
  • iikoId: (string) - ID города в iiko
  • name: (string) - Название города
  • additionalInfo: (string, nullable) - Дополнительная информация
  • classifierId: (string) - ID классификатора
  • deleted: (integer) - Статус удаления (0 - не удален, 1 - удален)
  • externalRevision: (string) - Внешняя ревизия
  • createdAt: (string, date-time) - Дата создания
  • updatedAt: (string, date-time) - Дата обновления
  • slug: (string) - Слаг города (для URL)
  • cityIn: (string) - Название города в предложном падеже
• 4xx или 5xx: Возможные ошибки, связанные с обработкой запроса, например, ошибки базы данных.

    {
        "statusCode": 400,
        "error": "Bad Request",
        "message": "Some error message"
    }

Примечания:

• Возвращает только города с iikoId:
• e27dec5a-4447-4bcb-a124-0c1795618998 - Новокуйбышевск,
• a85360f2-55a8-47cc-8a79-1eb88a40c4f0 - Самара,
• 3f02eb06-e771-434c-ab73-2ec5bbde1265 - Тольятти.
• Города отсортированы в следующем порядке: "Новокуйбышевск", "Самара", "Тольятти".
• К данным каждого города добавлены поля slug и cityIn.