Метод «Получить список МЧД»¶
Endpoint: GET {hostname}/ldm-poa-service/api/v1/poas
Метод позволяет получить список машиночитаемых доверенностей.
Более подробное описание метода находится в yaml файле «poa_service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| states | Query | Список состояний МЧД, разделенных запятыми. Возможные значения: CREATED, VALID, INVALID, EXPIRED, REVOKED |
| poaRepresentativePersonSnils | Query | СНИЛС физического лица, получившего полномочия |
| poaRepresentativePersonLogin | Query | Логин физического лица, получившего полномочия |
| legalEntityIds | Query | Идентификаторы юридического лица для поиска юридического лица-доверителя |
| permissionIds | Query | Идентификаторы полномочий |
| poaNumber | Query | Единый регистрационный номер доверенности |
| expired | Query | Признак того, что срок доверенности не истек |
| page | Query | Номер страницы, нумерация начинается с 0. Значение согласно описанию в зависимости от потребностей клиента |
| size | Query | Количество возвращаемых записей для одной страницы. Значение согласно описанию в зависимости от потребностей клиента |
| sort | Query | Параметр сортировки. Значение согласно описанию в зависимости от потребностей клиента |
| fields | Query | Фильтрация возвращаемых данных. Варианты использования фильтрации данных по полю «fields»: · fields=name,description – вернет в ответе только поля «name», «description»; · fields=!name,!description – вернет в ответе все остальные поля но только не поля «name», «description»; · fields= – вернет в ответе все поля и поля по вложенным объектам; · fields= – вернет в ответе значения примитивных полей и пустые поля-объекты родительского объекта; · fields=s. – вернет в ответе поля родительского объекта, оканчивающиеся на «'s'» и все поля их вложенных объектов; · fields=name,properties,properties.id – вернет поле «name» основного объекта и поле «id» у вложенного объекта «properties»; · fields=name,properties.**,!properties.name – вернет «name», и все поля вложенного объекта «properties» за исключением поля «properties.name» |
Пример запроса:
curl --location 'https://docshouse-dev.k8s.lan.lanit.ru/dh-gateway-api-service/ldm-poa-service/api/v1/poas?states=CREATED%2CVALID&poaRepresentativePersonSnils=08336732477&poaRepresentativePersonLogin=admin&legalEntityIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&permissionIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&poaNumber=42&expired=true&page=0&size=20&sort=modificationDate%2C%20DESC&fields=fields%3Dkey%2Cdescription' \
-header 'accept: application/json'