Актуальную версию документа см. на сайте Министерства цифрового развития, связи и массовых коммуникаций Российской Федерации по адресу https://digital.gov.ru/ru/documents/6186/.

Таблица 8 - Параметры ответа на запросы о данных организации

N

URI запрашиваемого ресурса

Описание ресурса

Предоставляемые данные

1.

/orgs/{orgOid}

Данные об организации с идентификатором {orgOid}

Данные об организации:

<shortName> - сокращенное наименование организации;

<fullName> - полное наименование организации;

<type> - тип организации. Для государственных организаций - "AGENCY", для юридических лиц - "LEGAL";

<ogrn> - ОГРН организации;

<inn> - ИНН организации;

<leg> - код организационно-правовой формы по общероссийскому классификатору организационно-правовых форм;

<kpp> - КПП организации;

<agencyTerRange> - территориальная принадлежность ОГВ (только для государственных организаций, код по справочнику "Субъекты Российской Федерации" (ССРФ), для Российской Федерации используется код 00;

<agencyType> - тип ОГВ (только для государственных организаций) <34>;

<staffCount> - количество сотрудников организации;

<branchesCount> - количество филиалов организации (только для ЮЛ и ОГВ).

2.

/orgs/{orgOid}/brhs

Перечень филиалов организации

Перечень филиалов организации (в виде ссылок на ресурс с указанием {branch_id}, содержащий данные о каждом филиале)

3.

/orgs/{orgOid}/brhs/{branch_id}

Сведения о филиале организации

Данные о филиале:

<name> - имя филиала;

<kpp> - КПП филиала;

<leg> - код организационно-правовой формы по общероссийскому классификатору организационно-правовых форм;

<staffCount> - количество сотрудников филиала.

Для просмотра контактных данных и адресов филиала следует воспользоваться ресурсами /orgs/{orgOid}/brhs/{branch_id}/ctts и /orgs/{orgOid}/brhs/{branch_id}/addrs соответственно. Структура этих ресурсов аналогична ресурсам головной организации

4.

/orgs/{orgOid}/ctts

Перечень контактов организации

Перечень контактов организации (в виде ссылок на ресурс с указанием {ctt_id}, содержащий данные о каждом контакте)

5.

/orgs/{orgOid}/ctts/{ctt_id}

Сведения об отдельной записи в перечне контактов организации

Контактные данные:

<type> - тип записи, может иметь значения:

- "OPH" - телефон;

- "OFX" - факс;

- "OEM" - электронная почта.

<vrfStu> - сведения о "подтвержденности" контактов, может иметь значения:

- "NOT_VERIFIED" - не подтвержден;

- "VERIFIED" - подтвержден.

<value> - значение контакта

6.

/orgs/{orgOid}/addrs

Перечень адресов организации

Перечень адресов организации (в виде ссылок на ресурс с указанием {addr_id}, содержащий данные о каждом адресе)

7.

/otg/{orgOid}/addrs/{addr_id}

Сведения об отдельной записи в перечне адресов организации

Контактные данные:

<type> - тип записи, может иметь значения:

- "OLG" - юридический адрес;

- "OPS" - фактический адрес;

<zipCode> - индекс;

<countryId> - идентификатор страны;

<addressStr> - адрес в виде строки (не включая дом, строение, корпус, номер квартиры);

<building> - строение;

<frame> - корпус;

<house> - дом;

<flat> - квартира;

<fiasCode> - код ФИАС;

<region> - регион;

<city> - город;

<district> - внутригородской район;

<area> - район;

<settlement> - поселение;

<additionArea> - доп. территория;

<additionAreaStreet> - улица на доп. территории;

<street> - улица.

8.

/orgs/{orgOid}/vhls

Перечень транспортных средств

Перечень транспортных средств, которыми владеет данная организация

9.

orgs/{orgOid}/vhls ?embed=(vehicles)

Перечень транспортных средств с данными о каждом транспортном средстве

Перечень транспортных средств, которыми владеет данная организация, содержащий информацию о каждом транспортном средстве

orgs/{orgOid}/vhls ?embed=(elements-1)

10.

/orgs/{orgOid}/vhls/{vhl-id}

Транспортное средство организации

<name> - имя автомобиля (например, марка или другое пользовательское описание);

<numberPlate> - государственный регистрационный знак;

<regCertificate> - данные свидетельства о государственной регистрации, включает в себя атрибуты:

- <series> - серия свидетельства;

- <number> - номер свидетельства.

--------------------------------

<34> В настоящее время используются следующие коды:

10.FED - Федеральный орган исполнительной власти

11.REG - Орган исполнительной власти субъекта РФ

12.LCL - Орган местного самоуправления

13.PVD - Подведомственная организация федерального органа исполнительной власти

20.GOV - Государственное учреждение

21.MCL - Муниципальное учреждение

30.FND - Государственный внебюджетный фонд

31.PFN - Подведомственная организация государственного внебюджетного фонда

40.MFC - Многофункциональный центр

41.LEG - Законодательный (представительный) орган государственной власти субъекта Российской Федерации

Пример ответа с кратким наименованием организации (разрывы строки даны для удобства чтения):

{

"stateFacts": ["Identifiable"],

"shortName": "Банк"

}

Пример ответа с контактными данными об адресах организации при использовании возможностей встраивания <35> (разрывы строки даны для удобства чтения):

--------------------------------

<35> Запрос ресурса: /orgs/100000/addrs?embed=(elements)

{

"stateFacts": ["hasSize"],

"elements": [

{

"stateFacts": ["Identifiable"],

"id": 62,

"type": "OLG",

"region": "Москва Город",

"addressStr": "Москва Город, Ангарская улица",

"countryId": "RUS",

"zipCode": "125635",

"street": "Ангарская улица",

"house": "10",

"flat": "96"

}

],

"size": 1

}

Пример ответа на запрос всех транспортных средств организации, полученный с использованием возможностей встраивания <36> (фрагмент, разрывы строк даны для удобства чтения):

--------------------------------

<36> Запрошенный ресурс: /orgs/1000000000/vhls?embed=(vehicles) или /orgs/1000000000/vhls?embed=(elements-1)

{

"stateFacts": ["Paginated"],

"size": 5,

"pageSize": 5,

"pageIndex": 2,

"totalSize": 12,

"eTag": "E6DAE96DADE1CA29F5C50979BBB7C8BF4422FD62",

"elements": [{

"stateFacts": ["Identifiable"],

"id": 6590,

"name": "TOYOTA",

"numberPlate": "А111АА136",

"regCertificate": {"series": "1234","number": "123456"},

"eTag": "F69EEA8910E298E97C8E6249A130A7195DFE7F1A"},

.............

}

Для получения данных о категориях организации система-клиент должна направить в https-адрес REST-API системы ЕСИА запрос методом GET. В запросе должен быть указан ресурс, содержащий необходимые данные. Идентификатор этого ресурса в ЕСИА имеет следующий вид:

/categories/orgs/{orgOid}

- categories - коллекция категорий, имеющихся в ЕСИА;

- orgs - коллекция организаций, имеющихся в ЕСИА;

- orgOid - внутренний идентификатор организации в ЕСИА;

В запрос должен быть добавлен header с маркером доступа, позволяющим получить доступ к данному ресурсу (scope в зависимости от полномочий системы).

Пример запроса (вызов сервиса в среде разработки):

GET categories/orgs/1000364913 HTTP/1.1\r\n

Authorization: Bearer

eyJ2ZXIiOjEsInR5cCI6IkpXVCIsInNidCI6ImFjY2VzcyIsImFsZyI6IkdPU1QzNDEwXzIwMTJfMjU2In0.eyJuYmYiOjE1OTk

1NTQ1MDEsInNjb3BlIjoib3BlbmlkIGNhdGVnb3JpZXM_b2lkPTEwMDAzNjQ5MTMiLCJpc3MiOiJodHRwOlwvXC9lc2lhLmdvc3

VzbHVnaS5ydVwvIiwidXJuOmVzaWE6c2lkIjoiMWQ0OWQ5ZGMzY2FiZThhMjJjNDRhODdlODMyNzMzMDRlOWI1YjE1ODJkNTlkN

2E2N2VhZGJjODg5OWM5MjBjZSIsInVybjplc2lhOnNial9pZCI6MTAwMDM2NjU4NywiZXhwIjoxNTk5NTU4MTAxLCJpYXQiOjE1

OTk1NTQ1MDEsImNsaWVudF9pZCI6IlJBX1RPT0wifQ.eBzsv8_x6DG5kP-

D1Jx2ODUkYJlC71m6aCOum7Q6ufrnu110JrBs9HF1_iO_2GovSnfHH8VZ2U4RkF8wGR3_nA\r\n

Host: esia-portal1.test.gosuslugi.ru\r\n

Accept: */*\r\n

\r\n

Данные, которые ЕСИА возвращает в ответ на запрос, представлены в таблице 9.