GetStatusByShortCodeController class

Введение

  1. Описание: Контроллер GetStatusByShortCodeController предоставляет конечную точку API для получения статусов заказов по списку shortCode.
  2. Маршруты: Обрабатывается POST-запрос по маршруту /orders/status.

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

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

  [
    "WYJ-127-344",
    "BKJ-105-120"
  ]

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

Валидируется ключ авторизации в переданный в заголовке (headers).

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

  1. Получение списка статусов заказов по shortCode.

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

  1. Hasura: Получение списка заказов.

Ответы сервера

  1. Успешное получение списка заказов: Возвращается статус 200 OK 
      [
    {
      "shortCode": "JCM-591-349"
      "statusName": "CollectedMoney"
      "statusUpdatedAt": "timestamp"
    },
    ...
  ]
  2. Ошибки обработки:
    1. Заказы не найдены. Ожидаемый статус - 404 notFound.
    2. Секрет не найден. Ожидаемый статус - 404 notFound.
    3. Внутренние ошибки. Ожидаемый статус - 500 internalServerError.
Inheritance
  • Object
  • Controller
  • GetStatusByShortCodeController

Constructors

GetStatusByShortCodeController({required Request request, required VendorDatalink vendorDatalink})

Properties

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

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