Пропуска портала

GET /api/external/v2/sc/{sc_id}/portal/passes BASIC

Пропуска арендаторов из портала. Доступны на любом тарифе: пределы периода и свежести к ним не применяются. Объём одного ответа ограничивает per_page, а не тариф. Лимиты частоты действуют как у остальных методов.

Номер пропуска — поле id в портале арендаторов.

Параметры#

Имя	Тип	Обяз.	По умолчанию	Описание
`sc_id`	string, в пути	да	—	Идентификатор центра
`start_created_date`	date	условно	—	Начало периода по дате создания пропуска
`end_created_date`	date	условно	—	Конец того же периода
`start_active_date`	date	условно	—	Начало периода по сроку действия пропуска
`end_active_date`	date	условно	—	Конец того же периода
`ticket_uids`	array of string	условно	—	Номера связанных заявок, до 500 за запрос
`statuses`	array of string	нет	—	Фильтр по статусам
`page`	integer	нет	`1`	Номер страницы
`per_page`	integer	нет	`100`	Размер страницы, от 1 до 100

Как задать выборку#

Передаётся не больше одной полной пары периода: created или active. Пара обязательна, кроме выборки по ticket_uids (её можно сочетать с периодом).

created: когда пропуск оформили.
active: пропуска, чей срок действия пересекается с запрошенным периодом — пропуск, оформленный заранее, по дате создания в смену не попадёт.
ticket_uids: пропуска по номерам заявок. UID не из текущего ТЦ игнорируются — в ответ попадают только найденные.

Без statuses[] возвращаются все статусы и архивные записи. Сортировка — от новых пропусков к старым.

Жёсткого лимита длины периода нет. Для стабильного ответа и удобной пагинации лучше брать окно не длиннее трёх месяцев.

Статусы#

pending, approved, rejected, revoked, revoked_by_mall.

Передаются как statuses[]=approved&statuses[]=pending.

Типы пропуска#

person, vehicle.

При pass_type=person заполнен объект person, vehicle равен null. При pass_type=vehicle — наоборот.

Ответ#

Поле	Тип	Описание
`id`	integer	Номер пропуска в портале
`status`	string	Статус из словаря выше
`pass_type`	string	`person` или `vehicle`
`person`	object \| null	Данные человека при `pass_type=person`
`vehicle`	object \| null	Данные ТС при `pass_type=vehicle`
`ticket_uid`	string \| null	Номер связанной заявки
`created_at`	string	Когда создан, ISO 8601 со смещением зоны центра
`valid_from`	string	Начало срока действия, ISO 8601 со смещением зоны центра
`valid_to`	string	Конец срока действия, ISO 8601 со смещением зоны центра
`permanent`	boolean	Устаревшее поле
`work_period`	string	Период работ, как задан в пропуске
`author`	object	Создатель пропуска
`tags`	array	Метки пропуска

Поле permanent осталось для совместимости. У пропусков, созданных раньше, оно ещё может быть в ответе. У новых пропусков ключа нет — не опирайтесь на него в новой логике.

json

{
  "success": true,
  "data": [
    {
      "id": 100500,
      "status": "approved",
      "pass_type": "vehicle",
      "person": null,
      "vehicle": {
        "plate_number": "А123ВС77",
        "brand": "ГАЗ",
        "vehicle_type": "truck_1_5_3t"
      },
      "ticket_uid": "Z-MRM-12345",
      "created_at": "2026-08-27T10:20:00+03:00",
      "valid_from": "2026-08-28T08:00:00+03:00",
      "valid_to": "2026-08-28T20:00:00+03:00",
      "work_period": "day",
      "author": {
        "id": "6aaa506ac3b205791e4bed38",
        "name": "Иван Иванов",
        "email": "author@example.com",
        "mall_staff": false,
        "phone": "+7 999 000-00-00"
      },
      "tags": [
        {
          "id": 1,
          "name": "Разгрузка"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 100,
      "total": 1
    },
    "time_zone": "Europe/Moscow"
  }
}

Связанные заявки — метод Заявки портала, ключ стыковки ticket_uid.

Ошибки#

Код	HTTP	Когда
`portal_unavailable`	503	Не ответил портал арендаторов; запрос можно повторить
`validation_error`	422	Нет пары периода и нет `ticket_uids`, две пары сразу, неполный период, неизвестный статус, больше 500 номеров в `ticket_uids`, `per_page` больше 100