ListAvailableDistrictsController class

Введение

  1. Описание: Контроллер ListAvailableDistrictsController предоставляет конечную точку API для получения доступных районов на основе кода страны.
  2. Маршруты: Обрабатывается GET-запрос по маршруту /listAvailableDistricts/{countryCode?}. Если код страны не указан, по умолчанию используются все страны из списка [CO, CL, PE].

Формат запроса

Параметры запроса:

  1. countryCode (необязательный) - код страны в формате ISO 3166-1 alpha-2.

Валидация и преобразование данных

  1. Код страны преобразуется в верхний регистр.

Основная логика

  1. Получение списка районов для указанной страны.

Взаимодействие с микросервисами

  1. Hasura: Получение списка активных районов.
  2. Гео-сервис: Получение списка районов.
## Ответы сервера
  1. Успешное обновление заказа: Возвращается статус 200 OK
      {
        "availableDistricts": [
          {
            "id": "CL_150",
            "name": "Angol",
            "enabled": true
          }
        ]
      }
      
  2. Ошибки обработки:
    1. Некорректный код страны. Ожидаемый статус - 400 badRequest.
    2. Внутренние ошибки. Ожидаемый статус - 500 internalServerError.
Inheritance
  • Object
  • Controller
  • ListAvailableDistrictsController

Constructors

ListAvailableDistrictsController({required Request request, required String? countryCode})

Properties

countryCode → String?
final
dataLinkRepository → DatalinkRepository
final
endpoint ↔ String
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
request ↔ Request
getter/setter pairoverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

call(Request request) → FutureOr<Response>
inherited
handler() → Future<Response>
Must be implemented
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
requestAsJson() → Future
Reads request value and parse as json
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited